Toggle menu

GetEvent

Request Parameters

GetEvent Request Schema
 

Example Request:

{
    "ref": {
        "type": "Event",
        "value": [7387585],
        "key": "Id"
    }
}

Response Parameters

GetEvent Response Schema part one
 

GetEvent Response Schema part two
 

GetEvent Response Schema part three
 

Example Response

{
    "jsonrpc": "2.0",
    "id": 17,
    "result": {
        "response": {
            "guid": "1aa7f7bb-3785-4825-7819-a77deaf5bfac",
            "id": 7387585,
            "data": [{
                "guid": "36d9f817-8c39-44af-8eff-2ae7db090158",
                "id": 78365078,
                "childData": [],
                "datatypeId": 41810,
                "datatypeName": "First Name",
                "value": "Luke"
            }, {
                "guid": "a538aa12-2aa4-4e40-8e15-66e716456ea3",
                "id": 78365079,
                "childData": [],
                "datatypeId": 41811,
                "datatypeName": "Surname",
                "value": "Taylor"
            }, {
                "guid": "e59d3df7-d31f-46c3-9202-4bedd4d8e287",
                "id": 78365080,
                "childData": [{
                    "guid": "459a620d-f570-40fd-b692-0c947140363a",
                    "id": 78365081,
                    "childData": [],
                    "datatypeId": 41828,
                    "datatypeName": "Item",
                    "value": "24"
                }, {
                    "guid": "04942d98-b912-4e29-82e5-0094c0d9e93e",
                    "id": 78365082,
                    "childData": [],
                    "datatypeId": 41831,
                    "datatypeName": "Description",
                    "value": "An abandoned microwave"
                }, {
                    "guid": "4c0c90f9-c916-4c9e-864c-76099bc451ff",
                    "id": 78365083,
                    "childData": [],
                    "datatypeId": 41829,
                    "datatypeName": "Quantity",
                    "value": "1"
                }, {
                    "guid": "f0f89611-7952-42f3-9c68-cbb426ecee14",
                    "id": 78365086,
                    "childData": [],
                    "datatypeId": 41832,
                    "datatypeName": "Item - State",
                    "value": "0"
                }, {
                    "guid": "edd86983-bf73-4250-afee-d09b84028a89",
                    "id": 78365087,
                    "childData": [],
                    "datatypeId": 41833,
                    "datatypeName": "Item - Res Code",
                    "value": "0"
                }, {
                    "guid": "9d0a64d4-bc85-4e78-8b92-587af3aa08e4",
                    "id": 78365088,
                    "childData": [],
                    "datatypeId": 41830,
                    "datatypeName": "Task Line Number",
                    "value": "19557299"
                }],
                "datatypeId": 41827,
                "datatypeName": "SBCW - Bulky"
            }, {
                "guid": "57bf6b5a-40a6-41a2-b124-e0b25d9f65cb",
                "id": 78365084,
                "childData": [],
                "datatypeId": 41813,
                "datatypeName": "Email",
                "value": "luke.taylor@REDACTED.com"
            }, {
                "guid": "6310c00a-dd80-4466-9985-1b6f08b3c267",
                "id": 78365085,
                "childData": [],
                "datatypeId": 41839,
                "datatypeName": "Payment Amount",
                "value": "50.00"
            }],
            "allocatedContractUnitId": null,
            "allocatedUserId": null,
            "description": "40 FAKE DRIVE, SOMEWHERE, PL6 7TL",
            "dueDate": "2020-08-06T08:00:06+01:00",
            "endDate": "2020-08-07T08:01:41+01:00",
            "eventDate": "2020-08-06T08:00:06+01:00",
            "eventObjects": [{
                "guid": "0ae3f1fa-20b9-42a9-b395-0057204cc9a6",
                "id": 13865906,
                "eventObjectType": "Subject",
                "objectRef": {
                    "key": "None",
                    "type": "ServiceUnit",
                    "value": []
                },
                "location": null
            }, {
                "guid": "6e76c9ff-1d9e-4fc4-9c3e-b9f66d434e8b",
                "id": 13865905,
                "eventObjectType": "Source",
                "objectDescription": "40 FAKE DRIVE, SOMEWHERE, PL6 7TL",
                "objectRef": {
                    "key": "Id",
                    "type": "PointAddress",
                    "value": [6599297]
                },
                "location": null
            }],
            "eventStateId": 15764,
            "eventTypeId": 2306,
            "history": [{
                "guid": "39615a9a-8566-4563-ba72-257fc3452f21",
                "id": 32581694,
                "date": "2020-08-06T08:00:06+01:00",
                "description": "Create Event",
                "userId": 3625
            }, {
                "guid": "a5d3405b-e790-447e-8518-8867c9629254",
                "id": 32581723,
                "date": "2020-08-07T08:01:41+01:00",
                "description": "Update\r\nCancelled after 24 hours due to non payment.",
                "userId": 0
            }],
            "lastActionId": 32581723,
            "lastUpdatedDate": "2020-08-07T08:01:41+01:00",
            "resolutionCodeId": null,
            "resolvedDate": "2020-08-07T08:01:41+01:00",
            "serviceId": 584,
            "taskReservations": null,
            "taskRefs": [{
                "key": "Id",
                "type": "Task",
                "value": [100394711]
            }]
        },
        "success": true
    }
}

Last modified on February 03, 2021

Share this page

Facebook icon Twitter icon email icon

Print

print icon