SmartSuite_IntegrationAPI

Calendar

Fetch

Request

POST /Calendar/Fetch?v

Parameters

Name	Type	Default	Notes
*v		1.0
body	GetCalendarRequest

Responses

Status Code	Type	Description	Samples
200	GetCalendarResponse	OK

IntegrationAPI

Status

Return the status of the Integration API Service

No permissions required

Request

GET /IntegrationAPI/Status?v

Parameters

Name	Type	Default	Notes
*v		1.0	No permissions required

Responses

Status Code	Type	Description	Samples
200	GetServiceStatusResponse	OK

GetApiKeyDetails

Return information about the API Key that has been used to authenticate with the API

Request

GET /IntegrationAPI/GetApiKeyDetails?v

Parameters

Name	Type	Default	Notes
*v		1.0

Responses

Status Code	Type	Description	Samples
200	GetApiKeyDetailsResponse	OK

Jobs

CreateJob

Request creation of a new job instance

This endpoint supported in API Version 1.0. Required Permissions: tbc

Request

POST /Jobs/CreateJob?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: tbc
body	CreateJobRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.ApplicationServices.Jobs.Services.CreateJobRequest.

Responses

Status Code	Type	Description	Samples
200	GetJobTypesResponse	OK
401	GetJobTypesResponse	Unauthorized
403	GetJobTypesResponse	Forbidden

FetchJobStatuses

Fetch Job Statuses

This endpoint supported in API Version 1.0. Required Permissions: tbc

Request

POST /Jobs/FetchJobStatuses?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: tbc
body	GetJobStatusesRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.ApplicationServices.Jobs.Services.GetJobStatusesRequest.

Responses

Status Code	Type	Description	Samples
200	GetJobTypesResponse	OK
401	GetJobTypesResponse	Unauthorized
403	GetJobTypesResponse	Forbidden

FetchJobTypes

Fetch currently supported Job Types or use with requests to create new jobs

This endpoint supported in API Version 1.0. Required Permissions: tbc

Request

POST /Jobs/FetchJobTypes?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: tbc
body	GetJobTypesRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.ApplicationServices.Jobs.Services.GetJobTypesRequest.

Responses

Status Code	Type	Description	Samples
200	GetJobTypesResponse	OK
401	GetJobTypesResponse	Unauthorized
403	GetJobTypesResponse	Forbidden

Reporting

FetchAdhocReports

Fetch Ad hoc reports

This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST

Request

POST /Reporting/FetchAdhocReports?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST
body	GetAdhocReportsRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetAdhocReportsRequest.

Responses

Status Code	Type	Description	Samples
400	ProblemDetails	Invalid ID supplied

FetchServicePointReports

Fetch Service Point reports.

This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST

Request

POST /Reporting/FetchServicePointReports?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST
body	GetServicePointReportsRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointReportsRequest.

Responses

Status Code	Type	Description	Samples
200	GetServicePointReportsResponse	OK

FetchRouteSegmentReports

Fetch Route Segment reports.

This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_ROAD_LIST, DATA_MANAGEMENT_ROUTE_LIST

Request

POST /Reporting/FetchRouteSegmentReports?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_ROAD_LIST, DATA_MANAGEMENT_ROUTE_LIST
body	GetRouteSegmentReportsRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetRouteSegmentReportsRequest.

Responses

Status Code	Type	Description	Samples
200	GetRouteSegmentReportsResponse	OK

FetchServicePointActions

Fetch ServicePoint Actions.

This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST

Request

POST /Reporting/FetchServicePointActions?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST
body	GetServicePointActionsRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointActionsRequest.

Responses

Status Code	Type	Description	Samples
200	GetServicePointActionsResponse	OK

FetchServicePointEvents

Fetch ServicePoint Serviced Events.

This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST

Request

POST /Reporting/FetchServicePointEvents?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST, DATA_MANAGEMENT_SERVICEPOINT_LIST, DATA_MANAGEMENT_ROUTE_LIST
body	GetServicePointServicedEventsRequest		The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointServicedEventsRequest.

Responses

Status Code	Type	Description	Samples
200	GetServicePointServicedEventsResponse	OK

Route

FetchRouteDetails

Fetch Route Details.

This endpoint supported in API Version 1.0. Required Permissions: ?????????

Request

POST /Route/FetchRouteDetails?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: ?????????
body	GetRouteDetailsRequest

Responses

Status Code	Type	Description	Samples
200	GetRouteDetailsResponse	OK

