Collection Private Read
GET {{baseUrl}}/collection/v1/private/read/{{collectionId}}
This API is associated with read collection private on the Sunbird Platform .
- /Collection/ endpoint executes the Private Read Collection
request based on parameters provided as metadata in the request body.
- The endpoint for Read Collection is /collection/v1/private/read
- It points to knowledge-mw-service - /v1/collection/private/read
- {...}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.read","ver":"1.0","ts":"2020-12-09T12:09:04.202Z","params":{"resmsgid":"548b82a0-3a17-11eb-be5b-f9d249ba9049","msgid":"5488ea90-3a17-11eb-be5b-f9d249ba9049","status":"successful"},"responseCode":"OK","result":{"content":{"ownershipType":["createdBy"],"code":"org.sunbird.ccG6ru","credentials":{"enabled":false},"channel":"in.ekstep","language":["English"],"mimeType":"application/pdf","idealScreenSize":"normal","createdOn":"2020-12-09T12:08:54.913+0000","objectType":"Content","primaryCategory":"Explanation Content","contentDisposition":"inline","lastUpdatedOn":"2020-12-09T12:08:54.913+0000","contentEncoding":"identity","contentType":"Resource","dialcodeRequired":false,"identifier":"do_1131687689003827201864","lastStatusChangedOn":"2020-12-09T12:08:54.913+0000","audience":["Student"],"os":["All"],"visibility":"Default","consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","mediaType":"content","osId":"org.ekstep.quiz.app","languageCode":["en"],"version":2,"versionKey":"1607515734913","license":"CC BY 4.0","idealScreenDensity":"hdpi","framework":"NCF","createdBy":"874ed8a5-782e-4f6c-8f36-e0288455901e","compatibilityLevel":1,"name":"API DOCUMENTATION CONTENT","status":"Draft"}}}