Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction:

...

{
     "request": {
          "itemset": {
               "code":"",
               "title":"",
               "description":"",
               "language":["English"],
               "max_score":10,
               "type":"materialised",
               "owner":"",
               "difficulty_level":"",
               "purpose": "",
               "sub_purpose":"",
               "depth_of_knowledge": "",
               "used_for":"",
               "copyright":"",
               "createdBy":"",
               "assessmentItem":[{
                    "identifier":"assessmentItem_id"
               }]
          }
     }
}

Response:
{
    "id""api.itemset.create",
    "ver""1.0",
    "ts""2019-12-17T06:40:34ZZ",
    "params": {
        "resmsgid""d4f8a3be-85fa-453d-83c4-3f17da9dc27c",
        "msgid""a2a0f82d-2e85-4133-9f39-fd5d0e8409bb",
        "err"null,
        "status""successful",
        "errmsg"null
    },
    "responseCode""OK",
    "result": {
        "identifier""do_1129152191260999681109",
        "versionKey""123456789",
    }
}
Update Item set:
PATCH: itemset/v3/update/{identifier}

{
     "request": {
          "itemset": {
               "title":"",
               "description":"",
               "language":["English"],
               "max_score":10,
               "type":"materialised",
               "owner":"",
               "difficulty_level":"",
               "purpose": "",
               "sub_purpose":"",
               "depth_of_knowledge": "",
               "used_for":"",
               "copyright":"",
               "createdBy":"",
               "assessmentItem":[{
                    "identifier":"assessmentItem_id"
               }]
          }
     }
}

Response:
{
    "id""api.itemset.update",
    "ver""1.0",
    "ts""2019-12-17T06:40:34ZZ",
    "params": {
        "resmsgid""d4f8a3be-85fa-453d-83c4-3f17da9dc27c",
        "msgid""a2a0f82d-2e85-4133-9f39-fd5d0e8409bb",
        "err"null,
        "status""successful",
        "errmsg"null
    },
    "responseCode""OK",
    "result": {
        "identifier""do_1129152191260999681109",
        "versionKey""123456789",
    }
}
Read Item set:
GET: itemset/v3/read/{identifer}
Response:
{
    "id""api.itemset.read",
    "ver""1.0",
    "ts""2019-12-17T06:40:34ZZ",
    "params": {
        "resmsgid""d4f8a3be-85fa-453d-83c4-3f17da9dc27c",
        "msgid""a2a0f82d-2e85-4133-9f39-fd5d0e8409bb",
        "err"null,
        "status""successful",
        "errmsg"null
    },
    "responseCode""OK",
    "result": {
        "itemset": {
                "identifier": "",
                   "title":"",
               "description":"",
               "language":["English"],
               "max_score":10,
               "type":"materialised",
               "owner":"",
               "difficulty_level":"",
               "purpose": "",
               "sub_purpose":"",
               "depth_of_knowledge": "",
               "used_for":"",
               "copyright":"",
               "createdBy":"",
               "versionKey":"",
               "assessmentItem":[{
                    "identifier":"assessmentItem_id"
               }]
         }
    }
}

DELETE: itemset/v3/retire/{identifier}
{}

Response:

{
    "id""api.itemset.retire",
    "ver""1.0",
    "ts""2019-12-17T06:40:34ZZ",
    "params": {
        "resmsgid""d4f8a3be-85fa-453d-83c4-3f17da9dc27c",
        "msgid""a2a0f82d-2e85-4133-9f39-fd5d0e8409bb",
        "err"null,
        "status""successful",
        "errmsg"null
    },
    "responseCode""OK",
    "result": {
        "identifier""do_1129152191260999681109"
    }
}

Item set Publish API:

...