Backend API request and response formats (work in progress)

CREATE EVENT => /event/v4/create

REQUEST:

{
    "request": {
        "content": {
            "name": "test event",
            "code": "1234",
            "startDate": "01/03/2021",
            "endDate": "01/03/2021",
            "startTime": "11:00",
            "endTime": "13:00",
            "onlineProvider": "Zoom",
            "registrationEndDate": "25/02/2021",
            "eventType": "Online"
        }
    }
}

RESPONSE:

{
    "id": "api.event.create",
    "ver": "4.0",
    "ts": "2021-02-22T16:43:10Z+05:30",
    "params": {
        "resmsgid": "ad911e95-f955-42ec-bd9d-53c3000509a3",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "identifier": "do_11322182566085427211",
        "node_id": "do_11322182566085427211",
        "versionKey": "1613992390626"
    }
}

READ EVENT => /event/v4/read/:identifier

RESPONSE:

{
    "id": "api.content.read",
    "ver": "4.0",
    "ts": "2021-02-22T16:54:38Z+05:30",
    "params": {
        "resmsgid": "403254ab-4553-4028-bd80-0ffa073b1638",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "content": {
            "trackable": {
                "enabled": "Yes",
                "fixedBatch": "Yes",
                "fixedBatchId": "event_batch_id"
            },
            "identifier": "do_11322182566085427211",
            "lastStatusChangedOn": "2021-02-22T16:43:10.626+0530",
            "audience": [
                "Student"
            ],
            "code": "1234",
            "visibility": "Default",
            "endDate": "01/03/2021",
            "onlineProvider": "Zoom",
            "language": [
                "English"
            ],
            "eventType": "Online",
            "languageCode": [
                "en"
            ],
            "createdOn": "2021-02-22T16:43:10.626+0530",
            "version": 2,
            "objectType": "Event",
            "versionKey": "1613992390626",
            "registrationEndDate": "25/02/2021",
            "leafNodesCount": 1,
            "name": "test event",
            "lastUpdatedOn": "2021-02-22T16:43:10.626+0530",
            "startTime": "11:00",
            "endTime": "13:00",
            "contentType": "Event",
            "startDate": "01/03/2021",
            "status": "Live"
        }
    }
}

UPDATE EVENT => /event/v4/update/:identifier

REQUEST:

{
    "request": {
        "content": {
            "identifier": "do_11322182566085427211",
            "name": "standalone event",
            "code": "123",
            "startDate": "03/03/2021",
            "endDate": "04/03/2021",
            "versionKey": "1613719131567",
            "startTime": "11:00",
            "endTime": "13:00",
            "onlineProvider": "Zoom",
            "registrationEndDate": "25/02/2021",
            "eventType": "Online",
            "status": "Live"
        }
    }
}

RESPONSE:

{
    "id": "api.content.update",
    "ver": "4.0",
    "ts": "2021-02-22T17:40:49Z+05:30",
    "params": {
        "resmsgid": "200328ff-796a-421b-b35f-b8061085e60d",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "identifier": "do_11322182566085427211",
        "node_id": "do_11322182566085427211",
        "versionKey": "1613995849274"
    }
}

CREATE EVENTSET => /eventset/v4/create

REQUEST:

{
    "request": {
        "collection": {
            "name": "eventset 4",
            "code": "123",
            "startDate": "01/03/2021",
            "endDate": "02/03/2021",
            "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"
                    }
                ]
            },
            "onlineProvider": "Zoom",
            "registrationEndDate": "25/02/2021",
            "eventType": "Online"
        }
    }
}

RESPONSE:

{
    "id": "api.eventSet.create",
    "ver": "4.0",
    "ts": "2021-02-22T17:44:48Z+05:30",
    "params": {
        "resmsgid": "529105bd-c086-4210-9c87-380d74be42c6",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "identifier": "do_11322185594386022413",
        "node_id": "do_11322185594386022413",
        "versionKey": "1613996088096"
    }
}