Page Comparison

Introduction:

...

Authorization and x-authenticated-user-token are mandatory headers in every requestx-requested-by header is mandatory in all state update apis
UserId will be captured using the user-token from headers for all api requests

Code Block

language	json

{
    "id": "api.view", // required. id of the api request
    "ver": "1.0",  // required. Current version of api 
    "ts": "2021-01-01T00:00:00+05:30", //mandatory. Timestamp of the request
    "params": {
        "msgid": "4f04da60-1e24-4d31-aa7b-1daf91c46341" // unique request message id, UUID
    },
    "request": {                  // required
        ....
        ....                            
    }

...

Expand

title	POST - /v1/view/start

Request Spec:

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    },
    "request": {
        "userIdcontentId": "{{userIdcontentId}}",       // required
        "contentIdcollectionId" : "{{contentIdcollectionId}}"   // requiredoptional
        "collectionIdcontextId" : "{{collectionIdbatchId}}"  // optional.required
    }
}

Sample Requests:

Sample1: consume organic content

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:50:175+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
         only when contextid is present"request": {
            "contextId""contentId" : "{{batchId}}content_123"
// optional      }
}

Sample Requests:

Sample1Sample2: consume organic content through collection

Code Block

language	json

SampleRequest1
{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:5040:175575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "userIdcontentId" : "usercontent_123",
      "contentIdcollectionId" : "contentcollection_123"      
    }

Sample2Sample3: consume content through collectioncontext

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "userId" : "user_123",
      "contentId" : "content_123",
      "collectionIdcontextId" : "collectioncontext_123"   
       }

Sample3: consume content through context

Response:

200 Ok Response:

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
    }     "requesterr": {null,
        "userIdstatus" : "user_123success",
        "contentIderrmsg": null
 : "content_123",  },
    "collectionIdresponseCode" : "collection_123OK",
    "result": {
   "contextId" : "context_123"   "{{contentId}}": "Progress started"
    }
}

4XX or 5XX Error Response:

200 Ok Response:

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440db072440d-916e-da787881b1b9",
        "err": nullERR_Error_Code,
        "status": "successfailed",
        "errmsg": nullERR_error_msg
    },
    "responseCode": "OKBAD_REQUEST"/"SERVER_ERROR",
    "result": {
      //  "{{contentId}}": "Progress started"
 error message
    }
}

4XX or 5XX Error

Sample Response:

Sample1: Valid Request

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": ERR_Error_Codenull,
        "status": "failedsuccess",
        "errmsg": ERR_error_msgnull
    },
    "responseCode": "BAD_REQUEST"/"SERVER_ERROR"OK",
    "result": {
      // error message  "content_123": "Progress started"
    }
}

Sample Response:

Sample1: Valid Sample2: InValid Request

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
         "err": null"CLIENT_ERROR",
        "status": "successFAILED",
        "errmsg": nullERR_error_msg
    },
    "responseCode": "OKBAD_REQUEST",
    "result": {
        "content_123request.contentId": "Progress startedContent Id cannot be empty"
    }
}

Sample2Sample3: InValid Invalid ContextId in Request

Code Block

language	json

{
    "id": "api.view.start",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
         "err": "CLIENT_ERROR",
        "status": "FAILED",
        "errmsg": ERR_error_msg
    },
    "responseCode": "BAD_REQUEST",
    "result": {
        "request.contentIdcontextId": "ContentInvalid Context Id cannot be empty"
    }
}

Sample3: Invalid ContextId in Request

Content View Update

Expand

title	POST - /v1/view/update

Request:

Code Block

language	json

