Backend API request and response formats

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"
    }
}

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"
        }
    }
}

REQUEST:

RESPONSE:

REQUEST:

RESPONSE:

Sunbird Design

Backend API request and response formats

Analytics

Related content