API Functionality | HTTP Error Code | Existing Error Response | Proposed Error Response |
---|
Question Create | 404 Not Found | API Functionality | HTTP Error Code | Existing Error ResponseProposed Error Response |
---|
Question Create | 400 Bad Request | Code Block |
---|
{
"id": "api.question.create",
"ver": "3.0",
"ts": "2023-05-14T14:27:33ZZ",
"params": {
"resmsgid": "c34e2d4f-779b-49fc-9d6a-db4466c8de3a",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata name not set"
]
}
} |
| Question Create | 400 Bad Request | Code Block |
---|
{
"id": "api.question.create",
"ver": "3.0",
"ts": "2023-05-14T14:2726:33ZZ17ZZ",
"params": {
"resmsgid": "c34e2d4fe45e51ca-779b8c4e-49fc4585-9d6aab03-db4466c8de3a75ab8b131bb5",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"errorsmessages": [
{
"identifier": "name",
"message": "Required Metadata namecode not set"
}
]
}
} |
| Question Create | 400 Bad Request | Code Block |
---|
{
"id": "api.question.create",
"ver": "3.0",
"ts": "2023-05-14T14:26:17ZZ27ZZ",
"params": {
"resmsgid": "e45e51ca0020dd04-8c4e65ad-45854e8a-ab039194-75ab8b131bb5bb927025d3e0",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata codemimeType not set"
]
}
} |
| Question Create | 400 Bad Request | Code Block |
---|
{
"id": "api.question.create",
"ver": "3.0",
"ts": "2023-05-14T14:2651:27ZZ49ZZ",
"params": {
"resmsgid": "0020dd043814749d-65ad47a0-4e8a4e38-9194a040-bb927025d3e06d32e8e4cbcf",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata mimeTypeprimaryCategory not set"
]
}
} |
| Question Create | 400 Bad Request | Code Block |
---|
{
"id": "api.question.create",
"ver": "3.0",
"ts": "2023-05-14T14:5126:49ZZ35ZZ",
"params": {
"resmsgid": "3814749d4ab85c6e-47a03ee4-4e384dc3-a040bcbf-6d32e8e4cbcf0292b734dfdc",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata primaryCategory not setMetadata mimeType should be one of: [application/vnd.sunbird.question]"
]
}
} |
| Question CreateUpdate | 400 Bad Request | Code Block |
---|
{
"id": "api.question.createupdate",
"ver": "3.0",
"ts": "2023-05-14T14:2629:35ZZ03ZZ",
"params": {
"resmsgid": "4ab85c6ed43a4913-3ee4d662-4dc34a8a-bcbf8859-0292b734dfdc9add9a04da52",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "ValidationInvalid version ErrorsKey"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Metadata mimeType should be one of: [application/vnd.sunbird.question]"null
]
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"id": "api.question.createreview",
"ver": "3.0",
"ts": "2023-05-14T14:2630:35ZZ20ZZ",
"params": {
"resmsgid": "4ab85c6efd89269b-3ee436f9-4dc34673-bcbf8af4-0292b734dfdcdb41b5f60716",
"msgid": null,
"err": "CLIENT_ERRORERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Validation ErrorsMandatory Fields [body] Missing for do_21379593928588492814142"
},
"responseCode": "CLIENT_ERROR",
"result": {
"errorsmessages": [null
{
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"identifierid": "mimeTypeapi.question.review",
"message": "Metadata mimeType should be one of: [application/vnd.sunbird.question]"
}
]
}
} |
| Question Update | 400 Bad Request | Code Block |
---|
{
"id": "api.question.update",
"ver": "3.0",
"ts": "2023-05-14T14:29:03ZZ",
"params": {
"resmsgid": "d43a4913-d662-4a8a-8859-9add9a04da52",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Invalid version Key"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Code Block |
---|
{
"id": "api.question.update",
"ver": "3.0",
"ts": "2023-05-14T14:29:03ZZ",
"params": {
"resmsgid": "d43a4913-d662-4a8a-8859-9add9a04da52",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Invalid version Key"
},
"responseCode": "CLIENT_ERROR",
"result": {
"errors": [
{
"identifier": "version key",
"message": "Invalid version Key"
}
]
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"id": "api.question.review",
"ver": "3.0",
"ts": "2023-05-14T14:30:20ZZ",
"params": {
"resmsgid": "fd89269b-36f9-4673-8af4-db41b5f60716",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [body] Missing for do_21379593928588492814142"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Code Block |
---|
{
"id": "api.question.review",
"ver": "3.0",
"ts": "2023-05-14T14:30:20ZZ",
"params": {
"resmsgid": "fd89269b-36f9-4673-8af4-db41b5f60716",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [body] Missing for do_21379593928588492814142"
},
"responseCode": "CLIENT_ERROR",
"result": {
"errors": [
{
"identifier": "body",
"message": "Mandatory Fields [body] Missing for do_21379593928588492814142"
}
]
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"id": "api.question.review",
"ver": "3.0",
"ts": "2023-05-14T14:30:24ZZ",
"params": {
"resmsgid": "851c2874-e6fe-42b0-8c4f-67c234154bc8",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [responseDeclaration] Missing for do_21379593932446105614143"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"id": "api.question.review",
""ver": "3.0",
"ts": "2023-05-14T14:30:29ZZ24ZZ",
"params": {
"resmsgid": "23ee2a5c851c2874-6ad7e6fe-4bae42b0-80c28c4f-94d42f82546d67c234154bc8",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [interactionsresponseDeclaration] Missing for do_2137959393616855041414421379593932446105614143"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Review | 400 Bad Request | Code Block |
---|
{
"id": "api.question.review",
"ver": "3.0",
"ts": "2023-05-14T14:30:34ZZ29ZZ",
"params": {
"resmsgid": "3de1955f23ee2a5c-c4806ad7-49034bae-ba1780c2-05e59cf2dc4394d42f82546d",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [answerinteractions] Missing for do_2137959394028257281414521379593936168550414144"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question PublishReview | 400 Bad Request | Code Block |
---|
{
"id": "api.question.publishreview",
"ver": "3.0",
"ts": "2023-05-14T14:30:56ZZ34ZZ",
"params": {
"resmsgid": "3c82e7653de1955f-b5e0c480-4fec4903-8e5eba17-87d66f60b32305e59cf2dc43",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [bodyanswer] Missing for do_2137959395871703041414621379593940282572814145"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Publish | 400 Bad Request | Code Block |
---|
{
"id": "api.question.publish",
"ver": "3.0",
"ts": "2023-05-14T14:3130:00ZZ56ZZ",
"params": {
"resmsgid": "e54e1b923c82e765-98a8b5e0-46bb4fec-a27c8e5e-f9790dffd71387d66f60b323",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [responseDeclarationbody] Missing for do_2137959396195532801414721379593958717030414146"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Publish | 400 Bad Request | Code Block |
---|
{
"id": "api.question.publish",
"ver": "3.0",
"ts": "2023-05-14T14:31:04ZZ00ZZ",
"params": {
"resmsgid": "80ab8746e54e1b92-845598a8-4d6246bb-9bf9a27c-886bd38851d8f9790dffd713",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [interactionsresponseDeclaration] Missing for do_2137959396466360321414821379593961955328014147"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Publish | 400 Bad Request | Code Block |
---|
{
"id": "api.question.publish",
"ver": "3.0",
"ts": "2023-05-14T14:31:07ZZ04ZZ",
"params": {
"resmsgid": "7ec01a2a80ab8746-3e358455-46d74d62-83859bf9-0dcc81780708886bd38851d8",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [answerinteractions] Missing for do_2137959396755292161414921379593964663603214148"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question ListPublish | 400 Bad Request | Code Block |
---|
{
"id": "api.questionsquestion.listpublish",
"ver": "3.0",
"ts": "2023-05-14T14:31:29ZZ07ZZ",
"params": {
"resmsgid": "f76b3bb27ec01a2a-05f03e35-428a46d7-b0ee8385-113609f12b6f0dcc81780708",
"msgid": null,
"err": "ERR_BADMANDATORY_FIELD_REQUESTVALIDATION",
"status": "failed",
"errmsg": "RequestMandatory containsFields invalid[answer] identifiersMissing :for [do_list_abc_123].21379593967552921614149"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question List | 400 Bad Request | Code Block |
---|
{
"id": "api.questions.list",
"ver": "3.0",
"ts": "2023-05-14T14:31:34ZZ29ZZ",
"params": {
"resmsgid": "9edb0e68f76b3bb2-8a1505f0-4219428a-a92ab0ee-902efcc786ee113609f12b6f",
"msgid": null,
"err": "ERR_BAD_REQUEST",
"status": "failed",
"errmsg": "Request contains invalid identifiers : [do_list_abc_234, do_list_abc_123]."
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question ImportList | 400 Bad Request | Code Block |
---|
{
"id": "api.questionquestions.importlist",
"ver": "3.0",
"ts": "2023-05-14T14:3231:00ZZ34ZZ",
"params": {
"resmsgid": "b71e805f9edb0e68-53418a15-4e564219-93eda92a-9f57fd293864902efcc786ee",
"msgid": null,
"err": "ERR_REQUIREDBAD_PROPS_VALIDATIONREQUEST",
"status": "failed",
"errmsg": "Validation Failed! Mandatory Properties Are [\"name\",\"code\",\"mimeType\",\"framework\",\"channel\"] | Required Property's Missing For [fb1aef22-88e4-4f91-8055-6086bf338bf1]",
"errmsg": "Request contains invalid identifiers : [do_list_abc_234, do_list_abc_123]."
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question Import | 400 Bad Request | Code Block |
---|
{
"id": "api.question.import",
"ver": "3.0",
"ts": "2023-05-14T14:32:09ZZ00ZZ",
"params": {
"resmsgid": "6a19eeecb71e805f-b7425341-40574e56-a78293ed-c5c1a6a736959f57fd293864",
"msgid": null,
"err": "ERR_READREQUIRED_PROPS_SOURCEVALIDATION",
"status": "failed",
"errmsg": "ReceivedValidation InvalidFailed! ResponseMandatory WhileProperties Reading Data From Source. Response Code is : RESOURCE_NOT_FOUNDAre [\"name\",\"code\",\"mimeType\",\"framework\",\"channel\"] | Required Property's Missing For [fb1aef22-88e4-4f91-8055-6086bf338bf1]"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| Question RejectImport | 400 Bad Request | Code Block |
---|
{
"id": "api.question.rejectimport",
"ver": "3.0",
"ts": "2023-05-14T14:32:19ZZ09ZZ",
"params": {
"resmsgid": "1acd73e66a19eeec-d400b742-492e4057-abf5a782-5654c3425934c5c1a6a73695",
"msgid": null,
"err": "ERR_QUESTIONREAD_REJECTSOURCE",
"status": "failed",
"errmsg": "Question is not in 'Review' state for identifier: do_21379594026542694414151Received Invalid Response While Reading Data From Source. Response Code is : RESOURCE_NOT_FOUND"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet CreateQuestion Reject | 400 Bad Request | Code Block |
---|
{
"id": "api.questionsetquestion.createreject",
"ver": "3.0",
"ts": "2023-05-14T14:32:44ZZ19ZZ",
"params": {
"resmsgid": "9ce43dcc1acd73e6-49c6d400-4b19492e-9285abf5-1e4019bfbf305654c3425934",
"msgid": null,
"err": "CLIENTERR_QUESTION_ERRORREJECT",
"status": "failed",
"errmsg": "Validation ErrorsQuestion is not in 'Review' state for identifier: do_21379594026542694414151"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [null
"Required Metadata name not set"
]
}
} |
| QuestionSet Create | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.create",
"ver": "3.0",
"ts": "2023-05-14T14:32:53ZZ44ZZ",
"params": {
"resmsgid": "6ac7f1cc9ce43dcc-a41a49c6-4bf44b19-a5f79285-49f16beece821e4019bfbf30",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata codename not set"
]
}
} |
| QuestionSet Create | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.create",
"ver": "3.0",
"ts": "2023-05-14T14:32:56ZZ53ZZ",
"params": {
"resmsgid": "6a4dc6276ac7f1cc-3593a41a-49d54bf4-adcfa5f7-d0c0a077cff649f16beece82",
"msgid": null,
"err": "CLIENT_ERROR",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata mimeTypecode not set"
]
}
} |
| QuestionSet Update | 200 OK | ?? | QuestionSet Update HierarchyCreate | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.hierarchy.updatecreate",
"ver": "3.0",
"ts": "2023-05-14T14:3332:44ZZ56ZZ",
"params": {
"resmsgid": "948bf8e06a4dc627-c33c3593-40ed49d5-8e69adcf-fdecace00b7dd0c0a077cff6",
"msgid": null,
"err": "ERR_INVALID_ROOT_IDCLIENT_ERROR",
"status": "failed",
"errmsg": "Please Provide Valid Root Node IdentifierValidation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null [
"Required Metadata mimeType not set"
]
}
} |
| QuestionSet Update | 200 OK | ?? | QuestionSet ReviewUpdate Hierarchy | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.reviewhierarchy.update",
"ver": "3.0",
"ts": "2023-05-14T14:3433:05ZZ44ZZ",
"params": {
"resmsgid": "f90d747b948bf8e0-be39c33c-4fad40ed-992c8e69-c5e2c8575806fdecace00b7d",
"msgid": null,
"err": "ERR_MANDATORYINVALID_FIELDROOT_VALIDATIONID",
"status": "failed",
"errmsg": "MandatoryPlease FieldsProvide [responseDeclaration]Valid MissingRoot forNode do_21379594112953548814163Identifier"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet PublishReview | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.publishreview",
"ver": "3.0",
"ts": "2023-05-14T14:34:33ZZ05ZZ",
"params": {
"resmsgid": "25552ef2f90d747b-1af5be39-4bbb4fad-80cb992c-d68b8f229b1fc5e2c8575806",
"msgid": null,
"err": "ERR_MANDATORY_FIELD_VALIDATION",
"status": "failed",
"errmsg": "Mandatory Fields [responseDeclaration] Missing for do_2137959413642608641416821379594112953548814163"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet RetirePublish | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.retirepublish",
"ver": "3.0",
"ts": "2023-05-14T14:3534:05ZZ33ZZ",
"params": {
"resmsgid": "b2e2a37025552ef2-dee41af5-47cb4bbb-8fe680cb-a250cdc70f7cd68b8f229b1f",
"msgid": null,
"err": "ERR_QUESTIONMANDATORY_SETFIELD_RETIREVALIDATION",
"status": "failed",
"errmsg": "QuestionSet with identifier :Mandatory Fields [responseDeclaration] Missing for do_21379594162091622414177 is already Retired.21379594136426086414168"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet RejectRetire | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.rejectretire",
"ver": "3.0",
"ts": "2023-05-14T14:3835:57ZZ05ZZ",
"params": {
"resmsgid": "ff2aac33b2e2a370-c257dee4-487a47cb-85a88fe6-b44a013e2f71a250cdc70f7c",
"msgid": null,
"err": "ERR_QUESTION_SET_REJECTRETIRE",
"status": "failed",
"errmsg": "QuestionSet iswith notidentifier in 'Review' state for identifier: do_21379594343893401614182: do_21379594162091622414177 is already Retired."
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet ImportReject | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.importreject",
"ver": "3.0",
"ts": "2023-05-14T14:3938:31ZZ57ZZ",
"params": {
"resmsgid": "b8a1999bff2aac33-5893c257-4ef5487a-801d85a8-b7c73813119fb44a013e2f71",
"msgid": null,
"err": "ERR_REQUIREDQUESTION_PROPSSET_VALIDATIONREJECT",
"status": "failed",
"errmsg": "Validation Failed! Mandatory Properties Are [\"name\",\"code\",\"mimeType\",\"framework\",\"channel\"] | Required Property's Missing For [4f85db76-f8c4-41d0-b45c-a8cadba2f618] "errmsg": "QuestionSet is not in 'Review' state for identifier: do_21379594343893401614182"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet Import | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.import",
"ver": "3.0",
"ts": "2023-05-14T14:39:36ZZ31ZZ",
"params": {
"resmsgid": "45cd3ffcb8a1999b-205e5893-44cd4ef5-8017801d-40804711aa2ab7c73813119f",
"msgid": null,
"err": "ERR_READREQUIRED_PROPS_SOURCEVALIDATION",
"status": "failed",
"errmsg": "ReceivedValidation InvalidFailed! ResponseMandatory WhileProperties Reading Data From Source. Response Code is : RESOURCE_NOT_FOUNDAre [\"name\",\"code\",\"mimeType\",\"framework\",\"channel\"] | Required Property's Missing For [4f85db76-f8c4-41d0-b45c-a8cadba2f618]"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet Add ChildrenImport | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.addimport",
"ver": "3.0",
"ts": "2023-05-14T14:39:44ZZ36ZZ",
"params": {
"resmsgid": "6f0aa0d245cd3ffc-6d4a205e-478844cd-8a228017-0c68d8bb841a40804711aa2a",
"msgid": null,
"err": "ERR_BADREAD_REQUESTSOURCE",
"status": "failed",
"errmsg": "children are mandatoryReceived Invalid Response While Reading Data From Source. Response Code is : RESOURCE_NOT_FOUND"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
| QuestionSet Remove Add Children | 400 Bad Request | Code Block |
---|
{
"id": "api.questionset.removeadd",
"ver": "3.0",
"ts": "2023-05-14T14:4039:01ZZ44ZZ",
"params": {
"resmsgid": "242d20066f0aa0d2-4e0e6d4a-49d84788-8edd8a22-725e68fd6a160c68d8bb841a",
"msgid": null,
"err": "ERR_BAD_REQUEST",
"status": "failed",
"errmsg": "children are mandatory"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
} |
|
|