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

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 - addCollection

Create a collection for aggregating objects providing provenience that identifies the provider(s) of metadata and information stored as a part of this collection.

Request URL

Must be an HTTP POST request.


Structure of input:

  • inputXML (required)
    • collection (required)
      • parentCollection (optional) - the externally resolvable identifier (handle) for another Collection that serves as the parent of this collection. NOTE: A collection can be a member of more than one collection, so more than one parent element is allowed.
      • title (required) - User friendly title of the collection.
      • description (required) - Brief description of the purpose of the collection.
      • contacts (optional) - List of contacts for the collection
        • contact (optional) - Name of contact person for the collection.
          • email attribute (optional) - Email of contact person for the collection
      • resourceURL (optional) - URL to a resource that represents the collection as a whole
      • externalIdentifier (optional) - identifier that has meaning to the application that is responsible for the creation of the collection.

InputXML Example

Below is example inputXML for adding a collection to the NDR.

<?xml version="1.0" encoding="UTF-8"?>
    <title>Middle School Portal (MSP2)</title> 
    <description>The MSP2 collection</description>
      <contact email="">Katy Ginger</contact>


Structure of response:

  • handle - the externally resolvable identifier for the Collection. NOTE: All Collection related API calls that manipulate a specific collection expect this handle as a parameter.
  • handleURL - the permanent URL to an XML representation of the Collection in the NDR.

Common Errors

  • permissions do not allow adding a collection

Response Example

Below is an example response for this request.

<?xml version="1.0" encoding="UTF-8"?>
<NSDLDataRepository schemaVersion="1.00.000" 

API Links:

Additional Links Related to This Call:

Personal tools