GetServiceUnitsForObject

Request Parameters

Example Request:

{
    "objectRef": {
        "type": "PointAddress",
        "value": [6659161],
        "key": "Id"
    },
    "debug": false,
    "query": {
        "includeTaskInstances": false
    }
}

Response Parameters

Example Response:

{
    "jsonrpc": "2.0",
    "id": 20,
    "result": {
        "response": [{
            "guid": "3f8339cc-06cf-42be-8541-3c93ce6ea154",
            "id": 29800928,
            "data": [],
            "clientReference": null,
            "endDate": "2020-08-26T00:00:00+01:00",
            "name": "A FIELD, A STREET, SOMEWHERE, AA1 1AA",
            "serviceId": 566,
            "serviceName": "Domestic Refuse Collection",
            "serviceTasks": [{
                "guid": "fb6d206a-116a-46d2-9505-9ba7d31c77d2",
                "id": 17283309,
                "data": [],
                "endDate": "2020-08-26T00:00:00+01:00",
                "serviceTaskSchedules": [{
                    "guid": "80397057-d436-4eb1-a342-8db7e592b5e5",
                    "id": 28772006,
                    "allocation": {
                        "roundGroupId": 6894,
                        "roundGroupName": "Refuse 21 WkA",
                        "roundId": 41357,
                        "roundLegId": null,
                        "roundLegName": null,
                        "roundName": "Monday",
                        "type": "Round"
                    },
                    "endDate": "2020-08-26T00:00:00+01:00",
                    "hasOwnSchedule": false,
                    "lastInstance": null,
                    "nextInstance": null,
                    "scheduleDescription": null,
                    "scheduleId": null,
                    "startDate": "2020-06-01T00:00:00+01:00",
                    "timeBand": null,
                    "data": []
                }],
                "startDate": "2020-06-01T00:00:00+01:00",
                "taskTypeId": 3455,
                "taskTypeName": "Collect Domestic Refuse",
                "notes": null,
                "taskIndicatorId": null,
                "scheduleDescription": null
            }],
            "serviceUnitPoints": [{
                "guid": "ec5f2d21-bbbe-4fdb-bca6-83b6e9171feb",
                "id": 33311784,
                "endDate": "2020-08-26T00:00:00+01:00",
                "isPointOfService": true,
                "isServicedPoint": true,
                "pointRef": {
                    "key": "Id",
                    "type": "PointAddress",
                    "value": [6659161]
                },
                "startDate": "2020-06-01T00:00:00+01:00",
                "data": []
            }],
            "serviceUnitTypeId": 78,
            "startDate": "2020-06-01T00:00:00+01:00"
        }, {
            "guid": "d6e74aad-5e3e-4cb2-9c7a-ac41d29acb8c",
            "id": 29800929,
            "data": [],
            "clientReference": null,
            "endDate": "2020-08-26T00:00:00+01:00",
            "name": "A FIELD, A STREET, SOMEWHERE, AA1 1AA",
            "serviceId": 569,
            "serviceName": "Domestic Paper/Card Collection",
            "serviceTasks": [{
                "guid": "5d9b5209-83dd-4eba-ab67-787336db51fd",
                "id": 17280502,
                "data": [],
                "endDate": "2020-08-26T00:00:00+01:00",
                "serviceTaskSchedules": [{
                    "guid": "c4459e25-acf8-425c-81cc-e3ad2adeceec",
                    "id": 28768674,
                    "allocation": {
                        "roundGroupId": 6905,
                        "roundGroupName": "Recycling 01 WkB",
                        "roundId": 41390,
                        "roundLegId": null,
                        "roundLegName": null,
                        "roundName": "Monday",
                        "type": "Round"
                    },
                    "endDate": "2020-08-26T00:00:00+01:00",
                    "hasOwnSchedule": false,
                    "lastInstance": null,
                    "nextInstance": null,
                    "scheduleDescription": null,
                    "scheduleId": null,
                    "startDate": "2020-06-01T00:00:00+01:00",
                    "timeBand": null,
                    "data": []
                }],
                "startDate": "2020-06-01T00:00:00+01:00",
                "taskTypeId": 3469,
                "taskTypeName": "Collect Domestic Paper/Card",
                "notes": null,
                "taskIndicatorId": null,
                "scheduleDescription": null
            }],
            "serviceUnitPoints": [{
                "guid": "ef4074e5-b67d-4472-9202-04140bf344d8",
                "id": 33312713,
                "endDate": "2020-08-26T00:00:00+01:00",
                "isPointOfService": true,
                "isServicedPoint": true,
                "pointRef": {
                    "key": "Id",
                    "type": "PointAddress",
                    "value": [6659161]
                },
                "startDate": "2020-06-01T00:00:00+01:00",
                "data": []
            }],
            "serviceUnitTypeId": 78,
            "startDate": "2020-06-01T00:00:00+01:00"
        }],
        "success": true
    }
}