TNS Internal:NDR/API/2.0/specification/authorizeToChange

From NSDLWiki

Jump to: navigation, search

 NDR Project Documentation   Conceptual Framework   v1.0 NDR-API Index   v2.0 NDR-API Index   Model 

Under Construction
Proposed method for inclusion in NDR/API 2.0.

Please provide feedback and comments in the NSDL Data Repository (NDR) API 2.0 Forum of the NSDL Community Forums.

NDR API Documentation - authorizeToChange

Authorize an agent to make updates to an object and its children. Typically used to allow multiple applications to contribute to the same collection. NOTE: Only the owner agent of the target object may perform this operation.

Request URL

Must be an HTTP POST request.


Structure of input:

  • inputXML (required)
    • target (required) - the externally resolvable identifier (handle) for an object that an agent needs permission to modify. NOTE: At this time, the only supported target object type is Collection.
    • agents (required) - a grouping of one or more agents whose permissions are being affected
    • agent (at least one required) - the externally resolvable identifier (handle) for the agent gaining modify permissions. NOTE: Multiple agent elements may be listed to give permission to multiple agents with a single call.

InputXML Example

Below is example inputXML for authorizing an agent to change an object and its children in the NDR.

<?xml version="1.0" encoding="UTF-8"?>


Structure of response:

  • handle - the externally resolvable identifier for the target object.
  • handleURL - the permanent URL to an XML representation of the target object in the NDR.

Common Errors

  • inadequate permissions because signing agent does not own the target object

Response Example

Below is an example response for this request.

<?xml version="1.0" encoding="UTF-8"?>
<NSDLDataRepository schemaVersion="1.00.000" 

API Links:

Additional Links Related to This Call:

Personal tools