{
    "id": "api.view.startupdate",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {

       "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
    }
    "errrequest": "CLIENT_ERROR",{
        "statuscontentId": "FAILED{{contentId}}",        // required "errmsg": ERR_error_msg 
   },     "responseCodecollectionId" : "BAD_REQUEST{{collectionId}}",   //optional
 "result": {         "request.contextId": "Invalid Context Id"{{batchId}}",         } }

Content View Update

POST - v1view/update

Expand

title

Request:

Code Block

language	json

{
 optional
   "id": "api.view.update",
    "verprogressDetails": "v1",{       "ts": "2021-06-23 05:37:40:575+0000",     "params": {  // required. Progress details specific 
"msgid": "5e763bc2-b072-440d-916e-da787881b1b9"     }   ...  "request": {         "userId": "{{userId}}",              // required          for "contentId": "{{contentId}}",each mimetype 
      // required  ...          "collectionId" : "{{collectionId}}", //optional. required only when                              
                        contextId present in request},
         "contextIdtimeSpent" : "{{batchIdtimeSpent}}",          // required
 optional   }
}

Sample Requests:

Sample1: Without Context

Code Block

language	json

{
    "progressDetailsid": {}"api.view.update",
    "ver": "v1",
   // required. Progress details specific "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "contentId" : "content_123",
      "progressDetails" : {
         "mimetype" : "appliation/pdf",
         "progress" : 20
for each mimetype     }
       "timespent" : 10
}

Sample Requests:

Sample1: Without With Context

Code Block

language	json

{
    "id": "api.view.update",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "userIdcontentId" : "usercontent_123",
      "contentIdcollectionId" : "contentcollection_123",
      "progressDetailscontextId" : {"context_123",
         "mimetypeprogressDetails" : "appliation/pdf",{
         "progressmimetype" : 20"application/pdf",
         "timespentprogress" : 1020
       }
      "timespent" : 10
}

Sample1Response: With Context

Code Block

language	json

200 OK:
{
    "id": "api.view.update",
    "ver": "v1",
    "ts": "2021-06-23 05contents05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
,
   }     "requesterr": null,
 {       "userIdstatus" : "user_123success",
      "contentId" : "content_123errmsg",: null
     "collectionId" : "collection_123"},
      "contextIdresponseCode" : "context_123OK",
      "progressDetailsresult" : {
         "mimetype{{contentId}}" : "application/pdf",
         "progressProgress Updated"
: 20,   }
}

4XX or   "timespent" : 10
       }
}

Response:

Code Block

language	json

200 OK5XX Error:
{
    "id": "api.view.update",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": nullERR_Error_Code,
        "status": "successfailed",
        "errmsg": nullERR_error_msg
    },
    "responseCode": "OK"BAD_REQUEST"/"SERVER_ERROR",
    "result": {
    }
   "{{contentId}}": "Progress Updated"
    }
}

4XX or 5XX Error:
}

Content View End

Expand

title	POST - /v1/view/end

Request:

Code Block

language	json

{
    "id": "api.view.updateend",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
    }
    "errrequest": ERR_Error_Code,{
        "statuscontentId": "failed{{contentId}}",         "errmsg": ERR_error_msg //required.
    },     "responseCodecollectionId" : "BAD_REQUEST"/"SERVER_ERROR",
    "result": {
    }
}

...

{{collectionId}}",  // required.only when 
                                                   contextId present in request 
        "contextId": "{{batchId}}",           // optional
    }
}

Sample Request:

Sample1: Without Context

Code Block

language	json

{
    "id": "api.view.end",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "contentId" : "content_123"
    }

Sample2: With Context

Code Block

language	json

{
    "id": "api.view.end",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
      "contentId" : "content_123",
      "collectionId" : "collection_123",
      "contextId" : "context_123"   
    }

Response:

Code Block

language	json

{
    "id": "api.view.end",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "{{contentId}}": "Progress ended"
    }
}

Content View Read

json

Sample1: Without context(organic consumption)

Expand

title	POST - /v1/view/endread

Request:

Code Block

language	json

{
    "id": "api.view.endread",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {
        "userId"contentId": {{contentId}}, //required
        "collectionId" : "{{userIdcollectionId}}", //optional 
        "contextId": "{{batchId}}"   //required optional
     }
}

Response:

Code Block

language	json

{
    "id": "api.view.read",
    "ver": "v1",
    "contentIdts": "{{contentId}}"2021-06-23 05:37:40:575+0000",
         //required."params": {
        "collectionIdresmsgid" : "{{collectionId}}",  // required.required only whennull,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
         contextId present in request 
 "responseCode": "OK",
    "result": {
      "contextIduserId" : "{{batchIduserId}}",
      "contentId" : "{{contentId}}",
   // optional  "type" : "content"
} }

Sample Request:

Sample1: Without Context

Code Block

language	json

{     "id": "api.view.end",contents:[{
    	"vercollectionId": "v1{{collectionId}}",
    	"tscontextId": "2021-06-23 05:37:40:575+0000{{batchId}}",     "params":
{        "msgidcontentId": "5e763bc2-b072-440d-916e-da787881b1b9"{{contentId}}",
    }     "requeststatus" : "{{content_status}}"  
        "userIdprogressDetails" : "user_123",{}"
       "contentId" : "content_123"}]
    }
}

Sample Response:

Sample2: With Context

Code Block

language

Code Block

{
    "id": "api.view.endread",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }
    "request": {,
        "userIderr" : "user_123"null,
        "contentIdstatus" : "content_123success",
        "collectionIderrmsg": : "collection_123",null
    },
    "contextIdresponseCode" : "context_123OK",
       }

Response:

Code Block

