Versions Compared

Old Version 3

changes.mady.by.user Nitin Puri

Saved on

compared with

New Version 4

changes.mady.by.user Nitin Puri

Saved on

Key

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

...

Expand
titleENROLL EVENT => /v1/event/enroll

REQUEST:

Code Block
{
    "request" : {
        "context": {
            "graphId": "domain",
            "version": "1.0",
            "objectType": "Event",
            "schemaName": "event",
            "X-Channel-Id": "in.ekstep"
        },
        "courseId": "do_11322182566085427211",
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "fixedBatchId": "event_batch_id"
    }
}

Expand
titleUNENROLL EVENT => /v1/event/unenroll

REQUEST:

Code Block
{
    "request" : {
        "contextcourseId": {
            "graphId": "domain",
            "version": "1.0",
            "objectType": "Event",
            "schemaName": "event",
            "X-Channel-Id": "in.ekstep"
        },
        "courseId": ""do_11322127469293568015",
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "fixedBatchId": "event_batch_id"
    }
}

Expand
titleGET USER ENROLLED EVENTS => /v1/user/event/list/:uid

RESPONSE:

Code Block
{
    "id": "api.user.event.list",
    "ver": "v1",
    "ts": "2021-02-22 12:09:53:965+0530",
    "params": {
        "resmsgid": null,
        "msgid": "2f274490-3215-4ee8-b6e4-5f96bb2383d5",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "courses": [
            {
                "dateTime": 1613972575662,
                "lastReadContentStatus": null,
                "enrolledDate": "2021-02-22 11:12:55:662+0530",
                "addedBy": "04b5b73b-c647-44f9-9e16-1fbd1fcc696e",
                "contentId": "do_11322166143296307218",
                "active": true,
                "description": null,
                "courseLogoUrl": null,
                "batchId": "event_batch_id-do_11322166143296307218",
                "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
                "content": {},
                "contentStatus": {},
                "completionPercentage": null,      ****** not maintained ******
                "issuedCertificates": [], 
                "courseName": null,
                "certificates": [],
                "completedOn": null,               ****** not maintained ******
                "leafNodesCount": null,
                "progress": 0,                     ****** not maintained ******
                "certstatus": null,
                "lastReadContentId": null,
                "courseId": "do_11322166143296307218",
                "collectionId": "do_11322166143296307218",
                "status": 0                        ****** not maintained ****** 
            },
            {
                "dateTime": 1613974555685,
                "lastReadContentStatus": null,
                "enrolledDate": "2021-02-22 11:45:55:685+0530",
                "addedBy": "bd8a3be7-16a8-498c-bb5c-84190e126382",
                "contentId": "do_113221678822645760114",
                "active": true,
                "description": null,
                "courseLogoUrl": null,
                "batchId": "event_batch_id-do_113221678822645760114",
                "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
                "content": {},
                "contentStatus": {},
                "completionPercentage": null,
                "issuedCertificates": [],
                "courseName": null,
                "certificates": [],
                "completedOn": null,
                "leafNodesCount": null,
                "progress": 0,
                "certstatus": null,
                "lastReadContentId": null,
                "courseId": "do_113221678822645760114",
                "collectionId": "do_113221678822645760114",
                "status": 0
            }
        ]
    }
}

Expand
titleGET EVENT PARTICIPANTS => /v1/event/participants/list

REQUEST:

Code Block
{
    "request" : {
        "courseId": "do_11321992075936563213",
        "fixedBatchId": "event_batch_id"
    }
}

RESPONSE:

Code Block
{
    "id": "api.event.participants.list",
    "ver": "v1",
    "ts": "2021-02-22 18:28:54:958+0530",
    "params": {
        "resmsgid": null,
        "msgid": "f475544f-a973-4fb9-ba51-9d2080f8a678",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "participants": {
            "count": 1,
            "participants": [
                "871ac12e-2170-4c6c-a07d-e933c1f64259"
            ]
        }
    }
}
Expand
titleENROLL EVENTSET => /v1/eventset/enroll

REQUEST:

Code Block
{
    "request" : {
        "courseId": "do_113221678843125760115",
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "fixedBatchId": "event_batch_id"
    }
}

Expand
titleUNENROLL EVENTSET => /v1/eventset/unenroll

REQUEST:

Code Block
{
    "request" : {
        "courseId": "do_113221678843125760115",
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "fixedBatchId": "event_batch_id"

    }
}

Expand
titleUPDATE USER EVENT PROGRESS => /v1/user/event/state/update

REQUEST:

Code Block
{
    "request": {
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "courseId": "do_113221678821859328113",
        "fixedBatchId": "event_batch_id",
        "status": 2,
        "progress": 1
    }
}

Expand
titleREAD USER EVENT PROGRESS => /v1/user/event/state/read

REQUEST:

Code Block
{
    "request": {
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "courseId": "do_113221678821859328113",
        "fixedBatchId": "event_batch_id"
    }
}

RESPONSE:

Code Block
{
    "id": "api.user.event.state.read",
    "ver": "v1",
    "ts": "2021-02-22 14:54:33:832+0530",
    "params": {
        "resmsgid": null,
        "msgid": "8295223b-bf1b-496e-8dba-54103e18becc",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "response": [
            {
                "lastAccessTime": null,
                "contentId": "do_113221678821859328113",
                "progress": 1,
                "viewCount": null,
                "batchId": "event_batch_id-do_113221678821859328113",
                "completedCount": 1,
                "courseId": "do_113221678821859328113",
                "lastCompletedTime": "2021-02-22 14:52:47:767+0530",
                "status": 2
            }
        ]
    }
}