Page Comparison

...

Expand

title	GET EVENTSET HIERARCHY => /eventset/v4/hierarchy/:identifier

RESPONSE:

Code Block

{
    "id": "api.collection.read",
    "ver": "4.0",
    "ts": "2021-02-22T17:47:53Z+05:30",
    "params": {
        "resmsgid": "34ca9d63-5929-4846-9b8f-87a31b06fa6f",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "content": {
            "trackable": {
                "enabled": "Yes",
                "fixedBatch": "Yes",
                "fixedBatchId": "event_batch_id"
            },
            "identifier": "do_11322185594386022413",
            "lastStatusChangedOn": "2021-02-22T17:44:48.096+0530",
            "audience": [
                "Student"
            ],
            "code": "123",
            "visibility": "Default",
            "endDate": "02/03/2021",
            "childNodes": [
                "do_11322185585855692811",
                "do_11322185594016563212"
            ],
            "onlineProvider": "Zoom",
            "language": [
                "English"
            ],
            "eventType": "Online",
            "languageCode": [
                "en"
            ],
            "createdOn": "2021-02-22T17:44:48.096+0530",
            "version": 2,
            "objectType": "EventSet",
            "versionKey": "1613996088096",
            "schedule": {
                "type": "NON_RECURRING",
                "value": [
                    {
                        "startDate": "01/03/2021",
                        "endDate": "01/03/2021",
                        "startTime": "11:00",
                        "endTime": "13:00",
                        "name": "event 4: 11-1"
                    },
                    {
                        "startDate": "02/03/2021",
                        "endDate": "02/03/2021",
                        "startTime": "19:00",
                        "endTime": "21:00",
                        "name": "event 4: 19-21"
                    }
                ]
            },
            "registrationEndDate": "25/02/2021",
            "children": [
                {
                    "trackable": "{\"enabled\":\"Yes\",\"fixedBatch\":\"Yes\",\"fixedBatchId\":\"event_batch_id\"}",
                    "lastStatusChangedOn": "2021-02-22T17:44:46.446+0530",
                    "audience": [
                        "Student"
                    ],
                    "code": "123",
                    "visibility": "Default",
                    "endDate": "01/03/2021",
                    "onlineProvider": "Zoom",
                    "language": [
                        "English"
                    ],
                    "eventType": "Online",
                    "version": 2,
                    "createdOn": "2021-02-22T17:44:46.446+0530",
                    "versionKey": "1613996086446",
                    "registrationEndDate": "25/02/2021",
                    "leafNodesCount": 1,
                    "name": "event 4: 11-1",
                    "lastUpdatedOn": "2021-02-22T17:44:46.446+0530",
                    "startTime": "11:00",
                    "endTime": "13:00",
                    "startDate": "01/03/2021",
                    "status": "Live"
                },
                {
                    "trackable": "{\"enabled\":\"Yes\",\"fixedBatch\":\"Yes\",\"fixedBatchId\":\"event_batch_id\"}",
                    "lastStatusChangedOn": "2021-02-22T17:44:46.456+0530",
                    "audience": [
                        "Student"
                    ],
                    "code": "123",
                    "visibility": "Default",
                    "endDate": "02/03/2021",
                    "onlineProvider": "Zoom",
                    "language": [
                        "English"
                    ],
                    "eventType": "Online",
                    "version": 2,
                    "createdOn": "2021-02-22T17:44:46.456+0530",
                    "versionKey": "1613996086456",
                    "registrationEndDate": "25/02/2021",
                    "leafNodesCount": 1,
                    "name": "event 4: 19-21",
                    "lastUpdatedOn": "2021-02-22T17:44:46.456+0530",
                    "startTime": "19:00",
                    "endTime": "21:00",
                    "startDate": "02/03/2021",
                    "status": "Live"
                }
            ],
            "name": "eventset 4",
            "lastUpdatedOn": "2021-02-22T17:44:48.096+0530",
            "startDate": "01/03/2021",
            "status": "Live"
        }
    }
}

...

Expand

title	ENROLL EVENT => /v1/event/enroll

REQUEST:

Code Block

{
    "request" : {
        "contextcourseId": {
            "graphId": "domain",
            "version"do_11322182566085427211",
        "userId": "1.0871ac12e-2170-4c6c-a07d-e933c1f64259",
                    "objectTypefixedBatchId": "Event",
            "schemaName": "event",
            "X-Channel-Id": "in.ekstep"
        },event_batch_id"
    }
}

Expand

title	UNENROLL EVENT => /v1/event/unenroll

REQUEST:

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

Expand

