Collection Retire
DELETE {{baseUrl}}/collection/v1/retire/{{collectionId}}
This API is associated with Retire Collection on the Sunbird Platform .
- /Collection/ endpoint executes the Retire Collection
request based on parameters provided as metadata in the request body.
- The endpoint for Retire Collection is /collection/v1/retire
- It points to knowledge-mw-service - /v1/collection/retire
- {...}refers to a section of review endpoint URL path that needs to be replaced by appropriate Id.
- It is mandatory to provide values for parameters marked with *.
- Mandatory fields cannot be null or empty.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | (Required) The Content Type entity is the media type of the resource.Possible media types can be:- |
- Application/json |
|
X-Authenticated-User-Token| string | | (Required) The Registered User ID used to execute the API. | |X-Channel-id| string | | The unique ID provided to the State to which the user belongs. | |Authorization| string | | (Required) All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API. | |Accept| string | | |
RESPONSES
status: OK
{"id":"api.collection.retire","ver":"4.0","ts":"2022-01-06T06:51:00ZZ","params":{"resmsgid":"280f83f7-4f69-4c22-bc93-33ebeb8823e8","status":"successful"},"responseCode":"OK","result":{"identifier":"do_11334223976733900811","node_id":"do_11334223976733900811"}}