NDR API Documentation - addAnnotation

Create an annotation of another object in the NDR.

Request URL

http://ndr.nsdlib.org/api/addAnnotation

Must be an HTTP POST request.

Arguments

Structure of input:

inputXML (required)
- collection (required) - the externally resolvable identifier (handle) of the collection holding the annotation (returned by addCollection).
- annotationXML (required) - annotation in the format specified by the XMLFormat parameter
- XMLFormat (required) - id of the format of annotationXML NOTE: requires registration in advance
- annotates (required) - the externally resolvable identifier (handle) of the object being annotated
- externalIdentifier (optional) - application specific identifier that can be stored to facilitate retrieval by applications

InputXML Example

Below is example inputXML for adding a metadata record about a resource to the NDR.

<?xml version="1.0" encoding="UTF-8"?>
<inputXML 
    xmlns="http://ns.nsdlib.org/ndr/request_v2.00/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://ns.nsdlib.org/ndr/request_v2.00/ http://ns.nsdlib.org/schemas/ndr/request_v2.00.xsd" 
    schemaVersion="1.00.000">
  <collection>2200/20061212543</collection>
  <annotationXML>
    <nsdl_anno:nsdl_anno 
        xmlns:nsdl_anno="http://ns.nsdl.org/nsdl_anno_v1.02/" 
        schemaVersion="1.02.000" xmlns:dc="http://purl.org/dc/elements/1.1/" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xsi:schemaLocation="http://ns.nsdl.org/nsdl_anno_v1.02/ http://ns.nsdl.org/schemas/nsdl_anno/nsdl_anno_v1.02.xsd"> 
      <title>Annotations for Global Sun Temperature Project</title> 
      <rating>5</rating> 
    </nsdl_anno:nsdl_anno>   
  </annotationXML>
  <XMLFormat>nsdl_anno</XMLFormat>
  <annotates>2200/20061285966</annotates> 
  <externalIdentifier>CLC-000-000-000-054</externalIdentifier>
</inputXML>

Response

Structure of response:

handle - the externally resolvable identifier for the Annotation. NOTE: All annotation related API calls that manipulate a specific annotation expect this handle as a parameter.
handleURL - the permanent URL to an XML representation of the annotation in the NDR.

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/addAnnotation</requestURL>
  
  <resultData>
    <handle>2200/20061288752</handle>
    <handleURL>http://ndr.nsdlib.org/api/getAnnotation/2200/20061288752</handleURL>
  <resultData>
</NSDLDataRespository>