Examples
These examples show the implementation of various actions that may be required. For complete examples see the SDK sample source code. Some details below here
Integration API
Status
Checking the service status (un-authenticated call)
GET /IntegrationAPI/Status
Response
{
"acceptingRequests": true,
"updatedAt": "2024-03-04T12:03:21.6212611Z",
"message": "",
"version": "1.0.0.0"
}
NodeJS (with Axios)
const axios = require('axios')
axios
.get(baseUrl + '/IntegrationAPI/Status?v=1.0')
.then(response => {
console.log(`statusCode: ${response.status}`)
console.log(response)
})
.catch(error => {
console.error(error)
})
Calling an authenticated method with request parameters (authenticated call)
POST /Reporting/FetchServicePointReports
axios.post(baseUrl + '/Reporting/FetchServicePointReports', {
"From": "2021-10-13T00:00:00.000Z",
"To": "2021-10-13T23:59:59.999Z"
}, {
auth: {
username: 'AFFF8294-3790-46A6-941E-4403FFD0ACB7', /* Application ID */
password: '4E511279-4558-4BA8-950F-7CD479E8B982' /* Application Password */
},
headers: {
"Content-Type": "application/json"
}
})
.then(response => {
... /* Handle the response dto in response.data */
})
.catch(error => {
...
});
Calendar
Retrieving services and their related data i.e. route collection data, reports, actions and planned service dates.
POST /Caledar/Fetch
Request
{
"servicePointIdentity": "T21"
}
Response
{
"ServicePointIdentity": "27",
"Services": [
{
"ServiceName": "Menston Testing",
"ServiceSmartSuiteGuid": "7369a753-50fb-48ad-b55e-94dea8b0b46d",
"RouteCollections": [
{
"ServicePointAddress": "27,,Newby Court,,Menston",
"Name": "Menston Routes RG",
"RouteCollectionRevision": 0,
"RouteCollectionGuid": "9352a521-0c04-4373-9461-b00a0185f3d6",
"NextPlannedServiceDates": [],
"RouteName": "Menston2",
"RouteIdentity": "Menston2",
"RouteGuid": "9d85bf85-5c67-4962-53a1-08dbc597606c",
"LastPlannedServiceDate": "2024-03-02T00:00:00Z"
},
{
"ServicePointAddress": "27,,Newby Court,,Menston",
"Name": "Menston Routes RG",
"RouteCollectionRevision": 0,
"RouteCollectionGuid": "9352a521-0c04-4373-9461-b00a0185f3d6",
"NextPlannedServiceDates": [],
"RouteName": "Menston2",
"RouteIdentity": "Menston2",
"RouteGuid": "9d85bf85-5c67-4962-53a1-08dbc597606c",
"LastPlannedServiceDate": "2024-03-02T00:00:00Z"
}
]
},
{
"ServiceName": "Turn by Turn Testing",
"ServiceSmartSuiteGuid": "c559bb0a-2ec6-4425-9f93-89749782e2d6",
"RouteCollections": [
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
},
{
"ServicePointAddress": "27,,Ring Road Moortown (A6120),,Leeds",
"Name": "TBT Test InterInter Y 2.1.5",
"RouteCollectionRevision": 1,
"RouteCollectionGuid": "c7255e2d-fdcd-41c8-b0f9-a5f9aa1c1518",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-19T00:00:00Z"
},
{
"PlannedDate": "2024-03-26T00:00:00Z"
},
{
"PlannedDate": "2024-04-02T00:00:00Z"
},
{
"PlannedDate": "2024-04-09T00:00:00Z"
},
{
"PlannedDate": "2024-04-16T00:00:00Z"
},
{
"PlannedDate": "2024-04-23T00:00:00Z"
}
],
"RouteName": "TBT_MULTI",
"RouteIdentity": "TBT_MULTI",
"RouteGuid": "7765b007-6545-4c80-ed33-08dbaa13108f",
"LastServiced": "2024-01-15T15:14:19.276984Z",
"LastPlannedServiceDate": "2024-03-12T00:00:00Z"
}
]
},
{
"ServiceName": "Street Servicing",
"ServiceSmartSuiteGuid": "03197ac0-0e7a-4493-b345-b19d9025ae8d",
"RouteCollections": [
{
"ServicePointAddress": "Fir Tree Approach,,Leeds",
"Name": "Streets Test Routes",
"RouteCollectionRevision": 0,
"RouteCollectionGuid": "4c6b4bfb-2c2d-437b-aae5-e5cce9e16583",
"NextPlannedServiceDates": [
{
"PlannedDate": "2024-03-13T00:00:00Z"
},
{
"PlannedDate": "2024-03-20T00:00:00Z"
},
{
"PlannedDate": "2024-03-27T00:00:00Z"
},
{
"PlannedDate": "2024-04-03T00:00:00Z"
},
{
"PlannedDate": "2024-04-10T00:00:00Z"
},
{
"PlannedDate": "2024-04-17T00:00:00Z"
}
],
"RouteName": "Moortown",
"RouteIdentity": "Moortown",
"RouteGuid": "5909c58a-bed7-409d-0521-08dc3c6491ce",
"LastPlannedServiceDate": "2024-03-06T00:00:00Z"
}
]
}
],
"ResponseDateTime": "2024-03-12T11:28:59.2518596Z",
"Version": "1.0"
}
Jobs
Creating a new Job instance
POST /Jobs/CreateJob
Request
{
"Location": {
"Longitude": -1.23456,
"Latitude": 52.12345
},
"Identity": "Missed Bin",
"JobType": "46b6c4ba-e457-44c3-a3e8-236b192309db",
"ReportedAt": "2024-04-24T14:00:00",
"TargetCompletion": "2024-04-25T14:00:00",
"Details": "Missed Bin, please collect as a matter of urgency and confirm once done.",
"ServicePointIdentity": "1000148"
}
Response
{
"Identity": "Missed Bin",
"ResponseDateTime": "2024-04-24T13:29:31.8249313Z",
"Version": "1.0"
}
Retrieving current job status(es)
POST /Jobs/FetchJobStatuses
Request
{
"JobIdentities": [
"Missed Bin"
]
}
Response
{
"JobStatuses": [
{
"Identity": "Missed Bin",
"LastChanged": "0001-01-01T00:00:00",
"State": "Pending",
"Outcome": "NotFinished"
}
],
"ResponseDateTime": "2024-04-24T13:31:38.9877639Z",
"Version": "1.0"
}
Retrieving all Job types
POST /Jobs/FetchJobTypes
Request
No request data is required.
Response
{
"JobTypes": [
{
"UniqueGuid": "ab507774-377d-4ad9-85ca-1fb8f2b94b28",
"Label": "Litter Picking",
"Description": "Litter Picking"
},
{
"UniqueGuid": "46b6c4ba-e457-44c3-a3e8-236b192309db",
"Label": "Missed Bin",
"Description": "Missed Bin"
},
{
"UniqueGuid": "567b66af-040f-4a6f-9cfb-810f4682665c",
"Label": "Flytipping - General Waste",
"Description": ""
},
{
"UniqueGuid": "5caa19d1-a083-4468-998b-a48d5a965a17",
"Label": "New Bin Delivery",
"Description": "Delivery of a new bin"
},
{
"UniqueGuid": "f23e84b6-92e1-4af6-b543-f4d52215e31c",
"Label": "Graffiti ",
"Description": "Graffiti "
}
],
"ResponseDateTime": "2024-04-24T13:25:13.2529193Z",
"Version": "1.0"
}
Reporting
Fetching AdHoc reports
Retrieving Adhoc reports
POST /Reporting/FetchAdhocReports
Request
{
"from": "2024-04-11T09:00:00",
"to": "2024-04-11T23:59:59"
}
Response
{
"Reports": [
{
"Longitude": -0.890908137383235,
"Latitude": 52.7715738849879,
"ReportId": "21780699-760d-43bb-b470-e84a0f07a9a9",
"ReportedAt": "2024-04-11T09:25:53.88012Z",
"ReportType": {
"Label": "Report Type Label",
"Collection": "API Report Type Collection",
"Category": "API Reports"
},
"Comment": "Report text",
"Operator": {
"Name": "Jonathan",
"LoginName": "Jonathan",
"SmartSuiteGuid": "40b78938-ab1f-491e-a755-cd46f0ad04f9"
},
"Vehicle": {
"SmartSuiteGuid": "82b8589e-38bb-440d-ab1f-24ef8df9419a",
"Name": "Jonathan",
"Identity": "Jonathan"
},
"LocationReportMadeFrom": {
"Longitude": -0.8922063186764717,
"Latitude": 52.771730963140726
}
}
],
"From": "2024-04-11T09:00:00",
"To": "2024-04-11T23:59:59",
"ResponseDateTime": "2024-04-24T13:39:22.7353957Z",
"Version": "1.0"
}
Fetching ServicePoint reports
Retrieving service report reports
POST /Reporting/FetchServicePointReports
Request
{
"from": "2024-01-01T00:00:00.000Z",
"to": "2024-01-31T00:00:00.000Z"
}
Response
{
"Reports": [
{
"ServicePoint": {
"ServicePointGuid": "bce8c897-b2c9-40f4-8faa-79a189f885be",
"ServicePointIdentity": "1000017",
"ServicePointAddress": "17, End Place, Yortown, AB1 9QR",
"ServicePointComment": "Dangerous Dog",
"RouteServicePointComment": "Multiple bins"
},
"RouteContext": {
"RouteName": "REC1",
"RouteSmartSuiteGuid": "9f39b9ba-d839-44e3-53c6-08dbc597606c",
"RouteIdentity": "REC1",
"RouteCollectionName": "Recycling",
"RouteCollectionSmartSuiteGuid": "ab087ed0-f375-443e-aa28-c107df97c7de",
"ServiceName": "SmartSuite Mobile Demo - 2024",
"ServiceSmartSuiteGuid": "66ec1f1b-082c-40ca-bd00-161068df24ca"
},
"ReportId": "11078fc6-254f-4f7d-8527-3625ed05703c",
"ReportedAt": "2024-04-11T09:58:36.5892872Z",
"ReportType": {
"Label": "Report Type Label",
"Collection": "API Report Type Collection",
"Category": "API Reports"
},
"ReportComment": "Report text",
"Operator": {
"Name": "Jonathan",
"LoginName": "Jonathan",
"SmartSuiteGuid": "40b78938-ab1f-491e-a755-cd46f0ad04f9"
},
"Vehicle": {
"SmartSuiteGuid": "82b8589e-38bb-440d-ab1f-24ef8df9419a",
"Name": "Jonathan",
"Identity": "Jonathan"
},
"LocationReportMadeFrom": {
"Longitude": -0.8920260239392519,
"Latitude": 52.76869809720665
}
}
],
"From": "2024-04-11T00:00:00Z",
"To": "2024-04-11T23:59:59.999Z",
"ResponseDateTime": "2024-05-15T11:22:28.1699142Z",
"Version": "1.0"
}
Fetching RouteSegment reports
Retrieving route segment reports
POST /Reporting/FetchRouteSegmentReports
Request
{
"from": "2024-01-01T00:00:00.000Z",
"to": "2024-01-31T00:00:00.000Z"
}
Response
{
"Reports": [
{
"RouteSegmentId": "24f2bba8-a347-42b4-525c-08db68e07814",
"RouteSegmentAddress": "TALBOT AVENUE",
"ServicePoints": [
{
"ServicePointGuid": "c6a1b820-6a02-4e9a-90fd-bf26fd162457",
"ServicePointIdentity": "2004600",
"ServicePointAddress": "21A, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "7533df85-d3fb-465e-a38c-d52480d87a3f",
"ServicePointIdentity": "2004599",
"ServicePointAddress": "21, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "5940fd88-4011-4487-b006-e4e5b23792d2",
"ServicePointIdentity": "2004594",
"ServicePointAddress": "14, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "bbce1adb-7ad6-4cf8-8683-138386468258",
"ServicePointIdentity": "2004597",
"ServicePointAddress": "19, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "47735d8e-bde8-4c2a-9fbd-13052a8b5f9c",
"ServicePointIdentity": "2004593",
"ServicePointAddress": "12, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "9735bef6-0ea5-49f3-b122-a61efa0eb1dd",
"ServicePointIdentity": "2004590",
"ServicePointAddress": "10, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "e5216104-5ec4-4d65-b95c-c4d9ebfb2a97",
"ServicePointIdentity": "2004592",
"ServicePointAddress": "11A, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "47f0decb-921a-4a4f-9c7d-e3d74745904a",
"ServicePointIdentity": "2004588",
"ServicePointAddress": "8, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "d94bbba7-1553-4051-96c6-b720cf9e5184",
"ServicePointIdentity": "2004586",
"ServicePointAddress": "6, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "43c8dae4-9f2e-4b69-ba21-fec058c7a1df",
"ServicePointIdentity": "2004591",
"ServicePointAddress": "11, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "ebcd6124-81e3-43ae-aaa6-01d1b000d57f",
"ServicePointIdentity": "2004589",
"ServicePointAddress": "9, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "9dfbe07e-4699-404a-a8a7-ae74ee18534c",
"ServicePointIdentity": "2004584",
"ServicePointAddress": "4, TALBOT AVENUE, Leeds, LS8 1AQ",
"ServicePointComment": "Dangerous Dog(s)",
"RouteServicePointComment": "Multiple Bins: 2x 240L"
},
{
"ServicePointGuid": "80c52fa2-eb77-4fd0-8df0-d06fda2612af",
"ServicePointIdentity": "2004587",
"ServicePointAddress": "7, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "62a0de86-f591-416f-a03a-eba124117a47",
"ServicePointIdentity": "2004582",
"ServicePointAddress": "2, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "787f2627-e681-4fc4-917a-9c1ad5ebab89",
"ServicePointIdentity": "2004585",
"ServicePointAddress": "5, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "2d198570-5e3f-4126-84d9-2b87688f0256",
"ServicePointIdentity": "2004583",
"ServicePointAddress": "3, TALBOT AVENUE, Leeds, LS8 1AQ"
},
{
"ServicePointGuid": "e2d0f7dc-7b76-428c-8852-8627dd05a585",
"ServicePointIdentity": "2004581",
"ServicePointAddress": "1, TALBOT AVENUE, Leeds, LS8 1AQ"
}
],
"RouteSegmentComment": "Route Segment Comment",
"RoadSegmentComment": "Caution, school",
"RouteContext": {
"RouteName": "Roundhay1",
"RouteSmartSuiteGuid": "5765eaf5-95f7-4b5f-e379-08db68e0780a",
"RouteIdentity": "Roundhay1",
"RouteCollectionName": "Roundhay",
"RouteCollectionSmartSuiteGuid": "9b806483-5ed5-4df2-a41a-891ae8bb7068",
"ServiceName": "004 Roundhay - Route Guidance Routes",
"ServiceSmartSuiteGuid": "e2d0e916-64b8-444f-8dde-85b8695b0fd2"
},
"ReportId": "0298efe0-2bc6-4357-b016-5a15ebcdef87",
"ReportedAt": "2024-04-11T10:18:00.983675Z",
"ReportType": {
"Label": "Report Type Label",
"Collection": "API Report Type Collection",
"Category": "API Reports"
},
"ReportComment": "Report text",
"Operator": {
"Name": "Jonathan",
"LoginName": "Jonathan",
"SmartSuiteGuid": "40b78938-ab1f-491e-a755-cd46f0ad04f9"
},
"Vehicle": {
"SmartSuiteGuid": "82b8589e-38bb-440d-ab1f-24ef8df9419a",
"Name": "Jonathan",
"Identity": "Jonathan"
}
}
],
"From": "2024-04-11T00:00:00Z",
"To": "2024-04-11T23:59:59.999Z",
"ResponseDateTime": "2024-05-15T12:06:10.4289544Z",
"Version": "1.0"
}
Fetching Recent Service Point Actions
Retrieving recent actions such as 'Assisted Collection', 'New Customer Confirmed'.
POST /Reporting/FetchServicePointActions
Request
{
"from": "2024-03-04T12:10:00.000Z",
"to": "2024-03-04T12:20:00.000Z"
}
Response
{
"Actions": [
{
"ActionId": "deaf0130-be2c-49d1-8342-5cfd96ab942b",
"ServicePoint": {
"ServicePointGuid": "d5ab7679-2908-4f65-babe-e319be98b465",
"ServicePointIdentity": "1000148",
"ServicePointAddress": "Flat 1, 148 Tall House, Main Avenue, Yortown, AB1 7MN",
"ServicePointComment": "Bin code 5678",
"RouteServicePointComment": "Route Service Point Comment"
},
"Action": "Action",
"ActionedAt": "2024-04-24T09:24:33.360161Z",
"Operator": {
"Name": "Jonathan",
"LoginName": "Jonathan",
"SmartSuiteGuid": "40b78938-ab1f-491e-a755-cd46f0ad04f9"
},
"Vehicle": {
"SmartSuiteGuid": "a0bc3c7c-c2a5-4581-a1b2-03f3bdbac0d4",
"Name": "REFUSE-01",
"Identity": "SK24 KAA"
},
"RouteContext": {
"RouteName": "Demo",
"RouteSmartSuiteGuid": "150326b0-2b79-460f-2598-08daf7bdd3d8",
"RouteIdentity": "Demo",
"RouteCollectionName": "Recycling",
"RouteCollectionSmartSuiteGuid": "c1fcaac3-c7d3-4e56-af9b-e0194762f06c",
"ServiceName": "SmartSuite Mobile Demo",
"ServiceSmartSuiteGuid": "64ddf8c8-7641-4325-ab73-4abe3870d3ec"
},
"LocationActionMade": {
"Longitude": -2.015695245936513,
"Latitude": 53.957552961073816
}
}
],
"From": "2024-04-24T00:00:00",
"To": "2024-04-24T23:59:59",
"ResponseDateTime": "2024-04-24T09:27:39.8479107Z",
"Version": "1.0"
}
Fetching ServicePoint Serviced Events
Retrieving Service Point Serviced Events.
POST /Reporting/FetchServicePointEvents
Request
{
"from": "2024-03-04T12:10:00.000Z",
"to": "2024-03-04T12:20:00.000Z"
}
Response
{
"Events": [
{
"ServicedEventId": "13cafb95-9cfb-4b25-922b-0c62e7d6a9ff",
"ServicePoint": {
"ServicePointGuid": "38bd7cee-779a-4118-afa9-3d33aafa9dcc",
"ServicePointIdentity": "1000060",
"ServicePointAddress": "60, Quiet Street, Yortown, AB1 5IJ",
"RouteServicePointComment": "Route Service Point Comment"
},
"ServicedStatus": "Serviced",
"Overridden": true,
"ServicedEventAt": "2024-05-30T14:06:34.128145Z",
"Operator": {
"Name": "Jonathan",
"LoginName": "Jonathan",
"SmartSuiteGuid": "40b78938-ab1f-491e-a755-cd46f0ad04f9"
},
"Vehicle": {
"SmartSuiteGuid": "a0bc3c7c-c2a5-4581-a1b2-03f3bdbac0d4",
"Name": "REFUSE-01",
"Identity": "SK24 KAA"
},
"RouteContext": {
"RouteName": "REC1",
"RouteSmartSuiteGuid": "9f39b9ba-d839-44e3-53c6-08dbc597606c",
"RouteIdentity": "REC1",
"RouteCollectionName": "Recycling",
"RouteCollectionSmartSuiteGuid": "ab087ed0-f375-443e-aa28-c107df97c7de",
"ServiceName": "SmartSuite Mobile Demo - 2024",
"ServiceSmartSuiteGuid": "66ec1f1b-082c-40ca-bd00-161068df24ca"
},
"LocationServicedEventMade": {
"Longitude": -1.5300809999999998,
"Latitude": 53.82686999999999
},
"Report": {
"ReportId": "5f1a485f-2c81-42fb-8763-ce1b31f8875e",
"ReportedAt": "2024-05-30T14:06:32.709387Z",
"ReportType": {
"Label": "Bin Contaminated",
"Collection": "Demo Reports",
"Category": "Bin Reports"
},
"ReportComment": "text",
"LocationReportMadeFrom": {
"Longitude": -1.5378923155367374,
"Latitude": 53.82916785310954
}
}
}
],
"From": "2024-05-30T14:00:00",
"To": "2024-05-30T14:07:00",
"ResponseDateTime": "2024-05-30T15:35:30.3692104Z",
"Version": "1.0"
}
Route
Fetching Route Details
Retrieving Route details
POST /Reporting/FetchRouteDetails
Request
{
"serviceName": "Menston Testing",
"routeCollectionName": "Menston Routes RG",
"routeCollectionRevision": "0",
"routeIdentity": "Menston2"
}
Response
{
"Route": {
"SmartSuiteId": "9f39b9ba-d839-44e3-53c6-08dbc597606c",
"Identity": "REC1",
"Name": "REC1"
},
"RouteCollection": {
"SmartSuiteId": "ab087ed0-f375-443e-aa28-c107df97c7de",
"Revision": 10
},
"Service": {
"SmartSuiteId": "66ec1f1b-082c-40ca-bd00-161068df24ca",
"Name": "SmartSuite Mobile Demo - 2024"
},
"RouteSequence": [],
"ResponseDateTime": "2024-04-24T09:35:43.2342179Z",
"Version": "1.0"
}
Fetching Service point
Retrieving Service point details
POST /Reporting/FetchServicePoint
Request
{
"servicePointIdentity": "2004663"
}
Response
{
"ServicePoint": {
"ServicePointGuid": "e2e98b05-f427-4845-945d-298d69de1cf5",
"ServicePointIdentity": "1000148",
"ServicePointAddress": "Flat 1, 148 Tall House, Main Avenue, Yortown, AB1 7MN",
"ServicePointComment": "Bin code 5678"
},
"ResponseDateTime": "2024-04-24T10:44:06.4695747Z",
"Version": "1.0"
}
RouteServicePoint
Fetching Route Service Point
Retrieving Route Service point details
POST /RouteServicePoint/FetchRouteServicePoint
Request
{
"servicePointIdentity": "2004380"
}
Response
{
"ServicePointIdentity": "2004380",
"Services": [
{
"ServiceName": "005 Roundhay - No RG would you believe",
"ServiceSmartSuiteGuid": "7228e5ea-0269-4119-9d32-08172d3a26f5",
"RouteCollections": [
{
"RouteCollectionRevision": 0,
"RouteCollectionName": "Roundhay 5 - no RG",
"RouteCollectionSmartSuiteGuid": "15d07cba-2a25-4bba-9e60-212680f4d49a",
"Routes": [
{
"RouteName": "Roundhay3",
"RouteSmartSuiteGuid": "3f350daf-1ed2-47c1-e37d-08db68e0780a",
"RouteIdentity": "Roundhay3",
"RouteSegments": [
{
"RouteSegmentSmartSuiteGuid": "415e278c-7be9-406a-543a-08db68e07814"
},
{
"RouteSegmentSmartSuiteGuid": "0d578bcf-701b-4848-543b-08db68e07814"
},
{
"RouteSegmentSmartSuiteGuid": "753ba66f-b7f6-417b-543c-08db68e07814"
},
{
"RouteSegmentSmartSuiteGuid": "da0fb56e-9c1a-4a39-543d-08db68e07814"
},
{
"RouteSegmentSmartSuiteGuid": "1341a08f-6386-4700-5439-08db68e07814"
}
]
}
]
}
]
}
],
"ResponseDateTime": "2024-03-12T17:09:51.0029237Z",
"Version": "1.0"
}
Updating a Route Service Point
Update properties of one or more Route Service Points
POST /RouteServicePoint/UpdateRouteServicePoints
Request
{
"Updates": [
{
"Identity": "1000153",
"ServiceName": "SmartSuite Mobile Demo - 2024",
"ServiceComment": "New Service Comment",
"Action": "New Action"
}
]
}
Response
{
"UpdateStates": [
{
"Identity": "1000153",
"Service": "SmartSuite Mobile Demo - 2024",
"State": "changed"
}
],
"ResponseDateTime": "2024-04-24T12:53:48.9220375Z",
"Version": "1.0"
}