TNS Internal:NDR/API/2.0/implementationDetails/getAnnotation

From NSDLWiki

Jump to: navigation, search

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

Get an annotation of another object.


Discussions

Input Discussions

  • handle (annotation) - handle to the annotation to retrieve

Output Discussions

  • SUCCESS
    • annotation record
      • 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 (required) - the externally resolvable identifier (handle) of the object being annotated
        • collectionName - name of the collection that holds this annotation
        • 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
  • FAILURE
    • error message


Processing Discussions

General Discussions

Implementation

Developer: TBA

Basic description of the process...

  • TBA


Links

API Links:

Additional Links Related to This Call:

Retrieved from "../index.php/TNS_Internal:NDR/API/2.0/implementationDetails/getAnnotation"
Personal tools