FetchServicePoint

Fetch Route Details.

This endpoint supported in API Version 1.0. Required Permissions: ?????????

Request

POST /Route/FetchServicePoint?v

Parameters

Name	Type	Default	Notes
*v		1.0	This endpoint supported in API Version 1.0. Required Permissions: ?????????
body	GetServicePointRequest

Responses

Status Code	Type	Description	Samples
200	GetServicePointResponse	OK

RouteServicePoint

FetchRouteServicePointV2

Request

POST /RouteServicePoint/FetchRouteServicePointV2?v

Parameters

Name	Type	Default	Notes
*v		1.0
body	GetRouteServicePointV2Request

Responses

Status Code	Type	Description	Samples
200	GetRouteServicePointV2Response	OK

FetchRouteServicePoint

Fetch details about a Route Service Point

Request

POST /RouteServicePoint/FetchRouteServicePoint?v

Parameters

Name	Type	Default	Notes
*v		1.0
body	GetRouteServicePointRequest

Responses

Status Code	Type	Description	Samples
200	GetRouteServicePointResponse	OK

UpdateRouteServicePoints

Update properties of one or more Route Service Points

Request

POST /RouteServicePoint/UpdateRouteServicePoints?v

Parameters

Name	Type	Default	Notes
*v		1.0
body	UpdateRouteServicePointsRequest

Responses

Status Code	Type	Description	Samples
200	UpdateRouteServicePointsResponse	OK

Services

FetchServicePoints

Fetch details about a Service Point

Request

POST /Services/FetchServicePoints?v

Parameters

Name	Type	Default	Notes
*v		1.0
body	GetServicePointsRequest

Responses

Status Code	Type	Description	Samples
200	GetServicePointsResponse	OK

Definitions

GetCalendarRequest

Name	Type	Notes
Version	string
ServicePointIdentity	string	Service Point Identity reference, typically a UPRN

GetCalendarResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
ServicePointIdentity	string	Service Point Identity reference, typically a UPRN
Services	CalendarService[]	Array of services that this service point is linked too

Message

Returns information about part errors/warnings, if a request could only be partially serviced

Name	Type	Notes
ItemId	string (uuid)	Guid of the item that caused the error
MessageType	MessageType
Content	string

MessageType

CalendarService

Array of services that this service point is linked too

Name	Type	Notes
ServiceName	string	Label for the service
ServiceSmartSuiteGuid	string (uuid)	Unique id for this service
RouteCollections	CalendarRouteCollection[]

CalendarRouteCollection

Name	Type	Notes
ServicePointAddress	string	The address of the related ServicePoint
Name	string	Route collection label
RouteCollectionRevision	integer (int32)	Route collection revision, 0 = 1st
RouteCollectionGuid	string (uuid)	Unique id of the route collection
NextPlannedServiceDates	PlannedServiceDate[]	Returns the next 6 planned service dates
RouteName	string	Name of the route this service point is assigned too in the route collection
RouteIdentity	string	Name of the route this service point is assigned too in the route collection
RouteGuid	string (uuid)	Name of the route this service point is assigned too in the route collection
LastServiced	string (date-time)	Date and time the service point was last serviced if known
LastPlannedServiceDate	string (date-time)	Date the service was last planned to take place
ServicePointReports	ServicePointReport[]	Recent service point reports
ServicePointActions	ServicePointAction[]	Recent service point actions
RouteSegmentReports	RouteSegmentReport[]	Recent route segment reports

PlannedServiceDate

Returns the next 6 planned service dates

Name	Type	Notes
PlannedDate	string (date-time)	Date of next planned service
OriginalDate	string (date-time)	If substituted date, this is the original date
SubstitutionReason	string	If substituded date, the reason for the substitution

ServicePointReport

Recent service point reports

Name	Type	Notes
ReportId	string (uuid)	The unique identifier for the report.
ReportedAt	string (date-time)	The date and time when the report was made.
ReportType	ReportType[]	The Type of Report.
ReportComment	string	Any user entered comments about the report.
Operator	Operator[]	The Mobile App Operator.
Vehicle	Vehicle[]	The Mobile App Vehicle.
LocationReportMadeFrom	Location[]	Geographical location at a given point in time. Typically from a GNSS / GPS device
RouteContext	RouteContext[]	RouteContext class that carries additional data to Report, that is specific to a route.
ServicePoint	ServicePoint[]	ServicePoint class.

ReportType

The Type of Report.