language	json

"result": {
    	"iduserId": "api.view.end",user_123"
        "vercontentId": "v1content_123",
        "tstype": "2021-06-23 05:37:40:575+0000","content"
        "paramscontents":[{
{           "resmsgidcontentid" : null"content_123",
           "msgidcollectionid" : "5e763bc2-b072-440d-916e-da787881b1b9","content_123",
           "errcontenxtid" : null,"content_123"
           "status" : "success1",
           "errmsgprogressDetails": {
   null     },     "responseCodemimeType" : "OK",application/video"
              "resultprogress" :20
   {         "{{contentId}}": "Progress ended"}
        }]
    }
}

Content View Read

Expand

title	POST - /v1/view/read

Request:

Example2: With context or collection

Code Block

language	json

{
    "id": "api.view.read",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
    }    "errmsg": null
    },
    "responseCode": "OK",
    "requestresult": {
        	"userId": "{{userId}}",    // requireduser_123"
        "contentIdscontentId": ["{{contentId_1}}content_123",
"{{contentId_2}}"], //required
        "collectionIdtype" : "{{collectionId}}content",
//optional.required only when      "contents":[{
           "contentid" : "content_123",
           "collectionid" :"collection_123",
           "contenxtid"        contextId present in request: "context_123"
            "contextIdstatus" : "{{batchId}}"1",
   // optional      }
}

Response:

Code Block

language	json

 "progressDetails": {
    "id": "api.view.read",     "ver": "v1",     "tsmimeType" : "2021-06-23 05:37:40:575+0000",application/video"
    "params": {         "resmsgidprogress" :20
   null,         "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",}
        }]
"err": null,   }
}

Expand

title	POST - /v1/view/read?context=all

Request:

Code Block

language	json

{
    "statusid": "successapi.view.read.contextall",
        "errmsgver": null
    }"v1",
    "responseCodets": "OK2021-06-23 05:37:40:575+0000",
    "resultparams": {
      	 "userIdmsgid": "{{userId}}",5e763bc2-b072-440d-916e-da787881b1b9"
    }
    	"collectionIdrequest": "{{collectionId}}", // optional{             	"contextId": "{{batchId}}",  // optional     // either of the "contents": [{
 three options is mandatory
        "contentId": "{{contentId}}",  //optional
        "statuscollectionId" : "{{content_statuscollectionId}}",   // 0,1 or 2 
 optional
        "progressDetailscontextId" : "{{contextId}}"   //optional
     }]
 
  }
}

Sample Response:

Sample1: Without context

code

Code Block

language	json

{
 
  "id": "api.view.read.contextall",

   "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
 
  "params": {
 
      "resmsgid": null,
   
    "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
    "err": null,
    "errstatus": null"success",
    "errmsg": null
  },
  "statusresponseCode": "success",OK",
  "result": {
    ...
    ...                   "errmsg": null            },//requested_data
    "responseCodetype": "OKcontextall",
    "resultcontents" : {[      	"userId": "user_123",           "contents": [{  // List of all contents irresepcitvie of context
 "contentId": "content_123",   ]
   }    "status" : "1",      
}

Sample Response:

Code Block

language	json

{
  "progressDetailsid": "{"api.view.read.contextall",
  "ver": "v1",
  "ts":    "2021-06-23 05:37:40:575+0000",
  "progressparams" :20, {
    "resmsgid": null,
     "msgid": "timespent" : 105e763bc2-b072-440d-916e-da787881b1b9",
    "err": null,
      }""status": "success",
    "errmsg": null
  }],
  "responseCode": "OK",
 }
}

Example2: With context

Code Block

language	json

{
  "result": {
  "iduserId" : "api.view.readuser_123",
    "vercollectionId" : "v1",
 collection_123"
  "tscontents": "2021-06-23 05:37:40:575+0000",[
    {
      "paramsuserid": {
  :"user_123",
      "resmsgidcontentId": null"content_123",

       "msgidstatus": "5e763bc2-b072-440d-916e-da787881b1b91",

       "errprogressDetails": null,{
        "statusprogress": "success"20,
        "errmsgtimespent": 10
 null     },
    "responseCode": "OK",},
    {
"result": {     	"userIduserid" : "user_123",

       "collectionId" : "collection_!23",
 
      "contextId" : "context_123",
        "contents": [{
   
      "contentId": "content_123",
 
        "progressDetails": "{
   
         "progress": :20,
   
         "timespent" : 10
   
      }",
          status "status": "12"
     }
  }]

   }
}

Content Submit Assess

Expand

title	POST - /v1/assessment/submit

Request:

Code Block

language	json

{
    "id": "api.assess.submit",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
       "msgid": "5e763bc2-b072-440d-916e-da787881b1b9"
    }     
    "request": {
        "userId": "{{userId}}",               // required
          "contentId": "{{contentId}}",         // required  
        "collectionId" : "{{collectionId}}",  // required
        "contextId": "{{batchId}}",           // required 
        "attemptId" : "{{attemptId}}",        // required
        "assessments": [{
            {{assess_event}}      // required for self-assess contents
        }]
    }
}

Response:

Code Block

{
    "id": "api.view.assess",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "{{contentId}}": "Score Updated"
    }
}

