Fetch Term
GET {{baseUrl}}/framework/v1/term/read/{{termCode}}?framework={{frameworkId}}&category={{categoryId}}
This API is associated with fetching the available terms under a specific category and a framework on Sunbird Platform.
- The endpoint for Fetch Term is /framework/v1/term/read/{code}
- It points to knowledge-mw-service - /v1/framework/term/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) Represents the framework id in which the term can be fetched | |
category | string | (Required) Represents the category in which the term can be fetched |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"id":"api.term.read","ver":"1.0","ts":"2020-12-17T07:24:51.258Z","params":{"resmsgid":"f380c1a0-4038-11eb-9b0c-abcfbdf41bc3","msgid":"f358c740-4038-11eb-9b0c-abcfbdf41bc3","status":"successful","err":null,"errmsg":null},"responseCode":"OK","result":{"term":{"associations":[],"identifier":"dummy_framework_subject_english","lastStatusChangedOn":"2020-12-14T19:44:02.260+0000","code":"english","consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","channel":"in.ekstep","description":"English","createdOn":"2020-12-14T19:44:02.260+0000","versionKey":"1607975299669","children":[],"appId":"dev.sunbird.portal","name":"English","lastUpdatedOn":"2020-12-14T19:48:19.669+0000","categories":[{"identifier":"dummy_framework_subject","name":"Subject","objectType":"CategoryInstance","relation":"hasSequenceMember","description":"Updated description","status":"Live"}],"category":"subject","status":"Live"}}}