Read Private Content
GET {{baseUrl}}/content/v1/private/read/:Content_Id
This API is associated with viewing and reading out the private and public contents on the Sunbird Platform.
- The /private/read/{contentId} endpoint executes request for fetching the private and public contents to be viewed and read.
- The endpoint for Read Private Content is /content/v1/private/read
- It points to content-service - /content/v4/private/read
- {...}refers to a section of reject endpoint URL path that needs to be replaced by appropriate Id.
- You need to provide a valid content Id value in {Content Id} field of API URL.
- 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 | The Content Type entity is the media type of the resource.Possible media types can be:- |
- Application/json |
|
x-channel-id| string | | (Required) Represents a physical location (e.g: state) uniquely to which the user belongs. | |Authorization| string | | (Required) To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here. | |Accept| string | | |
RESPONSES
status: OK
{"id":"api.content.private.read","ver":"4.0","ts":"2021-09-20T20:12:52Z+05:30","params":{"resmsgid":"a31dbba1-c3bf-4c3d-a028-f3e5b7de4b57","msgid":null,"err":null,"status":"successful","errmsg":null},"responseCode":"OK","result":{"content":{"ownershipType":["createdBy"],"code":"name","interceptionPoints":{},"credentials":{"enabled":"No"},"channel":"abc-123","language":["English"],"mimeType":"application/pdf","idealScreenSize":"normal","createdOn":"2021-08-30T13:11:08.485+0530","objectType":"Content","primaryCategory":"Learning Resource","contentDisposition":"inline","lastUpdatedOn":"2021-08-30T13:11:08.485+0530","contentEncoding":"identity","dialcodeRequired":"No","trackable":{"enabled":"No","autoBatch":"No"},"identifier":"do_11335549352263680012","lastStatusChangedOn":"2021-08-30T13:11:08.485+0530","audience":["Student"],"os":["All"],"visibility":"Private","discussionForum":{"enabled":"No"},"mediaType":"content","osId":"org.ekstep.quiz.app","languageCode":["en"],"version":2,"versionKey":"1630309268485","license":"CC BY 4.0","idealScreenDensity":"hdpi","framework":"NCF","compatibilityLevel":1,"name":"Untitled Resource","status":"Draft"}}}