{"info":{"_postman_id":"7a5b97e6-3224-4cc8-b97b-1793e0ed83b9","name":"Sunbird Framework API(s)_V1","description":"

The Framework API resources is basically a supporting data structure which serves as a template

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25463377","collectionId":"7a5b97e6-3224-4cc8-b97b-1793e0ed83b9","publishedId":"2s8ZDa32ay","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-01-23T09:51:29.000Z"},"item":[{"name":"channel/v1","item":[{"name":"Create Channel","id":"03a07692-308b-4ae1-815f-5a4afdfdb025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"name\": \"Channel Name\",\n \"code\": \"channel-id\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/channel/v1/create","description":"

This API is used for creating a channel

\n\n","urlObject":{"path":["channel","v1","create"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[]}},"response":[{"id":"c56a4866-635c-4d76-b560-deaf741af7e3","name":"OK ! Successful operation.\"Create channel\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(Required) To make use of the API, you require bearer authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"name\": \"Channel Name\",\n \"code\": \"channel-id\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/channel/v1/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T08:27:27.810Z\",\n \"params\": {\n \"resmsgid\": \"3357da20-3de6-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"3353bb70-3de6-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"identifier\": \"channel-id\",\n \"node_id\": \"channel-id\"\n }\n}"},{"id":"3522525b-f7d9-4206-94bf-22e8ffa6b8a7","name":"BAD REQUEST. The \"Create Channel\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter or providing some wrong request.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(Required) To make use of the API, you require bearer authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"name\": \"Channel Name\",\n \"code\": \"channel-id\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/channel/v1/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T08:26:15.914Z\",\n \"params\": {\n \"resmsgid\": \"087d64a0-3de6-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"CONSTRAINT_VALIDATION_FAILED\",\n \"errmsg\": \"Object already exists with identifier: channel-id\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {\n \"messages\": null\n }\n}"},{"id":"fd2ed84c-cf09-40f3-84d0-16761df37e9d","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(Required) To make use of the API, you require bearer authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"name\": \"Channel Name\",\n \"code\": \"channel-id\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/channel/v1/create"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"03a07692-308b-4ae1-815f-5a4afdfdb025"},{"name":"Get a Channel","id":"475a8136-5701-4f89-92d5-093afb300b4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://staging.open-sunbird.org/api/channel/v1/read/:ID","description":"

This API is associated with fetching a channel by a specific channel ID

\n
    \n
  • The endpoint for Get a Channel is /channel/v1/read/{ID}
    • \n
  • It points to knowledge-mw-service - /v1/channel/read/{ID}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["channel","v1","read",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"4c586449-5bbf-4d7d-ae8d-74bb12bbb302","description":{"content":"

(Required) Unique identifier of the channel to get

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"373fed3f-25f3-49c2-b2cd-c980ee33df19","name":"OK ! Successful operation. **Channel Read** operation was successfully executed. \\n Please refer for different additional [metadata](https://github.com/project-sunbird/knowledge-platform/blob/release-3.5.0/schemas/content/1.0/schema.json)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to get"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.read\",\n \"ver\": \"3.0\",\n \"ts\": \"2020-12-14T08:33:50ZZ\",\n \"params\": {\n \"resmsgid\": \"02c742d2-57e1-4441-aa31-0ce339c3917b\",\n \"msgid\": null,\n \"err\": null,\n \"status\": \"successful\",\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"channel\": {\n \"identifier\": \"channel-405\",\n \"lastStatusChangedOn\": \"2020-12-14T08:27:49.490+0000\",\n \"code\": \"channel-405\",\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"assetAdditionalCategories\": [],\n \"autoCreateBatch\": \"Enabled\",\n \"languageCode\": [],\n \"suggested_frameworks\": [\n {\n \"identifier\": \"NCF\",\n \"code\": \"NCF\",\n \"name\": \"NCF\",\n \"objectType\": \"Framework\"\n }\n ],\n \"createdOn\": \"2020-12-14T08:27:49.490+0000\",\n \"objectType\": \"Channel\",\n \"versionKey\": \"1607934825088\",\n \"collectionPrimaryCategories\": [\n \"Content Playlist\",\n \"Course\",\n \"Digital Textbook\",\n \"Explanation Content\"\n ],\n \"contentPrimaryCategories\": [\n \"Course Assessment\",\n \"eTextbook\",\n \"Explanation Content\",\n \"Learning Resource\",\n \"Practice Question Set\",\n \"Teacher Resource\"\n ],\n \"name\": \"Channel without Default License\",\n \"lastUpdatedOn\": \"2020-12-14T08:33:45.088+0000\",\n \"defaultCourseFramework\": \"TPD\",\n \"collectionAdditionalCategories\": [\n \"Textbook\",\n \"Lesson Plan\",\n \"TV Lesson\"\n ],\n \"assetPrimaryCategories\": [\n \"Asset\",\n \"CertAsset\",\n \"Certificate Template\"\n ],\n \"contentAdditionalCategories\": [\n \"Classroom Teaching Video\",\n \"Concept Map\",\n \"Curiosity Question Set\",\n \"Experiential Resource\",\n \"Explanation Video\",\n \"Focus Spot\",\n \"Learning Outcome Definition\",\n \"Lesson Plan\",\n \"Marking Scheme Rubric\",\n \"Pedagogy Flow\",\n \"Previous Board Exam Papers\",\n \"TV Lesson\",\n \"Textbook\"\n ],\n \"status\": \"Live\",\n \"defaultFramework\": \"NCF\"\n }\n }\n}"},{"id":"609d7344-d51a-41a7-9df2-6e6521c53dd2","name":"RESOURCE NOT FOUND. The **Channel Read** operation failed ! The possible reason for failure is that you may have passed invalid channel id.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to get"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.read\",\n \"ver\": \"3.0\",\n \"ts\": \"2020-12-14T08:36:08ZZ\",\n \"params\": {\n \"resmsgid\": \"e54ff3af-4026-420e-9412-0fcd3eba1674\",\n \"msgid\": null,\n \"err\": \"NOT_FOUND\",\n \"status\": \"failed\",\n \"errmsg\": \"Error! Node(s) doesn't Exists. | [Invalid Node Id.]: channel-407\"\n },\n \"responseCode\": \"RESOURCE_NOT_FOUND\",\n \"result\": {\n \"messages\": null\n }\n}"},{"id":"715f621d-01c9-4ff9-8033-77d1fe90fac3","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to get"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"475a8136-5701-4f89-92d5-093afb300b4d"},{"name":"Update Channel","id":"9070f5db-e118-4aef-9d65-cc0acb717692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"description\": \"Updated channel description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/channel/v1/update/:ID","description":"

This API is associated with updating a specific channel

\n
    \n
  • The endpoint for Update Channel is /channel/v1/update/{ID}
    • \n
  • It points to knowledge-mw-service - /v1/channel/update/{ID}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["channel","v1","update",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"0d7dfe45-1f49-413c-bd91-d4feee231e33","description":{"content":"

(Required) Unique identifier of the channel to be updated

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"d0cf7eca-df8d-4102-952e-0380f7409b81","name":"OK ! Successful operation.\"Update channel by ID\" operation was successfully executed.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"description\": \"Updated channel description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T08:29:24.724Z\",\n \"params\": {\n \"resmsgid\": \"79078340-3de6-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"78fef7c0-3de6-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"identifier\": \"channel-405\",\n \"node_id\": \"channel-405\"\n }\n}"},{"id":"e35d7763-de49-46c9-a13c-fb797e27cf6e","name":"BAD REQUEST. The **Update Channel\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"description\": \"Updated channel description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to be updated"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ts\": 79777367,\n \"id\": \"Lorem in dolore ex ullamco\",\n \"params\": {\n \"msgid\": \"in mollit commodo\",\n \"resmsgid\": \"fugiat deserunt Lorem\",\n \"status\": \"failed\",\n \"err\": \"ut dolor et repreh\",\n \"errmsg\": \"ut enim \"\n },\n \"ver\": \"reprehenderit laboris\",\n \"responseCode\": \"proident qui minim\",\n \"result\": {}\n}"},{"id":"b0ff5929-5b9d-46b5-9c29-c017bfa4412e","name":"RESOURCE NOT FOUND. The \"update channel by ID\" operation failed ! The possible reason for failure is that you may have passed invalid channel id.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"description\": \"Updated channel description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to be updated"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.channel.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T08:30:44.219Z\",\n \"params\": {\n \"resmsgid\": \"a8697cb0-3de6-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"NOT_FOUND\",\n \"errmsg\": \"Error! Node(s) doesn't Exists. | [Invalid Node Id.]: channel-406\"\n },\n \"responseCode\": \"RESOURCE_NOT_FOUND\",\n \"result\": {\n \"messages\": null\n }\n}"},{"id":"206f5d41-0e01-415e-b34b-160ce889ddeb","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"channel\": {\n \"description\": \"Updated channel description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/channel/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["channel","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) Unique identifier of the channel to be updated"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9070f5db-e118-4aef-9d65-cc0acb717692"}],"id":"693a9b1f-4eb3-4241-9396-5bd9a4c5266c","_postman_id":"693a9b1f-4eb3-4241-9396-5bd9a4c5266c","description":""},{"name":"framework/v1","item":[{"name":"framework","item":[{"name":"Create a Framework","id":"1114f15b-a5af-44bc-a390-004b35d25efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

(Required) It is the Unique Id to identify the root organisation to which the user belongs

\n","key":"X-Channel-Id","value":"Ut enim offici"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"name\": \"Framework Name\",\n \"code\": \"dummy_framework\",\n \"channels\": [\n {\n \"identifier\": \"in.ekstep\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/create","description":"

This API is associated with creating a new framework on the Sunbird Platform.

\n
    \n
  • The endpoint for Create a Framework is /framework/v1/create
    • \n
  • It points to knowledge-mw-service - /v1/framework/create
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","create"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[]}},"response":[{"id":"dd073ab3-af96-42b9-bd47-bf28aabebc60","name":"OK ! Successful operation.\"create framework\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"name\": \"Framework Name\",\n \"code\": \"dummy_framework\",\n \"channels\": [\n {\n \"identifier\": \"in.ekstep\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T09:49:06.794Z\",\n \"params\": {\n \"resmsgid\": \"9b5d7ca0-3df1-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"9b4a90e0-3df1-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"dummy_framework\",\n \"versionKey\": \"1607939346678\"\n }\n}"},{"id":"7c1e37b2-dea3-49d7-b9a5-548c610e5eb7","name":"BAD REQUEST. The \"create framework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"name\": \"Framework Name\",\n \"code\": \"dummy_framework\",\n \"channels\": [\n {\n \"identifier\": \"in.ekstep\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T09:50:45.249Z\",\n \"params\": {\n \"resmsgid\": \"d60c8710-3df1-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"CONSTRAINT_VALIDATION_FAILED\",\n \"errmsg\": \"Object already exists with identifier: dummy_framework\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"14283560-37e5-463f-8e05-5e953b7e68ad","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"name\": \"Framework Name\",\n \"code\": \"dummy_framework\",\n \"channels\": [\n {\n \"identifier\": \"in.ekstep\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/create"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1114f15b-a5af-44bc-a390-004b35d25efd"},{"name":"Get a Framework","id":"63b25197-8910-420b-8481-c9618fe8a2a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://staging.open-sunbird.org/api/framework/v1/read/:ID","description":"

This API is associated with fetching a specific framework

\n
    \n
  • The endpoint for Get a Framework is /framework/v1/read/{ID}
    • \n
  • It points to knowledge-mw-service - /v1/framework/read/{ID}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","read",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"c8a0e3c3-fc42-4674-8a35-6dca4aa147bf","description":{"content":"

(Required) The identifier of the framework to be fetched

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"ff02a134-a3c4-44df-8923-ce9c6d826b2e","name":"OK ! Successful operation.\"read framework\" operation was successfully executed.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:51:24ZZ\",\n \"params\": {\n \"resmsgid\": \"28f10a2a-ce6c-4dbe-a733-4c193013e84b\",\n \"msgid\": null,\n \"err\": null,\n \"status\": \"successful\",\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"framework\": {\n \"identifier\": \"dummy_framework\",\n \"code\": \"Dumy framework updated\",\n \"name\": \"Framework Name\",\n \"description\": \"Dumy framework updated\",\n \"categories\": [\n {\n \"identifier\": \"dummy_framework_subject\",\n \"code\": \"subject\",\n \"terms\": [\n {\n \"identifier\": \"dummy_framework_subject_english\",\n \"code\": \"english\",\n \"translations\": null,\n \"name\": \"English\",\n \"description\": \"English\",\n \"index\": 1,\n \"category\": \"subject\",\n \"status\": \"Live\"\n }\n ],\n \"translations\": null,\n \"name\": \"Subject\",\n \"description\": \"Updated description\",\n \"index\": 1,\n \"status\": \"Live\"\n },\n {\n \"identifier\": \"dummy_framework_medium\",\n \"code\": \"medium\",\n \"translations\": null,\n \"name\": \"Medium\",\n \"description\": \"Medium\",\n \"index\": 2,\n \"status\": \"Live\"\n }\n ],\n \"type\": \"K-12\",\n \"objectType\": \"Framework\"\n }\n }\n}"},{"id":"43319bf6-c5b8-4aa2-b290-de3ca493e579","name":"BAD REQUEST. The \"read framework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be fetched"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ts\": 87966182,\n \"id\": \"laboris q\",\n \"params\": {\n \"msgid\": \"do est non incididunt\",\n \"resmsgid\": \"sint Excepteur sunt\",\n \"status\": \"successful\",\n \"err\": \"nisi magna eu\",\n \"errmsg\": \"velit\"\n },\n \"ver\": \"cupidatat exercitation elit\",\n \"responseCode\": \"do et cillum\",\n \"result\": {}\n}"},{"id":"bbde8f15-ca1c-4b60-9eff-c125b9f91875","name":"RESOURCE NOT FOUND. The \"read framework\" operation failed ! The possible reason for failure is that you may have passed invalid framework id.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be fetched"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:00:12.540Z\",\n \"params\": {\n \"resmsgid\": \"282e43c0-3df3-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_DATA_NOT_FOUND\",\n \"errmsg\": \"Data not found with id : dummy_framework1\"\n },\n \"responseCode\": \"RESOURCE_NOT_FOUND\",\n \"result\": {}\n}"},{"id":"266ac4d6-bdfc-468a-a76c-98672c5418f9","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/read/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","read",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be fetched"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"63b25197-8910-420b-8481-c9618fe8a2a7"},{"name":"Update Framework","id":"e256194b-608d-462d-8676-6e687d295d6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"description":"

(Required) It is the Unique Id to identify the root organisation to which the user belongs

\n","key":"X-Channel-Id","value":"Ut enim offici"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"description\": \"Dumy framework updated\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/update/:ID","description":"

This API is associated with updating a framework

\n
    \n
  • The endpoint for Update Framework is /framework/v1/update/{ID}
    • \n
  • It points to knowledge-mw-service - /v1/framework/update/{ID}
    • \n
  • The fieldsmarked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","update",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"8bc541d4-1430-4750-bcca-7dcadba05571","description":{"content":"

(Required) The identifier of the framework to be updated

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"a6cacab6-5031-4de6-97c8-cbb0432e6b10","name":"OK ! Successful operation.\"update framework\" operation was successfully executed.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"description\": \"Dumy framework updated\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T09:57:20.317Z\",\n \"params\": {\n \"resmsgid\": \"c1871ed0-3df2-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"c17ff2e0-3df2-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"dummy_framework\",\n \"versionKey\": \"1607939840281\"\n }\n}"},{"id":"12aedcac-7fe0-4ad3-929a-3d1003494337","name":"BAD REQUEST. The \"update framework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"description\": \"Dumy framework updated\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be updated"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ts\": 24700756,\n \"id\": \"ut culpa\",\n \"params\": {\n \"msgid\": \"esse consequat\",\n \"resmsgid\": \"commodo aliqua magna Excepteur\",\n \"status\": \"failed\",\n \"err\": \"dolor laborum in ullamco\",\n \"errmsg\": \"laborum laboris sunt\"\n },\n \"ver\": \"laboris ut qu\",\n \"responseCode\": \"exercitation adipisicing in aliqua\",\n \"result\": {}\n}"},{"id":"5d972d6c-d01c-46e0-ae71-ebffd50265d4","name":"RESOURCE NOT FOUND. The \"update framework\" operation failed ! The possible reason for failure is that you may have passed invalid framework id.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"description\": \"Dumy framework updated\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be updated"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T09:57:50.352Z\",\n \"params\": {\n \"resmsgid\": \"d36e1900-3df2-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_FRAMEWORK_NOT_FOUND\",\n \"errmsg\": \"Framework Not Found With Id : dummy_framework1\"\n },\n \"responseCode\": \"RESOURCE_NOT_FOUND\",\n \"result\": {}\n}"},{"id":"51cf523e-7e9c-49c8-b2aa-28813f7e822d","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json\n - multipart/form-data\n - application/x-www-form-urlencoded","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"description\": \"Dumy framework updated\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/update/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","update",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be updated"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e256194b-608d-462d-8676-6e687d295d6e"},{"name":"List Existing Frameworks","id":"728e3b5e-18ab-4a14-8b54-b4ab9ed4eb90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {\n \"status\": \"Live\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/list","description":"

This API is associated with listing of all existing frameworks

\n
    \n
  • The endpoint for List Existing Frameworks is /framework/v1/list
    • \n
  • It points to knowledge-mw-service - /v1/framework/list
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","list"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[]}},"response":[{"id":"befcc29a-8660-4e51-bf11-d5e64e8e6066","name":"OK ! Successful operation.\"list framework\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {\n \"status\": \"Live\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.list\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:02:06.928Z\",\n \"params\": {\n \"resmsgid\": \"6c5c7d00-3df3-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"6c38ef70-3df3-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"frameworks\": [\n {\n \"owner\": \"in.ekstep\",\n \"identifier\": \"NCERT\",\n \"code\": \"NCERT\",\n \"apoc_json\": \"{\\\"batch\\\": true}\",\n \"consumerId\": \"a6654129-b58d-4dd8-9cf2-f8f3c2f458bc\",\n \"channel\": \"in.ekstep\",\n \"description\": \"NCERT \",\n \"type\": \"K-12\",\n \"createdOn\": \"2018-01-18T17:24:50.850+0000\",\n \"apoc_text\": \"APOC\",\n \"versionKey\": \"1525253065583\",\n \"channels\": [\n {\n \"identifier\": \"in.ekstep\",\n \"name\": \"Ekstep\",\n \"objectType\": \"Channel\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Channel for in.ekstep\",\n \"status\": \"Live\"\n }\n ],\n \"appId\": \"ekstep_portal\",\n \"name\": \"NCERT\",\n \"lastUpdatedOn\": \"2018-05-02T09:24:25.583+0000\",\n \"categories\": [\n {\n \"identifier\": \"ncert_board\",\n \"name\": \"Boards\",\n \"objectType\": \"CategoryInstance\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"\",\n \"index\": 5,\n \"status\": \"Retired\"\n }\n ],\n \"status\": \"Live\",\n \"apoc_num\": 1\n }\n ],\n \"count\": 1\n }\n}"},{"id":"ace43e9b-6312-4d56-9ee9-dea015be7178","name":"BAD REQUEST. The \"list framework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {\n \"status\": \"Live\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/list"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.list\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T18:07:11.141Z\",\n \"params\": {\n \"resmsgid\": \"2fd2f550-3e37-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_SEARCH_REQUEST\",\n \"errmsg\": \"Invalid Search Request\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"c2d9d37f-23dc-4fe6-94ee-8bdd7781e6c3","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {\n \"status\": \"Live\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/list"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"728e3b5e-18ab-4a14-8b54-b4ab9ed4eb90"},{"name":"Publish Framework","id":"eb30e906-51f6-4aa1-9161-0a58b0c2126e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

(Required) It is the Unique Id to identify the root organisation to which the user belongs

\n","key":"X-Channel-Id","value":"Ut enim offici"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/publish/:ID","description":"

This API is associated with publishing a framework

\n
    \n
  • The endpoint for Publish Framework is /framework/v1/publish/{ID}
    • \n
  • It points to knowledge-mw-service - /v1/framework/publish/{ID}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","publish",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"56e4733b-63ea-4d5b-9614-3884557dd71f","description":{"content":"

(Required) The identifier of the framework to be published

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"f89052cc-f060-46b4-91b3-bafda8c260cd","name":"OK ! Successful operation.\"Publish framework\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/publish/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","publish",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be published"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.publish\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:07:54.648Z\",\n \"params\": {\n \"resmsgid\": \"3b9e5980-3df4-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"3b9cabd0-3df4-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"publishStatus\": \"Publish Operation for Framework Id 'dummy_framework' Started Successfully!\"\n }\n}"},{"id":"41c2ff4c-d2e6-427f-9573-783902a73fc5","name":"BAD REQUEST. The \"Publish Framework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/publish/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","publish",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be published"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.publish\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:08:19.872Z\",\n \"params\": {\n \"resmsgid\": \"4aa73a00-3df4-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_FRAMEOWRK_ID\",\n \"errmsg\": \"Invalid Framework Id. Framework doesn't exist.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"3f22d27f-4e52-459a-9b09-2fb4e8182893","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/publish/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","publish",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be published"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eb30e906-51f6-4aa1-9161-0a58b0c2126e"},{"name":"Copy Framework","id":"0b58c5e8-2e34-4514-9de1-53b0751426ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

(Required) It is the Unique Id to identify the root organisation to which the user belongs

\n","key":"X-Channel-Id","value":"Ut enim offici"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"code\": \"NCERTCOPY11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/copy/:ID","description":"

This API is associated with copying a framework

\n
    \n
  • The endpoint for Copy Framework is /framework/v1/copy/{ID}
    • \n
  • It points to knowledge-mw-service - v1/framework/copy/{ID}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","copy",":ID"],"host":["https://staging.open-sunbird.org/api"],"query":[],"variable":[{"id":"3260b904-9653-4c49-8c5a-e953126da680","description":{"content":"

(Required) The identifier of the framework to be copied

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"ID"}]}},"response":[{"id":"842cdf27-bbbf-4b09-9a8e-0593e3333edc","name":"OK ! Successful operation.\"Copy framework\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"code\": \"NCERTCOPY11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/copy/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","copy",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be copied"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.copy\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:46:44.287Z\",\n \"params\": {\n \"resmsgid\": \"a8310cf0-3df9-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"a6b2aa50-3df9-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"NCERTCOPY11\"\n }\n}"},{"id":"9763d1ee-2a05-4b57-86d4-3014f78661a6","name":"BAD REQUEST. The \"Copy fFramework\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"code\": \"NCERTCOPY11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/copy/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","copy",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be copied"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.copy\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:47:22.578Z\",\n \"params\": {\n \"resmsgid\": \"bf03cb20-3df9-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_FRAMEWORK_EXISTS\",\n \"errmsg\": \"Framework with code: NCERTCOPY11, already exists.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"454ab0bf-6f83-42f6-b851-6335aaa23226","name":"RESOURCE NOT FOUND. The \"Copy fFramework\" operation failed ! The possible reason for failure is that you may have missed invlalid framework id.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"code\": \"NCERTCOPY11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/copy/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","copy",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be copied"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.framework.copy\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T10:47:47.865Z\",\n \"params\": {\n \"resmsgid\": \"ce164890-3df9-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_DATA_NOT_FOUND\",\n \"errmsg\": \"Data not found with id : NCERT101100\"\n },\n \"responseCode\": \"RESOURCE_NOT_FOUND\",\n \"result\": {}\n}"},{"id":"4996649f-1878-4977-89e1-44e226ce3084","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"},{"description":"(Required) It is the Unique Id to identify the root organisation to which the user belongs","key":"X-Channel-Id","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"framework\": {\n \"code\": \"NCERTCOPY11\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/copy/:ID","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","copy",":ID"],"variable":[{"key":"ID","value":"Ut enim offici","description":"(Required) The identifier of the framework to be copied"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0b58c5e8-2e34-4514-9de1-53b0751426ec"}],"id":"7915a400-e880-40af-80e1-ce1b84e6c9d7","_postman_id":"7915a400-e880-40af-80e1-ce1b84e6c9d7","description":""},{"name":"category","item":[{"name":"Create Category","id":"7b07da54-506c-410e-a263-63d3b5522f38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"name\": \"Subject\",\n \"code\": \"subject\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/category/create?framework=Ut enim offici","description":"

This API is associated with creating a category under a framework

\n
    \n
  • The endpoint for Create Category is /framework/v1/category/create
    • \n
  • It points to knowledge-mw-service - /v1/framework/category/create
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","category","create"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) The code of the framework under which category has to be created

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"}],"variable":[]}},"response":[{"id":"27d8b1cb-9aae-4cb9-801b-af1f6c5d5753","name":"OK ! Successful operation.\"create category\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"name\": \"Subject\",\n \"code\": \"subject\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/create?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","create"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:32:01.754Z\",\n \"params\": {\n \"resmsgid\": \"0a10dba0-3e43-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"0a05df20-3e43-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"dummy_framework_medium\",\n \"versionKey\": \"1607974321700\"\n }\n}"},{"id":"b4b5ca9a-d91b-4e05-b34c-590a9fadeae8","name":"BAD REQUEST. The \"create category\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"name\": \"Subject\",\n \"code\": \"subject\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/create?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","create"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:30:50.114Z\",\n \"params\": {\n \"resmsgid\": \"df5d7620-3e42-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"CONSTRAINT_VALIDATION_FAILED\",\n \"errmsg\": \"Object already exists with identifier: dummy_framework_subject\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"3dc4b85f-0cc6-4f79-8646-15d9807eb5c3","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"name\": \"Subject\",\n \"code\": \"subject\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/create?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","create"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7b07da54-506c-410e-a263-63d3b5522f38"},{"name":"Fetch Category","id":"b0f45dd1-dd24-47d5-8800-e544a2cf7d50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://staging.open-sunbird.org/api/framework/v1/category/read/:code?framework=Ut enim offici","description":"

This API is associated with fetching a category on Sunbird Platform

\n
    \n
  • The endpoint for Fetch Category is /framework/v1/category/read/{code}
    • \n
  • It points to knowledge-mw-service - /v1/framework/category/read/{code}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","category","read",":code"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Name of the framework under which category exists. Its an abstract data structure which serves as a template for categories and terms

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"}],"variable":[{"id":"0761f9c8-3c5a-474a-a4b7-13e9a2a406ae","description":{"content":"

(Required) The name/code of the category to be fetched

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"code"}]}},"response":[{"id":"40a6c218-af7a-4e08-aaca-f322da255f69","name":"OK ! Successful operation.\"fetch category\" operation was successfully executed.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/read/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:34:41.261Z\",\n \"params\": {\n \"resmsgid\": \"6923b1d0-3e43-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"691e3390-3e43-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"category\": {\n \"identifier\": \"dummy_framework_subject\",\n \"lastStatusChangedOn\": \"2020-12-14T19:30:32.392+0000\",\n \"code\": \"subject\",\n \"frameworks\": [\n {\n \"identifier\": \"dummy_framework\",\n \"name\": \"Framework Name\",\n \"objectType\": \"Framework\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Dumy framework updated\",\n \"status\": \"Live\"\n }\n ],\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"channel\": \"in.ekstep\",\n \"description\": \"Subject\",\n \"domains\": [],\n \"createdOn\": \"2020-12-14T19:30:32.392+0000\",\n \"versionKey\": \"1607974232392\",\n \"terms\": [],\n \"appId\": \"@ignore@\",\n \"name\": \"Subject\",\n \"lastUpdatedOn\": \"2020-12-14T19:30:32.392+0000\",\n \"status\": \"Live\"\n }\n }\n}"},{"id":"cab53396-9908-411f-8574-6e16a9392e70","name":"BAD REQUEST. The \"fetch category\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/read/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be fetched"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:35:21.540Z\",\n \"params\": {\n \"resmsgid\": \"8125c840-3e43-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_FRAMEWORK_ID\",\n \"errmsg\": \"Invalid FrameworkId: dummy_framework1 for Categoryinstance \"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"ef7744df-33ae-4b96-8bf1-aa040f29bb82","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/read/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be fetched"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b0f45dd1-dd24-47d5-8800-e544a2cf7d50"},{"name":"Update Category","id":"fbf475f8-da2c-48c3-aa7f-604f136579fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"description\": \"Updated description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/category/update/:code?framework=Ut enim offici","description":"

This API is associated with updating a category in an existing framework

\n
    \n
  • The endpoint for Update Category is /framework/v1/category/update/{code}
    • \n
  • It points to knowledge-mw-service - /v1/framework/category/update/{code}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","category","update",":code"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework to which the category belongs

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"}],"variable":[{"id":"2344ac38-c307-46d5-918f-18b98044e950","description":{"content":"

(Required) The name/code of the category to be updated

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"code"}]}},"response":[{"id":"26903e79-878e-439a-963a-88780bf2b86d","name":"OK ! Successful operation.\"update category\" operation was successfully executed.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"description\": \"Updated description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/update/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","update",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:37:49.082Z\",\n \"params\": {\n \"resmsgid\": \"d916e7a0-3e43-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"d90f4680-3e43-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"dummy_framework_subject\",\n \"versionKey\": \"1607974669043\"\n }\n}"},{"id":"e030cc32-43f4-4e94-bea8-a355c1597548","name":"BAD REQUEST. The \"update category\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"description\": \"Updated description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/update/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","update",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be updated"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:38:29.662Z\",\n \"params\": {\n \"resmsgid\": \"f146ebe0-3e43-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_FRAMEWORK_ID\",\n \"errmsg\": \"Invalid FrameworkId: dummy_framework1 for Categoryinstance \"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"497b363e-db4d-44c8-902e-ca1ad2c86342","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"category\": {\n \"description\": \"Updated description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/update/:code?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","update",":code"],"query":[{"key":"framework","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the category to be updated"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fbf475f8-da2c-48c3-aa7f-604f136579fa"},{"name":"Search Categories","id":"05fbbed0-a6c7-4e26-842b-a927f12cd137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/category/search?framework=Ut enim offici","description":"

This API is associated with searching a category

\n
    \n
  • The endpoint for Search Categories is /framework/v1/category/search
    • \n
  • It points to knowledge-mw-service - /v1/framework/category/search
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","category","search"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework in which category can be searched

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"}],"variable":[]}},"response":[{"id":"50c274dc-2c5b-4aaf-a808-5c764e115b94","name":"OK ! Successful operation.\"search category\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/search?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","search"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.search\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:40:23.864Z\",\n \"params\": {\n \"resmsgid\": \"3558c380-3e44-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"3555b640-3e44-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"count\": 2,\n \"categories\": [\n {\n \"identifier\": \"dummy_framework_subject\",\n \"lastStatusChangedOn\": \"2020-12-14T19:30:32.392+0000\",\n \"code\": \"subject\",\n \"frameworks\": [\n {\n \"identifier\": \"dummy_framework\",\n \"name\": \"Framework Name\",\n \"objectType\": \"Framework\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Dumy framework updated\",\n \"status\": \"Live\"\n }\n ],\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"channel\": \"in.ekstep\",\n \"description\": \"Updated description\",\n \"domains\": [],\n \"createdOn\": \"2020-12-14T19:30:32.392+0000\",\n \"versionKey\": \"1607974669043\",\n \"terms\": [],\n \"appId\": \"dev.sunbird.portal\",\n \"name\": \"Subject\",\n \"lastUpdatedOn\": \"2020-12-14T19:37:49.043+0000\",\n \"status\": \"Live\"\n },\n {\n \"identifier\": \"dummy_framework_medium\",\n \"lastStatusChangedOn\": \"2020-12-14T19:32:01.700+0000\",\n \"code\": \"medium\",\n \"frameworks\": [\n {\n \"identifier\": \"dummy_framework\",\n \"name\": \"Framework Name\",\n \"objectType\": \"Framework\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Dumy framework updated\",\n \"status\": \"Live\"\n }\n ],\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"channel\": \"in.ekstep\",\n \"description\": \"Medium\",\n \"domains\": [],\n \"createdOn\": \"2020-12-14T19:32:01.700+0000\",\n \"versionKey\": \"1607974321700\",\n \"terms\": [],\n \"appId\": \"@ignore@\",\n \"name\": \"Medium\",\n \"lastUpdatedOn\": \"2020-12-14T19:32:01.700+0000\",\n \"status\": \"Live\"\n }\n ]\n }\n}"},{"id":"a9b80923-d986-4c26-abba-7d07c8d27f1c","name":"BAD REQUEST. The \"search category\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/search?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","search"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.category.search\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:41:28.846Z\",\n \"params\": {\n \"resmsgid\": \"5c143ae0-3e44-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_FRAMEWORK_ID\",\n \"errmsg\": \"Invalid FrameworkId: dummy_framework1 for Categoryinstance \"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"714b427c-61b0-495b-95f1-76542f4e5800","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"search\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/category/search?framework=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","category","search"],"query":[{"key":"framework","value":"Ut enim offici"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"05fbbed0-a6c7-4e26-842b-a927f12cd137"}],"id":"3fa134ba-a261-4c2c-98bb-4fad8e8678d3","_postman_id":"3fa134ba-a261-4c2c-98bb-4fad8e8678d3","description":""},{"name":"term","item":[{"name":"Create Term","id":"43c4fb52-a4d6-486c-beec-6c262571bf4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"code\": \"english\",\n \"name\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/term/create?framework=Ut enim offici&category=Ut enim offici","description":"

This API is associated with creating a term under a framework category

\n
    \n
  • The endpoint for Create Term is /framework/v1/term/create
    • \n
  • It points to knowledge-mw-service - /v1/framework/term/create
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.\"
    • \n
\n","urlObject":{"path":["framework","v1","term","create"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework in which the term is to be created

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"},{"description":{"content":"

(Required) Represents the category in which the term is to be created

\n","type":"text/plain"},"key":"category","value":"Ut enim offici"}],"variable":[]}},"response":[{"id":"51e04dbc-570a-40a7-929a-65c074487e5b","name":"OK ! Successful operation.\"create term\" operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"code\": \"english\",\n \"name\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/create?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","create"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:44:02.348Z\",\n \"params\": {\n \"resmsgid\": \"b792c6c0-3e44-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"b783f9b0-3e44-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": [\n \"dummy_framework_subject_english\"\n ]\n }\n}"},{"id":"0b70c8ca-955a-4cf7-9035-5800da20d8d2","name":"BAD REQUEST. The \"create term\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"code\": \"english\",\n \"name\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/create?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","create"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.create\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:44:49.263Z\",\n \"params\": {\n \"resmsgid\": \"d3896ff0-3e44-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_CATEGORY_ID\",\n \"errmsg\": \"Please provide valid category.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"ae689061-6693-42db-b191-f5cf618ec18f","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"code\": \"english\",\n \"name\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/create?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","create"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"43c4fb52-a4d6-486c-beec-6c262571bf4a"},{"name":"Fetch Term","id":"ad0a76cb-4e31-4a8c-b472-de365af2de11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://staging.open-sunbird.org/api/framework/v1/term/read/:code?framework=Ut enim offici&category=Ut enim offici","description":"

This API is associated with fetching the available terms under a specific category and a framework on Sunbird Platform.

\n
    \n
  • The endpoint for Fetch Term is /framework/v1/term/read/{code}
    • \n
  • It points to knowledge-mw-service - /v1/framework/term/read/{code}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","term","read",":code"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework id in which the term can be fetched

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"},{"description":{"content":"

(Required) Represents the category in which the term can be fetched

\n","type":"text/plain"},"key":"category","value":"Ut enim offici"}],"variable":[{"id":"00758036-f5d3-48fc-b362-71132c0278f7","description":{"content":"

(Required) The name/code of the term to be fetched

\n","type":"text/plain"},"type":"any","value":"Ut enim offici","key":"code"}]}},"response":[{"id":"cd84a232-2a60-45ae-9225-87eedb8a0b64","name":"OK ! Successful operation.\"Fetch term\" operation was successfully executed.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/read/:code?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the term to be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-17T07:24:51.258Z\",\n \"params\": {\n \"resmsgid\": \"f380c1a0-4038-11eb-9b0c-abcfbdf41bc3\",\n \"msgid\": \"f358c740-4038-11eb-9b0c-abcfbdf41bc3\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"term\": {\n \"associations\": [],\n \"identifier\": \"dummy_framework_subject_english\",\n \"lastStatusChangedOn\": \"2020-12-14T19:44:02.260+0000\",\n \"code\": \"english\",\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"channel\": \"in.ekstep\",\n \"description\": \"English\",\n \"createdOn\": \"2020-12-14T19:44:02.260+0000\",\n \"versionKey\": \"1607975299669\",\n \"children\": [],\n \"appId\": \"dev.sunbird.portal\",\n \"name\": \"English\",\n \"lastUpdatedOn\": \"2020-12-14T19:48:19.669+0000\",\n \"categories\": [\n {\n \"identifier\": \"dummy_framework_subject\",\n \"name\": \"Subject\",\n \"objectType\": \"CategoryInstance\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Updated description\",\n \"status\": \"Live\"\n }\n ],\n \"category\": \"subject\",\n \"status\": \"Live\"\n }\n }\n}"},{"id":"c024f9db-1496-4849-b8f1-c51a4acb0369","name":"BAD REQUEST. The \"Fetch term\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/read/:code?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the term to be fetched"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.read\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-17T07:54:24.246Z\",\n \"params\": {\n \"resmsgid\": \"14494160-403d-11eb-9b0c-abcfbdf41bc3\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_CATEGORY_ID\",\n \"errmsg\": \"Please provide valid category.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"51ffb265-f164-4722-90a5-8b390f7ce7de","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"The Content Type entity is the media type of the resource.\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/read/:code?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","read",":code"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}],"variable":[{"key":"code","value":"Ut enim offici","description":"(Required) The name/code of the term to be fetched"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ad0a76cb-4e31-4a8c-b472-de365af2de11"},{"name":"Update Term","id":"f16ade99-c9cd-4055-a251-5d8c996e3258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"name\": \"English\",\n \"description\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/term/updateUt enim offici?framework=Ut enim offici&category=Ut enim offici","description":"

This API is associated with updating a term under a category in a framework on Sunbird Platform

\n
    \n
  • The endpoint for Update Term is /framework/v1/term/update{code}
    • \n
  • It points to knowledge-mw-service - /v1/framework/term/update/{code}
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","term","updateUt enim offici"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework in which the terms is to be updated

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"},{"description":{"content":"

(Required) Represents the category in which the term is to be updated

\n","type":"text/plain"},"key":"category","value":"Ut enim offici"}],"variable":[]}},"response":[{"id":"5c14cb4b-1fdd-4cb4-a73f-e3847a43c58c","name":"OK ! Successful operation.\"update term\" operation was successfully executed.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.'","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"name\": \"English\",\n \"description\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/updateUt enim offici?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","updateUt enim offici"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:48:19.754Z\",\n \"params\": {\n \"resmsgid\": \"50ffd0a0-3e45-11eb-9ff3-67c41480f6aa\",\n \"msgid\": \"50f04040-3e45-11eb-9ff3-67c41480f6aa\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"node_id\": \"dummy_framework_subject_english\",\n \"versionKey\": \"1607975299669\"\n }\n}"},{"id":"4390b90e-a526-4035-ad0b-498ec7e57a55","name":"BAD REQUEST. The \"update term\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.'","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"name\": \"English\",\n \"description\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/updateUt enim offici?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","updateUt enim offici"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.update\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-14T19:49:03.927Z\",\n \"params\": {\n \"resmsgid\": \"6b541470-3e45-11eb-9ff3-67c41480f6aa\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_CATEGORY_ID\",\n \"errmsg\": \"Please provide valid category.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"83542297-405a-40c8-9f86-a0d0cc9016d2","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(Required) The Content Type entity is the media type of the resource\n Possible media types can be:- \n - application/json","key":"Content-Type","value":"Ut enim offici"},{"description":"(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.'","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"term\": {\n \"name\": \"English\",\n \"description\": \"English\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/updateUt enim offici?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","updateUt enim offici"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f16ade99-c9cd-4055-a251-5d8c996e3258"},{"name":"Search Term","id":"1770618a-936f-4014-be98-25dd34fa96e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.open-sunbird.org/api/framework/v1/term/search?framework=Ut enim offici&category=Ut enim offici","description":"

This API is associated with searching the existing terms under a category in a framework on Sunbird Platform

\n
    \n
  • The endpoint for Search Term is /framework/v1/term/search
    • \n
  • It points to knowledge-mw-service - /v1/framework/term/search
    • \n
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
    • \n
\n","urlObject":{"path":["framework","v1","term","search"],"host":["https://staging.open-sunbird.org/api"],"query":[{"description":{"content":"

(Required) Represents the framework in which the term is to be searched

\n","type":"text/plain"},"key":"framework","value":"Ut enim offici"},{"description":{"content":"

(Required) Represents the category in which the term is to be searched

\n","type":"text/plain"},"key":"category","value":"Ut enim offici"}],"variable":[]}},"response":[{"id":"27217cdd-b5f9-4d61-917d-9224f27936b3","name":"OK ! Successful operation.\"Search term operation was successfully executed.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/search?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","search"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.search\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-17T08:12:44.816Z\",\n \"params\": {\n \"resmsgid\": \"a446e900-403f-11eb-9b0c-abcfbdf41bc3\",\n \"msgid\": \"a4447800-403f-11eb-9b0c-abcfbdf41bc3\",\n \"status\": \"successful\",\n \"err\": null,\n \"errmsg\": null\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"terms\": [\n {\n \"associations\": [],\n \"identifier\": \"dummy_framework_subject_english\",\n \"lastStatusChangedOn\": \"2020-12-14T19:44:02.260+0000\",\n \"code\": \"english\",\n \"consumerId\": \"7411b6bd-89f3-40ec-98d1-229dc64ce77d\",\n \"channel\": \"in.ekstep\",\n \"description\": \"English\",\n \"createdOn\": \"2020-12-14T19:44:02.260+0000\",\n \"versionKey\": \"1607975299669\",\n \"children\": [],\n \"appId\": \"dev.sunbird.portal\",\n \"name\": \"English\",\n \"lastUpdatedOn\": \"2020-12-14T19:48:19.669+0000\",\n \"categories\": [\n {\n \"identifier\": \"dummy_framework_subject\",\n \"name\": \"Subject\",\n \"objectType\": \"CategoryInstance\",\n \"relation\": \"hasSequenceMember\",\n \"description\": \"Updated description\",\n \"status\": \"Live\"\n }\n ],\n \"category\": \"subject\",\n \"status\": \"Live\"\n }\n ],\n \"count\": 1\n }\n}"},{"id":"19a779ec-1cda-44da-bf0b-1a7fe70bc60a","name":"BAD REQUEST. The \"search term\" operation failed ! The possible reason for failure is that you may have missed providing input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/search?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","search"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.term.search\",\n \"ver\": \"1.0\",\n \"ts\": \"2020-12-17T08:13:50.811Z\",\n \"params\": {\n \"resmsgid\": \"cb9cf2b0-403f-11eb-9b0c-abcfbdf41bc3\",\n \"msgid\": null,\n \"status\": \"failed\",\n \"err\": \"ERR_INVALID_CATEGORY_ID\",\n \"errmsg\": \"Please provide valid category.\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {}\n}"},{"id":"af77ecc9-f3c9-4bc4-b7ec-e6e7b0f6f939","name":"INTERNAL SERVER ERROR ! Looks like something went wrong! These errors are tracked automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"description":"(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.","key":"Authorization","value":"Ut enim offici"}],"body":{"mode":"raw","raw":"{\n \"request\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://staging.open-sunbird.org/api/framework/v1/term/search?framework=Ut enim offici&category=Ut enim offici","host":["https://staging.open-sunbird.org/api"],"path":["framework","v1","term","search"],"query":[{"key":"framework","value":"Ut enim offici"},{"key":"category","value":"Ut enim offici"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1770618a-936f-4014-be98-25dd34fa96e6"}],"id":"ccb48455-9569-41e3-9c71-0076130f626d","_postman_id":"ccb48455-9569-41e3-9c71-0076130f626d","description":""}],"id":"2985d446-cd84-497a-b7dd-d965be66c6bf","_postman_id":"2985d446-cd84-497a-b7dd-d965be66c6bf","description":""}],"variable":[{"key":"baseUrl","value":"https://staging.open-sunbird.org/api","type":"string"},{"key":"code","value":"Ut enim offici","type":"any","description":"(Required) The name/code of the term to be update"}]}