TNS Internal:NDR/API/2.0/specification/getCollectionRecord

From NSDLWiki

Jump to: navigation, search

 NDR Project Documentation   Conceptual Framework   v1.0 NDR-API Index   v2.0 NDR-API Index   Model 

Under Construction
Proposed method for inclusion in NDR/API 2.0.

Please provide feedback and comments in the NSDL Data Repository (NDR) API 2.0 Forum of the NSDL Community Forums.

NDR API Documentation - getCollectionRecord

Return the NDR_Collection record for the requested Collection.

Request URL[handle]
where [handle] is defined in the Arguments section.
May be an HTTP GET or POST request.


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.


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" 
      <title>Middle School Portal (MSP2)</title> 
      <description>The MSP2 collection blah blah</description>
        <contact email="">Katy Ginger</contact>

API Links:

Additional Links Related to This Call:

Personal tools