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

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.x.

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


NDR API Documentation - listResourceMetadataIdentifiers

List identifying information about resources and related metadata.


Request URL

http://ndr.nsdlib.org/api/listResourceMetadataIdentifiers/[handle]?pageSize=[pageSize]
where [handle] and [pageSize] are defined in the Arguments section.
May be an HTTP GET or POST request.


Arguments

Parameters on Request URL:

  • [handle] (optional) - the externally resolvable identifier of a collection (returned by addCollection). NOTE: If passed in, resources are limited to those in the specified collection; otherwise, all resources are returned.
  • [pageSize] (optional) - number of records to return at a time. If smaller than that total number of matching records, a resumption token will be provided.



Request URL Example

Below is an example of a request URL for resources and related metadata and annotations. 

http://ndr.nsdlib.org/api/listResourceMetadataIdentifiers/2200/20061212543?pageSize=100



Response

Structure of response:

  • additional primary elements
    • resumptionToken - used to get the next page of records NOTE: empty if this is the last page
    • currentPage - page count of the current set of returned records
    • recordsInCurrentPage - count of the number of records returned in this page
    • totalNumberOfPages - number of pages holding all records matching the request
    • totalNumberOfRecords - total number of records matching the request
  • for each resource
    • header
      • resourceURL - URL to the web resource
      • handle - the externally resolvable identifier for the Resource.
      • handleURL - the permanent URL to an XML representation of the resource in the NDR.
      • contentType - mimetype of internally stored content NOTE: Not specified for external content.
    • cataloguedBy
      • for each metadata record
        • header
          • handle - the externally resolvable identifier for the Metadata.
          • handleURL - the permanent URL to an XML representation of the metadata record in the NDR.
          • externalIdentifier - application specific identifier that can be stored to facilitate retrieval by applications
          • XMLFormat - id of the format of the returned metadata
          • collectionName - name of the collection that holds this metadata record
          • collectionHandle - the externally resolvable identifier for the Collection
          • agentName - name of the agent application responsible for the Collection that holds this metadata record
          • agentHandle - the externally resolvable identifier for the Agent


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/listResourceMetadataIdentifiers/[handle]?pageSize=[pageSize]</requestURL>
  <resumptionToken>http://ndr.nsdlib.org/api/listResourceMetadataIdentifiers/2200/20061212543?pageSize=2&page=4</resumptionToken>
  <currentPage>3</currentPage>
  <recordsInCurrentPage>2</recordsInCurrentPage>
  <totalNumberOfPages>29</totalNumberOfPages>
  <totalNumberOfRecords>57</totalNumberOfRecords>
  <resultData>
    <record>
      <header>
        <resourceURL>http://spookystuff.com/</resourceURL>
        <handle>2200/20061643458</handle>
        <handleURL>http://ndr.nsdlib.org/api/getResourceMetadata/2200/20061643458</handleURL>
      </header>
      <cataloguedBy>
        <header>
          <handle>2200/20061212656</handle>
          <handleURL>http://ndr.nsdlib.org/api/getMetadataRecord/2200/20061212656</handleURL>
          <externalIdentifier source="NCS">CLC-000-000-000-061</externalIdentifier>
          <XMLFormat>nsdl_dc</XMLFormat>
          <collectionName>Concepts Library Collaborative</collectionName>
          <collectionHandle>2200/20061258472</collectionHandle>
          <agentName>NCS</agentName>
          <agentHandle>2200/20061857483</agentHandle>
        </header>
        <header>
          <handle>2200/20061293824</handle>
          <handleURL>http://ndr.nsdlib.org/api/getMetadataRecord/2200/20061293824</handleURL>
          <externalIdentifier source="NCS">CLC-000-000-000-062</externalIdentifier>
          <XMLFormat>nsdl_dc</XMLFormat>
          <collectionName>Concepts Library Collaborative</collectionName>
          <collectionHandle>2200/20061258472</collectionHandle>
          <agentName>NCS</agentName>
          <agentHandle>2200/20061857483</agentHandle>
        </header>
      <cataloguedBy>
    </record>
    <record>
      <header>
        <resourceURL>http://mycatstuff.com/</resourceURL>
        <handle>2200/20061698994</handle>
        <handleURL>http://ndr.nsdlib.org/api/getResourceMetadata/2200/20061698994</handleURL>
      </header>
      <cataloguedBy>
        <header>
          <handle>2200/20061299843</handle>
          <handleURL>http://ndr.nsdlib.org/api/getMetadataRecord/2200/20061299843</handleURL>
          <externalIdentifier source="NCS">CLC-000-000-000-054</externalIdentifier>
          <XMLFormat>nsdl_dc</XMLFormat>
          <collectionName>Concepts Library Collaborative</collectionName>
          <collectionHandle>2200/20061258472</collectionHandle>
          <agentName>NCS</agentName>
          <agentHandle>2200/20061857483</agentHandle>
        </header>
        <header>
          <handle>2200/20064334529</handle>
          <handleURL>http://ndr.nsdlib.org/api/getMetadataRecord/2200/20064334529</handleURL>
          <externalIdentifier source="NCS">CLC-000-000-000-055</externalIdentifier>
          <XMLFormat>nsdl_dc</XMLFormat>
          <collectionName>Concepts Library Collaborative</collectionName>
          <collectionHandle>2200/20061258472</collectionHandle>
          <agentName>NCS</agentName>
          <agentHandle>2200/20061857483</agentHandle>
        </header>
      <cataloguedBy>
    </record>
  <resultData>
</NSDLDataRespository>


API Links:


Additional Links Related to This Call:

Retrieved from "../index.php/TNS_Internal:NDR/API/2.0/specification/listResourceMetadataIdentifiers"
Personal tools