...

Expand

title	POST - /v1/assessment/read

Request:

{ "request": { "userId": "{{userId}}",

Code Block

language	json

{
           //required"request": {
        "contentId" : "{{contentId}}",    //required
        "collectionId" : "{{collectionId}}", //required
        "contextId": "{{batchId}}"   // required
   }
}

Response:

Code Block

language	json

{
    "id": "api.assessment.read",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
    	"userId": "{{userId}}",
        "contentId" : "{{contentId}}"
    	"collectionId": "{{collectionId}}",
    	"contextId": "{{batchId}}",
        "assessments": [{
          "attemptId" : "{{attemptId}}",
    	  "score": {{score}},
    	  "max_score": {{max_score}}
        },{
          "attemptId" : "{{attemptId}}",
    	  "score": {{score}},
    	  "max_score": {{max_score}}
        }
        ]
    }
}

...

Expand

title	GET - /v1/summary/list/:userId

Response:

Code Block

language	json

{
  "id": "api.summary.list",
  "ver": "v1",
  "ts": "2021-06-23 05:59:54:984+0000",
  "params": {
    "resmsgid": null,
    "msgid": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "summary": [
      {
        "userId": "{{userId}}",
        "collectionId": "{{collectionId}}",
        "contextId": "{{batchId}}",
        "enrolledDate": 1624275377301,
        "active": true,
        "contentStatus": {
          "{{contentId}}": {{status}}
        },
        "assessmentStatus": {
          "assessmentId": {
            "score": {{best_score}},
            "max_score": {{max_score}}
          }
        },
        "collection": {
          "identifier": "{{collectionId}}",
          "name": "{{collectionName}}",
          "logo": "{{logo Url}}",
          "leafNodesCount": {{leafNodeCount}},
          "description": "{{description}}"
        },
        "issuedCertificates": [{
          "name": "{{certName}}",
          "id": "certificateId",
          "token": "{{certToken}}",
          "lastIssuedOn": "{{lastIssuedOn}}"
        }],
        "completedOn": {{completion_date}},
        "progress": {{progress}},
        "status": {{status}}
      }
    ]
  }
}

Sample Response:

Sample1:

Code Block

language	json

{
  "id": "api.summary.list",
  "ver": "v1",
  "ts": "2021-06-23 05:59:54:984+0000",
  "params": {
    "resmsgid": null,
    "msgid": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "summary": [
      {
        "userId": "user_123",
        "collectionId": "collection_123",
        "contextId": "context_123",
        "enrolledDate": 1624275377301,
        "active": true,
        "contentStatus": {
          "content_123": 2,
          "content_456": 1
        },
        "assessmentStatus": {
          "content_123": {
            "score": {{best_score}},
            "max_score": {{max_score}}
          }
        },
        "collection": {
          "identifier": "collection_123",
          "name": "Mathematics",
          "logo": "http://logoimage",
          "leafNodesCount": 4,
          "description": "Dummy Collection"
        },
        "issuedCertificates": [{
          "name": "Certificate-1",
          "id": "cert_123",
          "token": "sdfjkldjk23j2kj2k3jk2",
          "lastIssuedOn": "1624275377301"
        }],
        "completedOn": "2021-09-10",
        "progress": 70,
        "status": 1
      }
    ]
  }
}

...

Expand

title	POST - /v1/summary/read

Request:

