Versions Compared

Old Version 7

changes.mady.by.user Amit Priyadarshi

Saved on

compared with

New Version Current

changes.mady.by.user Gauraw Kumar

Saved on

Key

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

Introduction:

...

Introduction:

Item set should be a collection of questions where questions will have hasSequenceMember relationship with the member questions. Content should have association relationship with Item set.

Background & Problem statement:

  • Currently content have association relationship with questions. And association relationship does not support index value.
  • Since content have association relationship with questions. And association relationship and question relationship does not have any index value, we are not able to render questions based on index value.
  • As per the existing Item set (V3) implementation, Item set is a collection of questions where all the questions are linked to Item set with hasMember relationship which does not support index value.
  • Since content and question relationship does not have any index value, we are not able to render questions based on index value.
  • As per the existing Item set (V3) implementation, Item set is a collection of questions where all the questions are linked to Item set with hasMember relationship which does not support index.

Design:

  • Item set will be a collection of questions where each question will be linked to Item set with hasSequenceMember relationship where each relationship will have one index value.
  • Instead of linking to each questions, Content should be linked to Itemset with associatiedTo relationship.
  • Content will have one-to-one relationship with Item set.
  • Support for Itemset schema version 2

Item Set V2 API:

Create Item set:
POST: itemset/v3/create

...

Design:

  • Item set will be a collection of questions where each question will be linked to Item set with hasSequenceMember relationship where each relationship will have one index value.
  • Instead of linking to each questions, Content should be linked to Itemset with associatiedTo relationship.
  • Content will have one-to-one relationship with Item set.
  • Support for Itemset schema version 2

Item Set V2 API:

Create Item set:
POST: itemset/v3/create

{
     "request": {
          "itemset": {
               "code":"",
               "title":"",
               "description":"",
               "language":["English"],
               "maxScore":10,
               "type":"materialised",
               "owner":"",
               "difficultyLevel":"",
               "purpose": "",
               "subPurpose":"",
               "codedepthOfKnowledge": "",
               "titleusedFor":"",
               "descriptioncopyright":"",
               "languagecreatedBy":["English"],
               "max_scoreitems":10,[{
                    "typeidentifier":"materialisedassessmentItem_id",
               "owner":"",}]
          }
     }
}

Response:
Update Item set:
PATCH: itemset/v3/update/{identifier}
{
     "request": {
          "itemset": {
{
    "id": 
 "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",
    }
}
"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"],
               "maxScore":10,
               "type":"materialised",
               "owner":"",
               "difficultyLevel":"",
               "purpose": "",
               "subPurpose":"",
               "depthOfKnowledge": "",
               "titleusedFor":"",
               "descriptioncopyright":"",
               "languagecreatedBy":["English"],
               "max_scoreitems":10,[{
                    "typeidentifier":"materialisedassessmentItem_id",
               "owner":"",}]
          }
     "difficulty_level}
}

Response:
{
    "id": "api.itemset.update",
    "ver": 
             "purpose": "",
               "sub_purpose":"",
               "depth_of_knowledge": "",
               "used_for":"",
               "copyright":"",
               "createdBy":"",
               "assessmentItem":[{
                    "identifier":"assessmentItem_id"
               }]
          }
     }
"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.
update
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": {
        "
identifier
itemset": 
"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"],
               "maxScore":10,
               "type":"materialised",
               "owner":"",
               "difficultyLevel":"",
               "purpose": "",
               "subPurpose":"",
               "depthOfKnowledge": "",
               "usedFor":"",
               "
identifier
copyright":"",
               "
title
createdBy":"",
               "
description
versionKey":"",
               "items":[{
                    "
language
identifier":
[
"
English
assessmentItem_id"
]
,
               
"max_score":10,
    "name:"Test Assessment for MTF"
               
"type":"materialised",
}]
         
     "owner":"",
               "difficulty_level":"",
               "purpose": "",
               "sub_purpose":"",
               "depth_of_knowledge": "",
               "used_for":"",
               "copyright":"",
               "createdBy":"",
               "versionKey":"",
               "assessmentItem":[{
                    "identifier":"assessmentItem_id"
               }]
         }
    }
}

...

}
    }
}
Retire Item Set:
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"
        "versionKey": "1234567"
    }
}
Review Item set:
POST: itemset/v3/review/{identifier}
{}

Response:

{
    "id": "api.itemset.
retire
review",
    "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": "1234567"
    }
}

Item set Publish API:

  • There will be Item set publish API which will publish the Itemset with a particular pkgVersion.
  • It will generated a html template (previewUrl: it is Itemset metadata) which will hold all the questions linked to item set at the time of Item set publish.
  • Currently Item set publish API will be exposed through Content Publish API - When content gets publish Item set will also get published.

...