TNS Internal:NDR/API/2.0/implementationDetails/modifyAnnotation
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 - modifyAnnotation
Modify an annotation of another object in the NDR.
Discussions
Input Discussions
- handle (annotation) - handle of annotation being modified.
- annotationXML (any format)
- XMLFormat (id of format of XML - requires registration in advance of predefined annotation XML structures, ex. Star Rating XML Schema, Ed Standard XML Schema, etc.)
- annotates (object being annotated) - Collection, Metadata, Resource, Annotation, List
- <optional> external identifier
Output Discussions
SUCCESS
- handle (annotation object)
- handleURL (url to getAnnotation)
FAIL
- returns error if external identifier is not unique
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