From NSDLWiki

Jump to: navigation, search




Create a MetadataProvider object (see ObjectTypes) in the NDR.

Request URL
Must be an HTTP POST request.


  • inputXML (required) - contains information relevant to a specific provision of metadata, such as particular OAI sets to be harvested from an OAI server.
    • Properties
      • setSpec (optional) - must be provided for the NDR's OAI server to expose metadata from this MetadataProvider as an OAI harvestable set. The value must be unique among the NDR's OAI server's setSpecs, and must adhere to the OAI-PMH specification of setSpecs (see the OAI-PMH and its XML schema: To see setSpecs currently in use by the NDR, do a ListSets request of the NDR's OAI server: .
      • setName (optional) - a short, human-readable description of the objects described by this provision of metadata (e.g. a group of resources), to be available when an OAI-PMH ListSets request is made of the NDR's OAI server.
    • Relationships
      • metadataProviderFor (required) - the handle of the Agent object responsible for this MetadataProvider.
      • aggregatedBy (optional) - the handle of the Aggregator object representing a grouping of objects which the provided metadata will describe.
    • Datastreams
      • serviceDescription (required) – contains descriptive information about the MetadataProvider via the following elements:
        • dc:title (required) - a short name for the MetadataProvider (a few words).
        • dc:description (required) - a description of the MetadataProvider.
        • dc:identifier (optional) - a URL appropriate to the MetadataProvider (e.g. the baseURL for an OAI data provider).
        • image (optional) - a brand image to be associated with the MetadataProvider. If a brand image is included, all four fields below must be present.
          • brandURL (optional)- the URL from which the image can be uploaded. This should resolve to just the image itself, not to a page with a link to the image or to a page with the image as well as other information. The image must be of type jpg, gif or png. See
          • title - text to be displayed if a web client doesn't display the image.
          • width - the width of the image, in pixels. Per the guidelines, the image must not be wider than 100 pixels.
          • height - the height of the image, in pixels. Per the guidelines, the image must not be taller than 30 pixels.
        • contacts (optional) - contact information to be associated with this MetadataProvider. While contact information is optional, it's very helpful to us if it is included.
          • contact - Each contact listed must include <name> and <email>, but the <info> element is optional.
            • name - the name of the person, entity or organization.
            • email - email address for the person, entity or organization
            • info - may contain additional information about the contact, such as "OAI administrator," "project lead," "technical", "metadata," etc.
Below is example inputXML for a MetadataProvider object to be added to the NDR. This MetadataProvider object corresponds to the grouping of resources for aggregator object with PID nsdl:666. Note that the command is understood to be "add" (rather than "replace" or "delete") so the inputXML does not require a command as the first child of the <properties>, <relationships> or <data> elements.
<?xml version="1.0" encoding="UTF-8"?>
<inputXML xmlns="" xmlns:xsi="" xsi:schemaLocation="" schemaVersion="1.00.000">
<setName>My Collection</setName>
<serviceDescription xmlns:dc="">
<dc:title>metadataProvider for a particular source</dc:title>
<dc:description>A collection of metadata provided by me</dc:description>
<name>Peter Parker</name>
<name>Mary Jane</name>
<info>content creator</info>

Note that an XML schema for the dc namespace ( will be imported as part of the inputXML schema.

Response Fields

  • handle – the NDR handle for the new MetadataProvider object

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<NSDLDataRepository schemaVersion="1.00.000" xmlns="" xmlns:xsi="" xsi:schemaLocation="">

API Links:

Personal tools