NDR API Documentation - getCollectionRecord

Return the NDR_Collection record for the requested Collection.

Request URL

http://ndr.nsdlib.org/api/getCollectionRecord/[handle]

where [handle] is 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 collection (returned by addCollection).

Request URL Example

Below is an example of a request URL for requesting the NDR_Collection record for a collection.

http://ndr.nsdlib.org/api/getCollectionRecord/2200/20061212543

Response

Structure of response:

NDR_Collection - the record holding metadata about the requested collection.

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/getCollectionRecord/[handle]</requestURL>
  
  <resultData>
    <record>
      <parentCollection>2200/2010030201T</parentCollection>
      <title>Middle School Portal (MSP2)</title> 
      <description>The MSP2 collection blah blah</description>
      <contacts>
        <contact email="ginger@ucar.edu">Katy Ginger</contact>
      </contacts>
      <resourceURL>http://msteacher2.org</resourceURL>
      <externalIdentifier>NDR-000-000-000-0001</externalIdentifier>
      <cataloguedBy/>
      <annotatedBy/>
    </record>
  <resultData>
</NSDLDataRespository>