title	UNENROLL EVENT GET USER ENROLLED EVENTS => /v1/user/event/list/unenroll:uid

REQUESTRESPONSE:

Code Block

{
    "requestid" : {
        "context": {
            "graphId"api.user.event.list",
    "ver": "domainv1",
                "versionts": "1.02021-02-22 12:09:53:965+0530",
                "objectTypeparams": {
        "Eventresmsgid": null,
                    "schemaNamemsgid": "event2f274490-3215-4ee8-b6e4-5f96bb2383d5",
            "X-Channel-Id": "in.ekstep"
        }        "err": null,
        "courseIdstatus": "do_11322127469293568015success",
        "userIderrmsg": "871ac12e-2170-4c6c-a07d-e933c1f64259 null
    },
    "responseCode": "OK",
            "fixedBatchIdresult": "event_batch_id"
    }
}

Expand

title	GET 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{
        "courses": [
            {
                "dateTime": 1613972575662,
                "lastReadContentStatus": null,
                "enrolledDate": "2021-02-22 11:12:55:662+0530",
                    "paramsaddedBy": {
        "resmsgid": null,
        "msgid"04b5b73b-c647-44f9-9e16-1fbd1fcc696e",
                "contentId": "2f274490-3215-4ee8-b6e4-5f96bb2383d5do_11322166143296307218",
                        "erractive": null true,
                        "statusdescription": "success" null,
                        "errmsgcourseLogoUrl": null
    },
                    "responseCodebatchId": "OKevent_batch_id-do_11322166143296307218",
                    "resultuserId": {
        "courses"871ac12e-2170-4c6c-a07d-e933c1f64259",
                "content": [
            {},
                "dateTimecontentStatus": 1613972575662 {},
                "lastReadContentStatuscompletionPercentage": 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 ******
                "issuedCertificatesleafNodesCount": [] null, 
                "courseNameprogress": null 0,                 "certificates": [],
                "completedOn": null,                    ****** not maintained ******
                "certstatus": null,
                "leafNodesCountlastReadContentId": null,
                "progress"courseId": "do_11322166143296307218",
                "collectionId": "do_11322166143296307218",
                "status": 0,                        ****** not maintained ****** 
            },
            {
                "certstatus"dateTime": 1613974555685,
                "lastReadContentStatus": null,
                "lastReadContentId": 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

title	GET 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

title	ENROLL EVENTSET => /v1/eventset/enroll

REQUEST:

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

Expand

title	UNENROLL EVENTSET => /v1/eventset/unenroll

REQUEST:

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

Expand

title	UPDATE 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

title	READ USER EVENT PROGRESS => /v1/user/event/state/read

REQUEST:

Code Block

{
    "request": {
        "userId": "871ac12e-2170-4c6c-a07d-e933c1f64259",
        "courseId": "do_11322166143296307218113221678821859328113",
                        "collectionIdfixedBatchId": "doevent_batch_11322166143296307218id",
                "status": 0                        ****** not maintained ****** 
            },
            {
                "dateTime": 1613974555685,
                "lastReadContentStatus": null,
                "enrolledDate
    }
}

RESPONSE:

Code Block

{
    "id": "api.user.event.state.read",
    "ver": "v1",
    "ts": "2021-02-22 1122 14:4554:5533:685+0530",
                "addedBy": "bd8a3be7-16a8-498c-bb5c-84190e126382",
                "contentId": "do_113221678822645760114",
                "active": true,
                "description": null,
                "courseLogoUrl832+0530",
    "params": {
        "resmsgid": null,
                        "batchIdmsgid": "event_batch_id-do_113221678822645760114",
                "userId8295223b-bf1b-496e-8dba-54103e18becc",
        "err": null,
        "status": "871ac12e-2170-4c6c-a07d-e933c1f64259success",
                        "contenterrmsg": { null
    },
                    "contentStatusresponseCode": {}"OK",
                    "completionPercentageresult": null, {
                        "issuedCertificatesresponse": [],
            {
                "courseNamelastAccessTime": null,
                "certificatescontentId": []"do_113221678821859328113",
                "completedOnprogress": null 1,
                "leafNodesCountviewCount": null,
                "progressbatchId": 0,
                "certstatus": null "event_batch_id-do_113221678821859328113",
                "lastReadContentIdcompletedCount": null 1,
                "courseId": "do_113221678822645760114113221678821859328113",
                "collectionIdlastCompletedTime": "do_1132216788226457601142021-02-22 14:52:47:767+0530",
                "status": 0 2
            }
        ]
    }
}

Versions Compared

Old Version 3

New Version Current

Key