TNS Internal:NDR/API/2.0/specification/undeleteCollection
From NSDLWiki
< TNS Internal:NDR | API | 2.0(Redirected from Community:NDR/API/2.0/specification/undeleteCollection)
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 - undeleteCollection
Undelete the specified collection and all metadata and annotations that are part of the collection. Any objects that are members of this collection that are marked as deleted will be made active regardless of the date or method used for deleting.
Request URL
- http://ndr.nsdlib.org/api/undeleteCollection/[handle]
- where [handle] is defined in the Arguments section.
- May be an HTTP GET or POST request.
Arguments
Parameters on Request URL:
- [handle] (required) - the externally resolvable identifier of the collection (returned by addCollection)
Request URL Example
Below is an example of a request URL for undeleting (mark as active) a collection identified by a handle and all metadata and annotations that are part of the collection in the NDR.
http://ndr.nsdlib.org/api/undeleteCollection/2200/20061212543
Response
Structure of response:
- handle - the externally resolvable identifier for the Collection.
- handleURL - the permanent URL to an XML representation of the Collection 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/undeleteCollection/[handle]</requestURL> <resultData> <handle>2200/20061212543</handle> <handleURL>http://ndr.nsdl.org/api/getCollectionRecord/2200/20061212543</handleURL> <resultData> </NSDLDataRespository>
API Links:
- Conceptual Framework (2.0 philosophy)
- APIBasics
- ObjectTypes
- Encoding
- APIRequestsByObject v1.0
- APIRequestsAlphabetical v1.0
- APIRequestsByObject v2.0