Name	Type	Notes
Label	string	A Label explaining the type of report.
Collection	string	The Collection that the report type belongs to.
Category	string	The category of the report.

Operator

The Mobile App Operator.

Name	Type	Notes
Name	string	The name of the selected operator.
LoginName	string	The login name of the selected operator.
SmartSuiteGuid	string (uuid)	The identity of the selected operator.

Vehicle

The Mobile App Vehicle.

Name	Type	Notes
SmartSuiteGuid	string (uuid)	Unique guid of the vehicle in SmartSuite
Name	string	The name of the selected vehicle.
Identity	string	The identity of the selected vehicle.

Location

Geographical location at a given point in time. Typically from a GNSS / GPS device

Name	Type	Notes
Longitude	number (double)	East/West Longitude in Decimal Degrees
Latitude	number (double)	North/South Latitude in Decimal Degrees

RouteContext

RouteContext class that carries additional data to Report, that is specific to a route.

Name	Type	Notes
RouteName	string	The name of the route that is associated with the report.
RouteSmartSuiteGuid	string (uuid)	The identity guid of the route that is associated with the report.
RouteIdentity	string	The identity of the route that is associated with the report.
RouteCollectionName	string	The name of the route collection that is associated with the report.
RouteCollectionSmartSuiteGuid	string (uuid)	The identity of the route collection that is associated with the report.
ServiceName	string	The name of the service that is associated with the report.
ServiceSmartSuiteGuid	string (uuid)	The identity of the service that is associated with the report.

ServicePoint

ServicePoint class.

Name	Type	Notes
ServicePointGuid	string (uuid)	The unique guid of the Service Point in SmartSuite
ServicePointIdentity	string	The identity of the Service Point in SmartSuite as specified when the data was uploaded. Typically a UPRN or customer id number.
ServicePointAddress	string	The address of the service point.
ServicePointComment	string	A comment about the service point.
RouteServicePointComment	string	A comment about the route service point.
AccountId	string	The AccountId of this service point.
CompanyName	string	Optional CompanyName
CustomerName	string	Optional CustomerName

ServicePointAction

Recent service point actions

Name	Type	Notes
ActionId	string (uuid)	The unique identifier for the action.
ServicePoint	ServicePoint[]	ServicePoint class.
Action	string	The action.
ActionedAt	string (date-time)	When the action was actioned.
Operator	Operator[]	The Mobile App Operator.
Vehicle	Vehicle[]	The Mobile App Vehicle.
RouteContext	RouteContext[]	RouteContext class that carries additional data to Report, that is specific to a route.
LocationActionMade	Location[]	Geographical location at a given point in time. Typically from a GNSS / GPS device

RouteSegmentReport

Recent route segment reports

Name	Type	Notes
ReportId	string (uuid)	The unique identifier for the report.
ReportedAt	string (date-time)	The date and time when the report was made.
ReportType	ReportType[]	The Type of Report.
ReportComment	string	Any user entered comments about the report.
Operator	Operator[]	The Mobile App Operator.
Vehicle	Vehicle[]	The Mobile App Vehicle.
LocationReportMadeFrom	Location[]	Geographical location at a given point in time. Typically from a GNSS / GPS device
RouteContext	RouteContext[]	RouteContext class that carries additional data to Report, that is specific to a route.
RouteSegmentId	string (uuid)	The unique ID of the Route Segment.
RouteSegmentAddress	string	The address of the Route Segment.
ServicePoints	ServicePoint[]	The associated Service Points.
RouteSegmentComment	string	A comment about the Route Segment.
RoadSegmentComment	string	A comment about the Road Segment.

GetServiceStatusResponse

Container for a service status message

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
AcceptingRequests	boolean	Boolean flag indiciating is the service is receiving requests at this time.
UpdatedAt	string (date-time)	Date/Time in UTC that the status was last checked
Message	string	Current service message
ApiVersion	string	The version number of the current API Executing Assembly

GetApiKeyDetailsResponse

Information about the current API Key provided to access the API

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
Name	string	Application Name
Created	string (date-time)	Date time the API Key entity was saved into the solution.
TechnicalContactName	string	Designated technical contact name
TechnicalContactEmail	string	Designated technical contact email address
TechnicalContactPhone	string	Designated technical contact phone number

CreateJobRequest

