Qodex.ai

Read Collection Hierarchy

GET {{baseUrl}}/collection/v1/hierarchy/{{collectionId}}

This API is associated with viewing and reading out the collection on the Sunbird Platform . - The /hierarchy/{collectionId} endpoint executes request for fetching the collection to be viewed and read. - The endpoint for Read Collection is /collection/v1/hierarchy - It points to knowledge-mw-service - /v1/collection/hierarchy - {...}refers to a section of reject endpoint URL path that needs to be replaced by appropriate Id. - You need to provide a valid collection Id value in {Collection Id} field of API URL. - It is mandatory to provide values for parameters marked with *. - Mandatory fields cannot be null or empty.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring(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.
Content-TypestringThe Asset Type entity is the media type of the resource.Possible
x-authenticated-user-tokenstring(Required) Represents the authorized User ID to execute the API
X-Channel-IDstring(Required) Represents a physical location (e.g: state) uniquely to which the user belongs
Acceptstring

RESPONSES

status: OK

{"id":"api.collection.hierarchy.get","ver":"4.0","ts":"2022-01-04T12:28:17ZZ","params":{"resmsgid":"0541c308-4754-4b0c-8e0e-47467c3cc35c","status":"successful"},"responseCode":"OK","result":{"content":{"ownershipType":["createdBy"],"copyright":"NIT123","keywords":["Collection Test"],"subject":["Mathematics"],"channel":"sunbird","organisation":["NIT"],"language":["English"],"mimeType":"application/vnd.ekstep.content-collection","objectType":"Collection","chapterCountForContribution":1,"gradeLevel":["Class 1"],"appIcon":"https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/do_11293020669537484811928/artifact/001_1578394365141.png","primaryCategory":"Digital Textbook","children":[{"ownershipType":["createdBy"],"parent":"do_1134445959309803521184","code":"do_1132167447297474561289","credentials":{"enabled":false},"origin":"do_1132167447297474561289","channel":"sunbird","language":["English"],"mimeType":"application/vnd.ekstep.content-collection","idealScreenSize":"normal","createdOn":"2022-01-03T05:00:26.831+0000","objectType":"Content","primaryCategory":"Content Playlist","children":[{"ownershipType":["createdBy"],"parent":"do_1134445959317995521185","code":"do_113333485887143936169","credentials":{"enabled":false},"origin":"do_113333485887143936169","channel":"sunbird","language":["English"],"mimeType":"application/vnd.ekstep.content-collection","idealScreenSize":"normal","createdOn":"2022-01-03T05:00:26.834+0000","objectType":"Content","primaryCategory":"Textbook Unit","contentDisposition":"inline","lastUpdatedOn":"2022-01-03T05:00:26.834+0000","contentEncoding":"gzip","originData":{"channel":1309282781705830400},"generateDIALCodes":false,"contentType":"TextBookUnit","dialcodeRequired":false,"identifier":"do_1134445959318241281187","lastStatusChangedOn":"2022-01-03T05:00:26.834+0000","audience":["Student"],"os":["All"],"visibility":"Parent","discussionForum":{"enabled":true},"index":1,"mediaType":"content","osId":"org.ekstep.launcher","languageCode":["en"],"version":2,"versionKey":"1641186026834","allowedContentTypes":["Demo Practice Question Set","Content Playlist","Course Assessment","eTextbook","Explanation Content","Learning Resource","Practice Question Set","Teacher Resource"],"license":"CC BY 4.0","idealScreenDensity":"hdpi","depth":2,"compatibilityLevel":1,"name":"Part 1","openForContribution":true,"timeLimits":{},"programId":"fae8bbf0-6c51-11ec-ad7a-853bd8da76ad","status":"Draft","children":[{"ownershipType":["createdBy"],"unitIdentifiers":["do_1134445959318241281187"],"parent":"do_1134445959318241281187","subject":["Mathematics"],"channel":1309282781705830400,"language":["English"],"mimeType":"application/pdf","objectType":"Content","gradeLevel":["Class 1"],"primaryCategory":"eTextbook","contentEncoding":"identity","contentType":"eTextBook","identifier":"do_1134453165632552961201","audience":["Student"],"subjectIds":["ekstep_ncert_k-12_subject_mathematics"],"visibility":"Default","author":"anusha","index":1,"mediaType":"content","osId":"org.ekstep.quiz.app","languageCode":["en"],"version":2,"license":"CC BY 4.0","name":"Untitled","mediumIds":["ekstep_ncert_k-12_medium_english"],"status":"Draft","code":"b1ef1747-b33a-d91a-93f0-7a0064f1f802","interceptionPoints":{},"credentials":{"enabled":false},"medium":["English"],"idealScreenSize":"normal","createdOn":"2022-01-04T05:26:34.539+0000","contentDisposition":"inline","lastUpdatedOn":"2022-01-04T05:26:34.989+0000","collectionId":"do_1134445959309803521184","dialcodeRequired":false,"lastStatusChangedOn":"2022-01-04T05:26:34.539+0000","creator":"anusha","os":["All"],"versionKey":"1641273994989","idealScreenDensity":"hdpi","framework":"ekstep_ncert_k-12","boardIds":["ekstep_ncert_k-12_board_cbse"],"depth":3,"createdBy":"19ba0e4e-9285-4335-8dd0-f674bf03fa4d","compatibilityLevel":1,"gradeLevelIds":["ekstep_ncert_k-12_gradelevel_class1"],"board":"CBSE","programId":"fae8bbf0-6c51-11ec-ad7a-853bd8da76ad","downloadUrl":"https://dockstorage.blob.core.windows.net/sunbird-content-dock/content/assets/do_1134453165632552961201/sample.pdf","artifactUrl":"https://dockstorage.blob.core.windows.net/sunbird-content-dock/content/assets/do_1134453165632552961201/sample.pdf","size":3028},{"ownershipType":["createdBy"],"unitIdentifiers":["do_1134445959318241281187"],"parent":"do_1134445959318241281187","copyright":"2021","subject":["Mathematics"],"channel":1309282781705830400,"downloadUrl":"https://dockstorage.blob.core.windows.net/sunbird-content-dock/content/assets/do_1134455063866736641416/sample.pdf","language":["English"],"mimeType":"application/pdf","objectType":"Content","gradeLevel":["Class 1"],"primaryCategory":"eTextbook","contentEncoding":"identity","artifactUrl":"https://dockstorage.blob.core.windows.net/sunbird-content-dock/content/assets/do_1134455063866736641416/sample.pdf","contentType":"eTextBook","identifier":"do_1134455063866736641416","audience":["Student"],"subjectIds":["ekstep_ncert_k-12_subject_mathematics"],"visibility":"Default","author":"anusha","index":2,"mediaType":"content","osId":"org.ekstep.quiz.app","languageCode":["en"],"version":2,"license":"CC BY 4.0","size":3028,"name":"test content","mediumIds":["ekstep_ncert_k-12_medium_english"],"status":"Draft","code":"9ab1557b-ea67-c31b-be52-e4073c5d8f1b","interceptionPoints":{},"credentials":{"enabled":false},"medium":["English"],"idealScreenSize":"normal","createdOn":"2022-01-04T11:52:46.343+0000","contentDisposition":"inline","lastUpdatedOn":"2022-01-04T11:53:13.077+0000","collectionId":"do_1134445959309803521184","dialcodeRequired":false,"lastStatusChangedOn":"2022-01-04T11:52:46.343+0000","creator":"anusha","os":["All"],"versionKey":"1641297193077","idealScreenDensity":"hdpi","framework":"ekstep_ncert_k-12","boardIds":["ekstep_ncert_k-12_board_cbse"],"depth":3,"createdBy":"19ba0e4e-9285-4335-8dd0-f674bf03fa4d","compatibilityLevel":1,"gradeLevelIds":["ekstep_ncert_k-12_gradelevel_class1"],"board":"CBSE","programId":"fae8bbf0-6c51-11ec-ad7a-853bd8da76ad"}]}],"contentDisposition":"inline","lastUpdatedOn":"2022-01-03T05:00:26.831+0000","contentEncoding":"gzip","originData":{"channel":1309282781705830400},"contentType":"Collection","dialcodeRequired":false,"trackable":{"enabled":false,"autoBatch":false},"identifier":"do_1134445959317995521185","lastStatusChangedOn":"2022-01-03T05:00:26.831+0000","audience":["Student"],"os":["All"],"visibility":"Parent","index":1,"mediaType":"content","osId":"org.ekstep.launcher","languageCode":["en"],"version":2,"versionKey":"1641186026831","allowedContentTypes":["Demo Practice Question Set","Content Playlist","Course Assessment","eTextbook","Explanation Content","Learning Resource","Practice Question Set","Teacher Resource"],"license":"CC BY 4.0","idealScreenDensity":"hdpi","depth":1,"compatibilityLevel":1,"name":"Textbook Unit 1","openForContribution":true,"timeLimits":{},"programId":"fae8bbf0-6c51-11ec-ad7a-853bd8da76ad","status":"Draft"}],"contentEncoding":"gzip","collaborators":["88ffb6eb-33bf-4f96-ad3a-75c15e5a04ff","a4b4a783-d686-4f67-b079-512329c77f5e","ce7f4172-f13a-47b7-804d-f194a2275538"],"contentType":"Collection","trackable":{"enabled":false,"autoBatch":false},"identifier":"do_1134445959309803521184","audience":["Student"],"subjectIds":["ekstep_ncert_k-12_subject_mathematics"],"visibility":"Default","consumerId":"028d6fb1-2d6f-4331-86aa-f7cf491a41e0","childNodes":["do_1134445959318241281187","do_1134445959317995521185","do_1134453165632552961201","do_1134455063866736641416"],"mediaType":"content","osId":"org.ekstep.quiz.app","languageCode":["en"],"version":2,"allowedContentTypes":["Demo Practice Question Set","Content Playlist","Course Assessment","eTextbook","Explanation Content","Learning Resource","Practice Question Set","Teacher Resource"],"license":"CC BY 4.0","name":"Collection Test","mediumIds":["ekstep_ncert_k-12_medium_english"],"attributions":["Collection Test"],"status":"Draft","code":"do_1132167446143959041288","credentials":{"enabled":false},"origin":"do_1132167446143959041288","description":"Enter description for Collection","medium":["English"],"idealScreenSize":"normal","createdOn":"2022-01-03T05:00:26.734+0000","copyrightYear":2021,"contentDisposition":"inline","additionalCategories":["Textbook"],"lastUpdatedOn":"2022-01-04T11:54:05.627+0000","originData":{"channel":1309282781705830400},"dialcodeRequired":false,"lastStatusChangedOn":"2022-01-03T05:00:26.734+0000","createdFor":[1309282781705830400],"creator":"N11","os":["All"],"chapterCount":1,"versionKey":"1641297245627","idealScreenDensity":"hdpi","framework":"ekstep_ncert_k-12","depth":0,"boardIds":["ekstep_ncert_k-12_board_cbse"],"createdBy":"5a587cc1-e018-4859-a0a8-e842650b9d64","compatibilityLevel":1,"userConsent":true,"openForContribution":true,"timeLimits":"{}","gradeLevelIds":["ekstep_ncert_k-12_gradelevel_class1"],"board":"CBSE","programId":"fae8bbf0-6c51-11ec-ad7a-853bd8da76ad","resourceType":"Collection"}}}