SmartSuite_IntegrationAPI

Calendar

Fetch

Request

POST /Calendar/Fetch?v

Parameters

Name	Type	Value	Notes
*v	string	1.0
body

Responses

Status Code	Description	Samples
200	Success

IntegrationAPI

Status

Return the status of the Integration API Service

No permissions required

Request

GET /IntegrationAPI/Status?v

Parameters

Name	Type	Value	Notes
*v	string	1.0	No permissions required

Responses

Status Code	Description	Samples
200	Success

GetApiKeyDetails

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

Request

GET /IntegrationAPI/GetApiKeyDetails?v

Parameters

Name	Type	Value	Notes
*v	string	1.0

Responses

Status Code	Description	Samples
200	Success

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	Value	Notes
*v	string	1.0	This endpoint supported in API Version 1.0. Required Permissions: tbc
body			The request DTO of type ISL.SmartSuite.IntegrationApi.ApplicationServices.Jobs.Services.CreateJobRequest.

Responses

Status Code	Description	Samples
200	Success
401	Unauthorized
403	Forbidden

FetchJobStatuses

Fetch Job Statuses

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

Request

POST /Jobs/FetchJobStatuses?v

Parameters

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

Responses

Status Code	Description	Samples
200	Success
401	Unauthorized
403	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	Value	Notes
*v	string	1.0	This endpoint supported in API Version 1.0. Required Permissions: tbc
body			The request DTO of type ISL.SmartSuite.IntegrationApi.ApplicationServices.Jobs.Services.GetJobTypesRequest.

Responses

Status Code	Description	Samples
200	Success
401	Unauthorized
403	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	Value	Notes
*v	string	1.0	This endpoint supported in API Version 1.0. Required Permissions: REPORTING_REPORTS_VIEW, SMARTSUITE_MOBILE_OPERATORS_LIST, SMARTSUITE_MOBILE_VEHICLES_LIST
body			The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetAdhocReportsRequest.

Responses

Status Code	Description	Samples
400	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	Value	Notes
*v	string	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			The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointReportsRequest.

Responses

Status Code	Description	Samples
200	Success

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	Value	Notes
*v	string	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			The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetRouteSegmentReportsRequest.

Responses

Status Code	Description	Samples
200	Success

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	Value	Notes
*v	string	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			The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointActionsRequest.

Responses

Status Code	Description	Samples
200	Success

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	Value	Notes
*v	string	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			The request DTO of type ISL.SmartSuite.IntegrationApi.Models.Reporting.GetServicePointServicedEventsRequest.

Responses

Status Code	Description	Samples
200	Success

Route

FetchRouteDetails

Fetch Route Details.

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

Request

POST /Route/FetchRouteDetails?v

Parameters

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

Responses

Status Code	Description	Samples
200	Success

FetchServicePoint

Fetch Route Details.

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

Request

POST /Route/FetchServicePoint?v

Parameters

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

Responses

Status Code	Description	Samples
200	Success

RouteServicePoint

FetchRouteServicePoint

Fetch details about a Route Service Point

Request

POST /RouteServicePoint/FetchRouteServicePoint?v

Parameters

Name	Type	Value	Notes
*v	string	1.0
body

Responses

Status Code	Description	Samples
200	Success

UpdateRouteServicePoints

Update properties of one or more Route Service Points

Request

POST /RouteServicePoint/UpdateRouteServicePoints?v

Parameters

Name	Type	Value	Notes
*v	string	1.0
body

Responses

Status Code	Description	Samples
200	Success