Code Block
{ "request": { "userId": "{{userId}}", // required "collectionId" : "{{collectionId}}", // required "contextId": "{{batchId}}" //required } }

Response:

Code Block

language	json

{
  "id": "api.summary.read",
  "ver": "v1",
  "ts": "2021-06-23 05:59:54:984+0000",
  "params": {
    "resmsgid": null,
    "msgid": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
        "userId": "{{userId}}",
   ",
    "collectionIderr": "{{collectionId}}",
   null,
    "contextIdstatus": "{{batchId}}success",
        "enrolledDateerrmsg": 1624275377301,null
     },
  "activeresponseCode": true"OK",

       "contentStatusresult": {
         "userId": "{{contentIduserId}}":,
{{status}}        "collectionId": "{{collectionId}}",
        "assessmentStatuscontextId": {
"{{batchId}}",
         "assessmentIdenrolledDate": {
1624275377301,
           "scoreactive": {{best_score}},
    true,
        "max_scorecontentStatus": {{max_score}}
          "{{contentId}}": {{status}}
        },
        "collectionassessmentStatus": {
          "identifierassessmentId": "{{collectionId}}",{
            "namescore": "{{collectionNamebest_score}}",
            "logomax_score": "{{logo Urlmax_score}}",

         "leafNodesCount": {{leafNodeCount}},
        },
 "description": "{{description}}"      "collection": {
 },         "issuedCertificatesidentifier": [{"{{collectionId}}",
          "name": "{{certNamecollectionName}}",
          "id": "certificateIdlogo": "{{logo Url}}",
          "tokenleafNodesCount": "{{certTokenleafNodeCount}}",
          "lastIssuedOndescription": "{{lastIssuedOndescription}}"
        }],
        "completedOnissuedCertificates": {{completion_date}},[{
          "progressname": "{{progresscertName}}",
          "statusid": {{status}}"certificateId",
  }
}

Viewer Summary Delete

Expand

title	DELETE - /v1/summary/delete/:userId?all - To Delete all enrolments

Response:

Code Block

language	json

Response:  {     "idtoken": "api.summary.delete",{{certToken}}",
          "verlastIssuedOn": "v1",{{lastIssuedOn}}"
      "ts": "2021-06-23 05:37:40:575+0000", }],
        "paramscompletedOn": {{completion_date}},
        "resmsgidprogress": null{{progress}},
        "msgidstatus": "5e763bc2-b072-440d-916e-da787881b1b9",{{status}}
  }
     "err": null,
   }

Viewer Summary Download - Default Format : CSV

Expand

title	GET - /v1/summary/download/:userId

Response:

Code Block

{
    "statusid": "successapi.summary.download",
   
    "errmsgver": null
    }"v1",
    "responseCodets": "OK2021-06-23 05:37:40:575+0000",
    "resultparams": {
        "{{userid}}resmsgid": :null,
"Enrolment Deleted Succesfully"     } }

Expand

title	DELETE - /v1/summary/delete/:userId - To Delete specific enrolments

Request:

Code Block

{"msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "requesterr": {null,
        "userIdstatus": "{{userId}}success",
     // required   "errmsg": null
    },
    "collectionIdresponseCode" : "{{collectionId}}OK",
 //  required "result": {
      "contextIdurl": "{{batchIduserId}}"  // required_viewer_summary.csv"
    }
}

Expand

title	GET - /v1/summary/download/:userId?format=json

Response:

Code Block

language	json

Response: 
{
    "id": "api.summary.deletedownload",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
      "{{userid}}url" : "Enrolment Deleted Succesfully "{{userId}}_viewer_summary.json"
    }
}

Viewer Summary Download - Default Format : CSVDelete

Expand

title	GET DELETE - /v1/summary/downloaddelete/:userId?all - To Delete all enrolments

Response:

Code Block

language	json

Response: 
{
    "id": "api.summary.downloaddelete",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "paramsstatus": {"success",
        "resmsgiderrmsg": null,
    },
    "msgidresponseCode": "5e763bc2-b072-440d-916e-da787881b1b9OK",
    "result": {
     "err{{userid}}" : null, "Enrolment Deleted Succesfully"
    }
}

GET - /v1/summary/download/:userId?format=json

Expand

title	DELETE - /v1/summary/delete/:userId - To Delete specific enrolments

Request:

Code Block

{
    "statusrequest": "success",{
        "errmsguserId": null
 "{{userId}}",   // required
   },     "responseCodecollectionId" : "OK{{collectionId}}",  // required
 "result": {       "urlcontextId": "{{userIdbatchId}}_viewer_summary.csv"
"  // required
    }
}

Expand

title

Response:

Code Block

language	json

Response: 
{
    "id": "api.summary.downloaddelete",
    "ver": "v1",
    "ts": "2021-06-23 05:37:40:575+0000",
    "params": {
        "resmsgid": null,
        "msgid": "5e763bc2-b072-440d-916e-da787881b1b9",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
      "url{{userid}}" : "{{userId}}_viewer_summary.jsonEnrolment Deleted Succesfully"
    }
}

Clarifications:

For assessment submit, do we need consider the assess events without context as wellIn the summary list api, if the context is program, how to show the program metadata

Versions Compared

Old Version 10

New Version Current

Key

Introduction:

Sample Response:

Sample Response:

Clarifications: