NDR API Documentation - listAnnotationIdentifiers

List identifying information about annotations controlled by an application optionally limiting to a specified Collection.

Request URL

http://ndr.nsdlib.org/api/listAnnotationIdentifiers/[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 the collection (returned by addCollection) NOTE: If passed in, annotations are limited to those in the specified collection; otherwise, all annotations 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 listing identifying information about annotations.

http://ndr.nsdlib.org/api/listAnnotationIdentifiers/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
each annotation
- header
  - handle - the externally resolvable identifier for the annotation.
  - handleURL - the permanent URL to an XML representation of the annotation in the NDR.
  - externalIdentifier - application specific identifier that can be stored to facilitate retrieval by applications
  - XMLFormat - id of the format of the returned annotation
  - annotatesHandle - the externally resolvable identifier for the object being annotated.
  - annotatesHandleURL- the permanent URL to an XML representation in the NDR of the object being annotated.
  - collectionName - name of the collection that holds this annoation
  - collectionHandle - the externally resolvable identifier for the Collection
  - agentName - name of the agent application responsible for the Collection that holds this annotation
  - 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/listAnnotationIdentifiers/[handle]?pageSize=[pageSize]</requestURL>
  <resumptionToken>http://ndr.nsdlib.org/api/listAnnotationIdentifiers/2200/20061212543?pageSize=2&page=4</resumptionToken>
  <currentPage>3</currentPage>
  <recordsInCurrentPage>2</recordsInCurrentPage>
  <totalNumberOfPages>29</totalNumberOfPages>
  <totalNumberOfRecords>57</totalNumberOfRecords>
  <resultData>
    <header>
      <handle>2200/20061212656</handle>
      <handleURL>http://ndr.nsdlib.org/api/getAnnotation/2200/20061212656</handleURL>
      <externalIdentifier source="NCS">CLC-000-000-000-061</externalIdentifier>
      <XMLFormat>nsdl_anno</XMLFormat>
      <annotatesHandle>2200/2006334290</annotatesHandle>
      <annotatesHandleURL>http://ndr.nsdlib.org/api/getMetadataRecord/2200/2006334290</annotatesHandleURL>
      <collectionName>Concepts Library Collaborative</collectionName>
      <collectionHandle>2200/20061258473</collectionHandle>
      <agentName>NCS</agentName>
      <agentHandle>2200/20061857483</agentHandle>
    </header>
    <header>
      <handle>2200/20061212656</handle>
      <handleURL>http://ndr.nsdlib.org/api/getAnnotation/2200/20061293824</handleURL>
      <externalIdentifier source="NCS">CLC-000-000-000-062</externalIdentifier>
      <XMLFormat>nsdl_anno</XMLFormat>
      <annotatesHandle>2200/2006389336</annotatesHandle>
      <annotatesHandleURL>http://ndr.nsdlib.org/api/getResourceMetadata/2200/2006389336</annotatesHandleURL>
      <collectionName>Concepts Library Collaborative</collectionName>
      <collectionHandle>2200/20061258473</collectionHandle>
      <agentName>NCS</agentName>
      <agentHandle>2200/20061857483</agentHandle>
    </header>
  <resultData>
</NSDLDataRespository>