Fetch Category
GET {{baseUrl}}/framework/v1/category/read/:code?framework=Ut enim offici
This API is associated with fetching a category on Sunbird Platform
- The endpoint for Fetch Category is /framework/v1/category/read/{code}
- It points to knowledge-mw-service - /v1/framework/category/read/{code}
- The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
framework | string | (Required) Name of the framework under which category exists. Its an abstract data structure which serves as a template for categories and terms |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"id":"api.category.read","ver":"1.0","ts":"2020-12-14T19:34:41.261Z","params":{"resmsgid":"6923b1d0-3e43-11eb-9ff3-67c41480f6aa","msgid":"691e3390-3e43-11eb-9ff3-67c41480f6aa","status":"successful","err":null,"errmsg":null},"responseCode":"OK","result":{"category":{"identifier":"dummy_framework_subject","lastStatusChangedOn":"2020-12-14T19:30:32.392+0000","code":"subject","frameworks":[{"identifier":"dummy_framework","name":"Framework Name","objectType":"Framework","relation":"hasSequenceMember","description":"Dumy framework updated","status":"Live"}],"consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","channel":"in.ekstep","description":"Subject","domains":[],"createdOn":"2020-12-14T19:30:32.392+0000","versionKey":"1607974232392","terms":[],"appId":"@ignore@","name":"Subject","lastUpdatedOn":"2020-12-14T19:30:32.392+0000","status":"Live"}}}