NDR API Documentation - findCollections

Find collections that match the given criteria. Return a list of matching collections including metadata and annotations about the collections.

Request URL

http://ndr.nsdlib.org/api/findCollections

Must be an HTTP POST request.

Arguments

Structure of input:

inputXML (required)
- searchCriteria (required) - search criteria (structure TBA)

InputXML Example

Below is example inputXML for finding collections in the NDR.

<?xml version="1.0" encoding="UTF-8"?>
<inputXML 
    xmlns="http://ns.nsdlib.org/ndr/request_v2.00/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://ns.nsdlib.org/ndr/request_v2.00/ http://ns.nsdlib.org/schemas/ndr/request_v2.00.xsd" 
    schemaVersion="1.00.000">
  <searchCriteria>
     ... TBA ...
  </searchCriteria>
</inputXML>

Response

Structure of response:

one <record> for every collection matching the search criteria including metadata and annotations about each 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/findCollections</requestURL>
  
  <resultData>
    <record>
      <parentCollection>2200/2010030201T</parentCollection>
      <title>Beyond Penguins and Polar Bears</title> 
      <description>K-5 resource on arctic and antarctic</description>
      <contacts>
        <contact email="ginger@ucar.edu">Katy Ginger</contact>
      </contacts>
      <resourceURL>http://bppb.nsdl.org</resourceURL>
      <externalIdentifier source="NCS">NDR-000-000-000-0003</externalIdentifier>
    </record>
    <record>
      <parentCollection>2200/2010030201T</parentCollection>
      <title>Middle School Portal (MSP2)</title> 
      <description>The MSP2 collection is ...</description>
      <contacts>
        <contact email="ginger@ucar.edu">Katy Ginger</contact>
      </contacts>
      <resourceURL>http://msteacher2.org</resourceURL>
      <externalIdentifier source="NCS">NDR-000-000-000-0001</externalIdentifier>
    </record>
  <resultData>
</NSDLDataRespository>