Name	Type	Notes
Version	string
Identity	string	Optional - Identity, must be unique else the job will be rejected, is optional in which case an identity will be generated by SmartSuite
Location	Location[]	Geographical location at a given point in time. Typically from a GNSS / GPS device
JobType	string (uuid)	Required - The guid of the job type, job types are available by calling FetchJobTypes method
ReportedAt	string (date-time)	Optional - Date/Time that the reports was made resulting in the job, used for SLA calculations only
TargetCompletion	string (date-time)	Optional - Date/Time that the job should be completed by, if null, then the value will be calculate from the JobType TargetCompletion days, hours, minutes added to Now.
Details	string	Optional - Additional details about the job.
ServicePointIdentity	string	Optional - Linking identity to service points, this maybe a UPRN or other reference shared with service points, it does not have to match a service point known to SmartSuite, but additional functionality will be available where it does.

GetJobTypesResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
JobTypes	JobType[]	list of the Job Types available in smartsuite

JobType

list of the Job Types available in smartsuite

Name	Type	Notes
UniqueGuid	string (uuid)
Label	string
Description	string

GetJobStatusesRequest

Name	Type	Notes
Version	string
JobIdentities	array	Required - list of job identities to fetch status for.

GetJobTypesRequest

Name	Type	Notes
Version	string

GetAdhocReportsRequest

The Request DTO for Adhoc Reports

Name	Type	Notes
Version	string
From	string (date-time)	Find reports after and including this date time
To	string (date-time)	Find reports before and including this date time

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

GetServicePointReportsRequest

Name	Type	Notes
Version	string
From	string (date-time)	Find reports after and including this date time
To	string (date-time)	Find reports before and including this date time

GetServicePointReportsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
From	string (date-time)	The reports are after this date time
To	string (date-time)	The reports are before this date time
Reports	ServicePointReport[]	The list of retrieved Service Point reports.

GetRouteSegmentReportsRequest

Name	Type	Notes
Version	string
From	string (date-time)	Find reports after and including this date time
To	string (date-time)	Find reports before and including this date time

GetRouteSegmentReportsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
From	string (date-time)	The reports are after this date time
To	string (date-time)	The reports are before this date time
Reports	RouteSegmentReport[]	The list of retrieved Route Segment reports.

GetServicePointActionsRequest

Name	Type	Notes
Version	string
From	string (date-time)	Find reports after and including this date time
To	string (date-time)	Find reports before and including this date time

GetServicePointActionsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
From	string (date-time)	The reports are after this date time
To	string (date-time)	The reports are before this date time
Actions	ServicePointAction[]	The list of retrieved Service Point actions.

GetServicePointServicedEventsRequest

Name	Type	Notes
Version	string
From	string (date-time)	Find reports after and including this date time
To	string (date-time)	Find reports before and including this date time

GetServicePointServicedEventsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
From	string (date-time)	The reports are after this date time
To	string (date-time)	The reports are before this date time
Events	ServicePointServicedEvent[]	The list of retrieved Service Point serviced events.

ServicePointServicedEvent

The list of retrieved Service Point serviced events.

Name	Type	Notes
ServicedEventId	string (uuid)	The unique identifier for the serviced event.
ServicePoint	ServicePoint[]	ServicePoint class.
ServicedStatus	string	The type of the serviced event.
Overridden	boolean	Whether the serviced event was due to the operator of the mobile app overriding the serviced status.
ServicedEventAt	string (date-time)	When the serviced event was made.
Operator	Operator[]	The Mobile App Operator.
Vehicle	Vehicle[]	The Mobile App Vehicle.
RouteContext	RouteContext[]	RouteContext class that carries additional data to Report, that is specific to a route.
LocationServicedEventMade	Location[]	Geographical location at a given point in time. Typically from a GNSS / GPS device
Report	ServicePointReport[]	ServicePointReport class

GetRouteDetailsRequest

Name	Type	Notes
Version	string
RouteIdentity	string	An identity that the organisation choose for a route, sometimes this will be duplicated in label, other times it maybe a shortened form.
RouteCollectionName	string	Displayable name for this set of routes.
RouteCollectionRevision	integer (int64)	A version number that is incremented on each replacement made of the route collection entity
ServiceName	string	Name for the service, unique to the organisation

GetRouteDetailsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
Route	Route[]	A route is a named, ordered list of places to visit. In Street routes like street sweeping and winter maintenance this is RoadSegments visited in particular directions. In ServicePoint routes like waste collection, meter reading, inspection the places are point locations like a house, road side cabinet or sign post.
RouteCollection	RouteCollection[]	Collection of routes that typically are all similar vehicles
Service	Service[]	A container for route collections
RouteSequence	RouteSegment[]	A series of sections within a route

Route

