TNS Internal:NDR/API/2.0/implementationDetails/listAnnotations
From NSDLWiki
< TNS Internal:NDR | API | 2.0 | implementationDetails
Return to NDR/API 2.0 Requests By Object
Contents[hide] |
Under Construction
Proposed method for inclusion in NDR/API 2.0.
NDR API Implementation Details - listAnnotations
List annotations controlled by an application optionally limiting to a specified Collection.
Discussions
Input Discussions
- [handle] (optional) - the externally resolvable identifier of the collection (returned by addCollection)
- [XMLFormatValue] (optional) - id of the format in which the annotations will be returned transforming if necessary (defaults to native format passed in during addAnnotation) NOTE: requires registration of transform in advance
- [pageSizeValue] (optional) - number of records to return at a time. If smaller than that total number of matching records, a resumption token will be provided.
Output Discussions
- SUCCESS
- 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
- annotates - the externally resolvable identifier for 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
- annotationXML - the annotation in the requested format
- annotatedBy - annotations that annotate the annotation
- header
- additional primary elements
- FAILURE
- error message
Processing Discussions
General Discussions
Implementation
Developer: TBA
Basic description of the process...
- TBA
Links
API Links:
- Conceptual Framework (2.0 philosophy)
- APIBasics
- ObjectTypes
- Encoding
- APIRequestsByObject v1.0
- APIRequestsAlphabetical v1.0
- APIRequestsByObject v2.0