NDR API Documentation - getMetadataRecord

Get a metadata record about a resource.

Request URL

http://ndr.nsdlib.org/api/getMetadataRecord/[handle]?XMLFormat=[XMLFormat]

where [handle] and [XMLFormat] are defined in the Arguments section.

May be an HTTP GET or POST request.

Arguments

Parameters on Request URL:

[handle] (required) - the externally resolvable identifier of the metadata record (returned by addMetadataRecord).
[XMLFormatValue] (optional) - id of the format in which the metadata will be returned transforming if necessary (defaults to native format passed in during addMetadataRecord) NOTE: requires registration of transform in advance

Request URL Example

Below is an example of a request URL for getting a metadata record about a resource to the NDR.

http://ndr.nsdlib.org/api/getMetadataRecord/2200/20061212543?XMLFormat=nsdl_dc

Response

Structure of response:

metadata record
- header
  - handle - the externally resolvable identifier for the Metadata.
  - handleURL - the permanent URL to an XML representation of the metadata record in the NDR.
  - externalIdentifier - application specific identifier that can be stored to facilitate retrieval by applications
  - XMLFormat - id of the format of the returned metadata
  - resourceHandle - the externally resolvable identifier for the Resource this metadata describes.
  - resourceURL - URL to the web resource.
  - collectionName - name of the collection that holds this metadata record
  - collectionHandle - the externally resolvable identifier for the Collection
  - agentName - name of the agent application responsible for the Collection that holds this metadata record
  - agentHandle - the externally resolvable identifier for the Agent
- metadataXML - the metadata record in the requested format

Response Example

Below is an example response for this request.

<?xml version="1.0" encoding="UTF-8"?>
<NSDLDataRepository schemaVersion="1.00.000" 
    xmlns="http://ns.nsdlib.org/ndr/response_v2.00/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://ns.nsdlib.org/ndr/response_v2.00/ http://ns.nsdlib.org/schemas/ndr/response_v2.00.xsd">
  <responseTime>2006-04-10T18:07:53Z</responseTime>
  <requestURL>http://ndr.nsdlib.org/api/getMetadataRecord/[handle]?XMLFormat=[XMLFormat]</requestURL>
  
  <resultData>
    <record>
      <header>
        <handle>2200/20061212656</handle>
        <handleURL>http://ndr.nsdl.org/api/getMetadataRecord/2200/20061212656</handleURL>
        <externalIdentifier source="NCS">CLC-000-000-000-061</externalIdentifier>
        <XMLFormat>nsdl_dc</XMLFormat>
        <resourceHandle>2200/2006334290</resourceHandle>
        <resourceURL>http://www.frankenstein.org/autobiography</resourceURL>
        <collectionName>Concepts Library Collaborative</collectionName>
        <collectionHandle>2200/20061258473</collectionHandle>
        <agentName>NCS</agentName>
        <agentHandle>2200/20061857483</agentHandle>
      </header>
      <metadataXML>
        <nsdl_dc:nsdl_dc 
            xmlns:nsdl_dc="http://ns.nsdl.org/nsdl_dc_v1.02/" 
            schemaVersion="1.02.000" 
            xmlns:dc="http://purl.org/dc/elements/1.1/" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xsi:schemaLocation="http://ns.nsdl.org/nsdl_dc_v1.02/ http://ns.nsdl.org/schemas/nsdl_dc/nsdl_dc_v1.02.xsd"> 
          <dc:title>My life: a Monster's Story.</nowiki></dc:title> 
          <dc:description>The story of Frankenstein, blah blah blah.</dc:description> 
          <dc:identifier>http://www.frankenstein.org/autobiography</dc:identifier> 
          <dc:creator>Baron Von Frankenstein</dc:creator> 
          <dc:author>Mary Shelly</dc:author> 
        </nsdl_dc:nsdl_dc>   
      </metadataXML>
    </record>
  <resultData>
</NSDLDataRespository>