A route is a named, ordered list of places to visit. In Street routes like street sweeping and winter maintenance this is RoadSegments visited in particular directions. In ServicePoint routes like waste collection, meter reading, inspection the places are point locations like a house, road side cabinet or sign post.

Name	Type	Notes
SmartSuiteId	string (uuid)	Smart Suite's unique reference for this object
Identity	string	Mandatory - An identity that the organisation choose for a route, sometimes this will be duplicated in name, other times it maybe a shortened form.
Name	string	Displayable label for this route.

RouteCollection

Collection of routes that typically are all similar vehicles

Name	Type	Notes
SmartSuiteId	string (uuid)	Smart Suite's unique reference for this object
Identity	string
Revision	integer (int64)	A version number that is incremented on each replacement made of this entity.

Service

A container for route collections

Name	Type	Notes
SmartSuiteId	string (uuid)	Smart Suite's unique reference for this object
Name	string	Name for this service.

RouteSegment

A series of sections within a route

Name	Type	Notes
SmartSuiteId	string (uuid)	Smart Suite's unique reference for this object
Comment	string
Sequence	integer (int64)	Numeric order this road segment should be visited in.
RoadSegmentId	string (uuid)
RoadSegmentIdentity	string
RoadSegmentName	string	Common name for the street, road or path
RoadSegmentComment	string
RouteServicePoints	RouteServicePoint[]

RouteServicePoint

Name	Type	Notes
SmartSuiteId	string (uuid)	Smart Suite's unique reference for this object
Sequence	integer (int64)	Sequence number of the stop
Action	string	Additional action to take at a service point and acknowledge. When set, mobile provides option to operator to record that the action took place.
Comment	string	Note that relates to the servicing of this point, could be the number of bins, or access code to a bin store.
ServicePointIdentity	string	Organisation unique identity of the Service Point asset.
ServicePointAddress	string	Street address or partial street address for the location
ServicePointComment	string

GetServicePointRequest

Name	Type	Notes
Version	string
ServicePointIdentity	string	The identity of the Service Point in SmartSuite as specified when the data was uploaded. Typically a UPRN or customer id number.

GetServicePointResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
ServicePoint	ServicePoint[]	ServicePoint class.

GetRouteServicePointV2Request

Name	Type	Notes
Version	string
ServicePointIdentity	string	Service Point Identity reference, typically a UPRN

GetRouteServicePointV2Response

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
ServicePoints	ServicePointData[]	Service Point Identity reference, typically a UPRN

ServicePointData

Service Point Identity reference, typically a UPRN

Name	Type	Notes
ServicePointSmartSuiteGuid	string (uuid)
ServicePointAddress	string
ServicePointLongitude	number (double)
ServicePointLatitude	number (double)
AccountId	string
ServicePointComment	string
RouteServicePoints	InnerRouteServicePointData[]

InnerRouteServicePointData

Name	Type	Notes
RouteSmartSuiteGuid	string (uuid)
RouteName	string
RouteServicePointSmartSuiteGuid	string (uuid)
RouteServicePointComment	string
Action	string

GetRouteServicePointRequest

Name	Type	Notes
Version	string
ServicePointIdentity	string	Service Point Identity reference, typically a UPRN

GetRouteServicePointResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
ServicePointIdentity	string	The identity of the Service Point in SmartSuite as specified when the data was uploaded. Typically a UPRN or customer id number.
Services	ServiceData[]	Service Point Identity reference, typically a UPRN

ServiceData

Service Point Identity reference, typically a UPRN

Name	Type	Notes
ServiceName	string	Name for this service.
ServiceSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for this object
RouteCollections	RouteCollectionData[]	The list of associated RouteCollections.

RouteCollectionData

The list of associated RouteCollections.

Name	Type	Notes
RouteCollectionRevision	integer (int32)	A version number that is incremented on each replacement made of this entity.
RouteCollectionName	string	The name of this RouteCollection.
RouteCollectionSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for this object
Routes	RouteData[]	The list of associated Routes.

RouteData

The list of associated Routes.

Name	Type	Notes
RouteName	string	Displayable label for this route.
RouteSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for this Route.
RouteIdentity	string	Mandatory - An identity that the organisation choose for a route, sometimes this will be duplicated in name, other times it maybe a shortened form.
RouteSegments	RouteSegmentData[]	The list of RouteSegments of which this Route is composed.

RouteSegmentData

The list of RouteSegments of which this Route is composed.

Name	Type	Notes
RoadSegmentComment	string	Note that relates to the servicing of the related RoadSegment
RoadSegmentAddress	string	Street address or partial street address for the location
RouteSegmentSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for this RouteSegment
RouteSegmentComment	string	Note that relates to the servicing of the related RouteSegment
RouteServicePoints	RouteServicePointData[]	List of associated RouteServices.

RouteServicePointData

List of associated RouteServices.

Name	Type	Notes
RouteServicePointSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for this RouteServicePoint
RouteServicePointComment	string	A textual comment relevant to the RouteSegment
ServicePointSmartSuiteGuid	string (uuid)	Smart Suite's unique reference for the related ServicePoint
ServicePointAddress	string	Street address or partial street address for the location
ServicePointComment	string	Note that relates to the servicing of this point, could be the number of bins, or access code to a bin store.
ServicePointLongitude	integer (int32)	East/West Longitude in Decimal Degrees
ServicePointLatitude	integer (int32)	North/South Latitude in Decimal Degrees
AccountId	string	AccountId of the related ServicePoint
CompanyName	string	Optional CompanyName of the related ServicePoint
CustomerName	string	Optional CustomerName of the related ServicePoint
Action	string	Optional Action of the related ServicePoint

UpdateRouteServicePointsRequest

Request to Update Route Service Points properties. Supports updating the Service Comment and Action on 1 or more Route Service Points If the the Service Comment or Action needs updating for multiple services, then 1 update object per service will be necessary.

Name	Type	Notes
Version	string
Updates	RouteServicePointUpdate[]	Array of update requests

RouteServicePointUpdate

Array of update requests

Name	Type	Notes
Identity	string	Identity of the service point the route service point relates too, typically a UPRN or organisation wide unique identifier for the location or customer.
ServiceName	string	Service to be updated.
ServiceComment	string	Null will leave the property unchanged, empty to clear the Service Comment, otherwise replaced by value Service Comment prompt the operator with additional information about the customer.
Action	string	Null will leave the property unchanged, empty to clear the Action, otherwise replaced by value. Actions are tasks for the operator to confirm whilst servicing the customer.
SuspensionReason	string	Null if the SuspendedAt property is null otherwise, reflects the reason for suspension.
SuspendedAt	string (date-time)	Set to the datetime we'd like the service point suspended.
IncludeSuspension	boolean	Set to true if we want to processs suspension AND servicecomment/ action

UpdateRouteServicePointsResponse

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
UpdateStates	RouteServicePointUpdateState[]	Array of states for each requested update

RouteServicePointUpdateState

Array of states for each requested update

Name	Type	Notes
Identity	string	Identity from the request
Service	string	Service from the request
State	string	One of changed, notchanged, notfound Changed is returned where 1 or more Route Service Points were found and atleast 1 was updated. Not Changed is returned where 1 or more Route Service Points were found, but no updates were necessary. Not Found is returned if no Route Service Points were found on the service requested.

GetServicePointsRequest

Class to encapsulate the servicepoint request data.

Name	Type	Notes
Version	string
ServiceName	string	The name of the Service in SmartSuite i.e. "Food Waste Trial".
RouteCollectionName	string	The name of the RouteCollection within the SmartSuite service.

GetServicePointsResponse

Class to encapsulate the servicepoint and route data for a service.

Name	Type	Notes
Version	string
ResponseDateTime	string (date-time)	Service side date/time in UTC
Messages	Message[]	Returns information about part errors/warnings, if a request could only be partially serviced
Name	string
UniqueGuid	string (uuid)
Substitutions	Substitution[]
RouteCollections	InnerRouteCollection[]

Substitution

Name	Type	Notes
FromDate	string (date-time)
ToDate	string (date-time)
Reason	string

InnerRouteCollection

Name	Type	Notes
UniqueGuid	string (uuid)
Name	string
Revision	integer (int32)
Start	string (date-time)
End	string (date-time)
Frequency	integer (int32)
Routes	InnerRoute[]

InnerRoute

Name	Type	Notes
UniqueGuid	string (uuid)
Identity	string
Label	string
DayOfWeek	integer (int32)
WeekInCycle	integer (int32)
ServicePointData	InnerServicePoint[]

InnerServicePoint

Name	Type	Notes
UniqueGuid	string (uuid)
Identity	string
Seq	integer (int64)
PAON	string
SAON	string
Road	string
Locality	string
Town	string
AdminArea	string
Region	string
Postcode	string
Lat	number (double)
Lon	number (double)
AltName	string
Level	string
AccId	string
Customer	string
Company	string