Actsoft Mobile Workforce Plus

Actsoft Mobile Workforce Plus is an all-in-one service management platform that helps you more effectively manage your remote teams of employees and general business operations away from the office. As a cloud-based solution, WFM enables remote data collection and displays it via its web app dashboard, providing managers with the additional insight they need to create smarter strategies for increased efficiency, productivity, and reduced costs while coordinating their mobile workforces.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Actsoft Support
URL https://www.actsoft.com/self-help-wizards
Email support@actsoft.com
Connector Metadata
Publisher Actsoft
Website https://www.actsoft.com/
Privacy policy http://www.actsoft.com/privacy
Categories Business Management;Human Resources

Provide a detailed description here, distinct from your connector's description, of the value that the connector offers users and a high-level overview of functionality that the connector supports. This description should be no more than one paragraph of eight sentences.

Prerequisites

Provide information about any prerequisites that are required to use this connector. For example, an account on your website or a paid service plan.

How to get credentials

Provide detailed information about how a user can get credentials to use the connector. Where possible, this should be step-by-step instructions with links pointing to relevant parts of your website.

If your connector doesn't require authentication, this section can be removed.

Get started with your connector

Provide users with a step-by-step process for getting started with your connector. This is where you should highlight common use cases, such as your expected popular triggers and actions, and how they can help in automation scenarios. Include images where possible.

Known issues and limitations

If your connector has any known issues and limitations, include a detailed description of them here. This information should be as robust as possible so users have plenty of information should they run into problems. If any workarounds are known, include them here.

Common errors and remedies

Highlight any errors that might commonly occur when using the connector (such as HTTP status code errors), and what the user should do to resolve the error.

FAQ

Provide a breakdown of frequently asked questions and their respective answers here. This can cover FAQs about interacting with the underlying service or about the connector itself.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Activate a user

Activates an existing user by its Id.

Activate a vehicle

Activate a vehicle by ID.

Create a client

Creates a new client.

Create a form

Adds a new form.

Create a geofence

Creates a new geofence.

Create a user

Creates a new user.

Create a vehicle

Creates a vehicle.

Create an order

Adds a new order.

Create or update a custom event definition

Creates or updates a custom event definition.

Create or update custom list record

Creates or updates custom list data record. The value of unique column can be omitted, but if present, it should match the Unique ID value in the query parameter.

Deactivate a user

Deactivates an existing user by its Id.

Deactivate a vehicle

Deactivate a vehicle by ID.

Delete a client

Deletes an existing client by its Id.

Delete a custom event definition

Deletes a custom event definition.

Delete a geofence

Deletes an existing geofence by its Id.

Delete a vehicle

Delete a vehicle by ID.

Delete custom list record

Deletes existing record in custom list by its customListId and id. id - is unique value of custom list record Errors: 404 - customListId or id not found.

Get a client

Retrieves a client object by its Id.

Get a custom event definition by ID

Retrieves a single custom event definition by ID.

Get a form

Retrieves a form by its Id.

Get a geofence

Retrieves a geofence by its id.

Get a list of clients

Retrieves a list of clients. You can specify the number of pages returned and the number of elements per page. The results are automatically sorted by Name, and in ascending order. Sort parameters are not configurable.

Get a list of custom event definitions

Retrieves a list of custom event definitions.

Get a list of event web hook subscriptions

Retrieves a list of event web hook subscriptions. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by SubscriptionId, and in ascending order. Sort parameters are not configurable.

Get a list of events

Retrieves a list of events for a specific time period. You can specify the number of pages returned and the number of elements per page. Filter by event type to get specific events. Vehicle events can be returned for an employee if the employee is associated with the vehicle.

Get a list of forms

Retrieves a list of forms using any of the filters from the request parameters shown below. You can specify the number of pages returned and the number of elements per page. The results are automatically sorted by SubmittedTime, and in descending order. Sort parameters are not configurable.

Get a list of geofences

Retrieves a list of geofences. You can specify the number of pages returned and the number of elements per page, as well as whether the geofence coordinates are metric. The results are automatically sorted by Name, and in ascending order. Sort parameters are not configurable.

Get a list of orders

Retrieves a list of orders using the filters from the request parameters shown below. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by Client.Name, and in ascending order. Sort parameters are not configurable.

Get a list of subscriptions

Retrieves a list of web hook subscriptions. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by SubscriptionId, and in ascending order. Sort parameters are not configurable.

Get a list of timekeeping entries

Retrieves a list of timekeeping entries based on date range. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by ClockInTime, and then by TimekeepingStatusId, and in ascending order. Sort parameters are not configurable.

Get a list of trips

Retrieves a list of trips for a specific time period. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by StartUtcTIme, and in ascending order. Sort parameters are not configurable.

Get a list of users

Retrieves a list of clients. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by UserId, and in ascending order. Sort parameters are not configurable.

Get a timekeeping entry

Retrieves an entry by its Id.

Get a user

Gets a user by its Id.

Get a vehicle by ID

Retrieves a single vehicle by ID.

Get a vehicles list

Retrieves a vehicles list.

Get an order

Gets an existing order by its Id.

Get custom list data by CustomListID

Retrieves all the data records in a single custom list using the CustomListID. Results are sorted by column, and paging is supported. Errors: 404 - there is no custom list for provided customListId.

Get custom list definitions

Retrieves a Custom List definition listing. The definition listing contains the CustomListID, Name and Version for all existing custom lists.

Get custom list fields listing by CustomListID

Retrieves a list of fields for a single custom list, using the CustomListID.

Get GPS data entries

Retrieves GPS data entries for a specified date range. Also returns a continuation token and a link to get the next data portion. You can specify the number of pages returned and the number of elements per page.

Positions for deleted users/vehicles are not returned. However, if the user/vehicle existed when data was requested and was later removed, then data for the user/vehicle requested by a continuation token will be returned.

Results are automatically sorted by UtcTime, and in ascending order. Sort parameters are not configurable.

Get minor version

Returns the current minor version of API.

Get single record from custom list

Retrieves single custom list data record found by CustomListId and unique column value. Errors: 404 - there is no custom list record for provided customListId and unique column value

Partial update a vehicle

Partial update a vehicle by ID.

Resets event web hook subscription status

Changes subscription status to the status = 1 ("Running").

Resets subscription status

Changes subscription status to the status = 1 ("Running").

Submit event

Submits event.

Subscribe GPS data web hook

Adds new GPS Tracking data (GPS positions) web hook. Web hooks allow you to receive GPS positions occurring on a specified URL.

Subscribe to events web hook

Adds new events web hook subscription. Web hooks allow you to receive automatic notifications on company events occurring on a specified URL.

Unsubscribe from events web hook

Deletes an events web hook subscription by its ID.

Unsubscribe GPS data web hook

Deletes a GPS data web hook subscription by its ID.

Update a client

Updates an existing client.

Update a user

Updates an existing user.

Update a vehicle

Update a vehicle by ID.

Update an existing geofence

Updates an existing geofence by its Id.

Update an order

Updates an existing order.

Update order status

Changes an existing order status.

Update part of a user

Updates part of user's properties.

Upload binary file

Use this option to upload form file attachments. Binary size is limited to 10MB. Supported file types are:

  • JPEG
  • PNG
  • MP4
Web hook callback with events feed

This example method is used by events/subscribe to post back event data feed using customer provided URL.

Webhook callback with GPS data feed

This example method is used by gpsdata/subscribe to post back data feed using customer provided URL.

Activate a user

Activates an existing user by its Id.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Activate a vehicle

Activate a vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Create a client

Creates a new client.

Parameters

Name Key Required Type Description
External Id
External Id string

External Use Id for the Client - API Extension Property.

FieldIndex
FieldIndex integer

Field index.

Value
Value

Field value.

Name
Name string

Name of the Client.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Name
Name string

Name of the ContactApiModel.

PhoneNumber
PhoneNumber string

PhoneNumber of the ContactApiModel.

Email
Email string

Email of the ContactApiModel.

geocode
geocode boolean

Should address be geocoded or not.

Returns

response
object

Create a form

Adds a new form.

Parameters

Name Key Required Type Description
ApiModuleId
ApiModuleId string

Id of the ApiModule associated with this CreateStandaloneFormApiModel.

Reviewed
Reviewed boolean

Status of the Review of this CreateStandaloneFormApiModel.

UserId
UserId integer

UserId of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

SubmittedTime
SubmittedTime True date-time

Point in time when the CreateStandaloneFormApiModel was submitted.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

ApiFieldId
ApiFieldId True string

API Field Id.

Value
Value True

Value of the FormFieldDataApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Sign" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Time when binary data were captured. Format - date-time (as date-time in RFC3339) including offset.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

ApiFieldId
ApiFieldId True string

API Field Id.

Value
Value True

Value of the FormFieldDataApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Sign" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Time when binary data were captured. Format - date-time (as date-time in RFC3339) including offset.

Returns

response
object

Create a geofence

Creates a new geofence.

Parameters

Name Key Required Type Description
GroupNames
GroupNames string
Latitude
Latitude double
Longitude
Longitude double
Name
Name string

Name of the GeofenceApiModelBase.

Type
Type string

Type of the GeofenceApiModel.

Shape
Shape integer

Shape: 0 for circle, and 1 for polygon.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Radius
Radius double

Radius of the GeofenceApiModel.

UseGeofenceAddress
UseGeofenceAddress boolean

UseGeofenceAddress of the GeofenceApiModel.

useMetric
useMetric boolean

Use metric system or not.

geocode
geocode boolean

Should address be geocoded or not.

Returns

Create a user

Creates a new user.

Parameters

Name Key Required Type Description
UserName
UserName string

UserName of the User.

Password
Password password

Password of the User.

GroupName
GroupName string

Name of Group of the User.

FirstName
FirstName string

First name of the User.

LastName
LastName string

Last name of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

Email
Email string

Email address of the User.

Phone
Phone string

Phone number of the User.

RoleId
RoleId integer

RoleId of the User - (Admin: 1, User: 3, Power User: 5).

IsActive
IsActive boolean

Active status of the User.

EPTTEnabled
EPTTEnabled boolean

Status of Enhanced Push-to-Talk feature for User: boolean.

EPTTNumber
EPTTNumber string

Phone number for Enhanced Push-to-Talk feature for User: string.

EPTTWebMDN
EPTTWebMDN string

Phone number used to Authenticate the User to the Kodiak EPTT system - Provided by Kodiak.

EPTTToken
EPTTToken string

API Token used to Authenticate the User to Kodiak EPTT system - Provided by Kodiak.

GPSEnabled
GPSEnabled boolean

Status of GPS Feature for the User.

MobileOnly
MobileOnly boolean

Status of desktop web application access for CAB - (No WebApp Access: True, Full App Access: False).

LicenseType
LicenseType integer

Type of License assigned to the user: - 0 for Undefined, 1 for Regular, 2 for WebOnly, and 3 for Employee.

Returns

response
object

Create a vehicle

Creates a vehicle.

Parameters

Name Key Required Type Description
Number
Number string
Name
Name string
Type
Type string
Tag
Tag string
UserEmployeeNumber
UserEmployeeNumber string
GroupName
GroupName string
TimeZone
TimeZone string
Make
Make string
Year
Year integer
Model
Model string
Color
Color string
VIN
VIN string
IsActive
IsActive boolean
DeviceType
DeviceType integer
DeviceSerialNumber
DeviceSerialNumber string

Returns

response
object

Create an order

Adds a new order.

Parameters

Name Key Required Type Description
CreatedDateTime
CreatedDateTime date-time

Point in time this CreateUpdateOrderApiModel was created.

ExternalClientId
ExternalClientId True string

External Use Id for the Client - API Extension Property.

ServiceType
ServiceType True string

Service type associated with this CreateUpdateOrderApiModel.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Name
Name string

Name of the ContactApiModel.

PhoneNumber
PhoneNumber string

PhoneNumber of the ContactApiModel.

Email
Email string

Email of the ContactApiModel.

DueDate
DueDate date-time

Point in time this BaseUpdateOrderApiModel is due for completion (obsolete in v1.3).

StartTime
StartTime date-time

Point in time this BaseUpdateOrderApiModel should start (introduced in v1.3).

EndTime
EndTime date-time

Point in time this BaseUpdateOrderApiModel should end (introduced in v1.3).

Caption
Caption True string
Value
Value

Value of the UpdateFormFieldApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Point in time value was captured.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

EmployeeNumber
EmployeeNumber True string

EmployeeNumber of the User that created this NewOrderStatusApiModel.

StatusLabel
StatusLabel True string

Label content for the StatusLabel associated with this NewOrderStatusApiModel.

StatusStartDateTime
StatusStartDateTime True date-time

Point in time this NewOrderStatusApiModel Status was started.

Caption
Caption True string
Value
Value

Value of the UpdateFormFieldApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Point in time value was captured.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

Custom fields module version.

FieldIndex
FieldIndex integer

Field index.

Value
Value

Field value.

geocode
geocode boolean

Should address be geocoded or not.

Returns

response
object

Create or update a custom event definition

Creates or updates a custom event definition.

Parameters

Name Key Required Type Description
id
id True string

Event definition id.

Name
Name string
ReverseGeocode
ReverseGeocode boolean
Name
Name string
Type
Type integer
Caption
Caption string
Required
Required boolean

Returns

response
object

Create or update custom list record

Creates or updates custom list data record. The value of unique column can be omitted, but if present, it should match the Unique ID value in the query parameter.

Parameters

Name Key Required Type Description
customListId
customListId True integer

Custom list id.

id
id True string

Unique value.

ColumnIndex
ColumnIndex integer

Custom list column index.

Caption
Caption string

Custom list column caption.

Value
Value

Custom list column value.

Deactivate a user

Deactivates an existing user by its Id.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Deactivate a vehicle

Deactivate a vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

response
integer

Delete a client

Deletes an existing client by its Id.

Parameters

Name Key Required Type Description
id
id True string

Client Id.

use-external-id
use-external-id boolean

Use external id or not.

Delete a custom event definition

Deletes a custom event definition.

Parameters

Name Key Required Type Description
id
id True string

Event definition id.

Returns

response
object

Delete a geofence

Deletes an existing geofence by its Id.

Parameters

Name Key Required Type Description
id
id True integer

Geofence Id.

Delete a vehicle

Delete a vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

response
object

Delete custom list record

Deletes existing record in custom list by its customListId and id. id - is unique value of custom list record Errors: 404 - customListId or id not found.

Parameters

Name Key Required Type Description
customListId
customListId True integer

Custom list id.

id
id True string

Unique value.

Get a client

Retrieves a client object by its Id.

Parameters

Name Key Required Type Description
id
id True string

Client Id.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Get a custom event definition by ID

Retrieves a single custom event definition by ID.

Parameters

Name Key Required Type Description
id
id True string

Event definition id.

Returns

Custom Event Definition Model.

Get a form

Retrieves a form by its Id.

Parameters

Name Key Required Type Description
id
id True integer

Form id.

Returns

Get a geofence

Retrieves a geofence by its id.

Parameters

Name Key Required Type Description
id
id True integer

External Id or InternalId depends on the value in the use-external-id parameter.

useMetric
useMetric boolean

Use metric system or not.

Returns

Get a list of clients

Retrieves a list of clients. You can specify the number of pages returned and the number of elements per page. The results are automatically sorted by Name, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
pageNumber
pageNumber integer

Start page number.

pageSize
pageSize integer

Page size.

Returns

Get a list of custom event definitions

Retrieves a list of custom event definitions.

Returns

Get a list of event web hook subscriptions

Retrieves a list of event web hook subscriptions. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by SubscriptionId, and in ascending order. Sort parameters are not configurable.

Returns

Get a list of events

Retrieves a list of events for a specific time period. You can specify the number of pages returned and the number of elements per page. Filter by event type to get specific events. Vehicle events can be returned for an employee if the employee is associated with the vehicle.

Parameters

Name Key Required Type Description
fromDate
fromDate True date-time

Date range start.

toDate
toDate True date-time

Date range end.

employeeNumber
employeeNumber string

Employee number.

vehicleNumber
vehicleNumber string

Vehicle number.

pageNumber
pageNumber integer

Start page number.

pageSize
pageSize integer

Page size.

eventType
eventType integer

Filter by event type.

employee number is specified:

  • UserEvents(0) - only user events.
  • VehicleEvents(1) - only vehicle events, including sensor events.
  • ExternalEvents(2) - only external events.

vehicle number is specified:

  • UserEvents(0) - N/A.
  • VehicleEvents(1) - only vehicle events, including sensor events.
  • ExternalEvents(2) - only external events.

Neither employee number nor vehicle number is specified:

  • UserEvents(0) - only user events.
  • VehicleEvents(1) - only vehicle events, including sensor events.
  • ExternalEvents(2) - only external events.

Returns

Get a list of forms

Retrieves a list of forms using any of the filters from the request parameters shown below. You can specify the number of pages returned and the number of elements per page. The results are automatically sorted by SubmittedTime, and in descending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
submittedStartDate
submittedStartDate True date-time

Start date of the submitted form.

submittedEndDate
submittedEndDate True date-time

End date of the submitted form.

apiModuleId
apiModuleId string

Form module Id.

employeeNumber
employeeNumber string

Employee number.

reviewed
reviewed boolean

Only retrieves reviewed forms or not. The default is null for all.

pageNumber
pageNumber integer

Starting page number. The default is 1.

pageSize
pageSize integer

Page size. The default is 1000.

Returns

Get a list of geofences

Retrieves a list of geofences. You can specify the number of pages returned and the number of elements per page, as well as whether the geofence coordinates are metric. The results are automatically sorted by Name, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
pageNumber
pageNumber integer

Start page number. The default is 1.

pageSize
pageSize integer

Page size. The default is 500.

useMetric
useMetric boolean

Use metric system or not.

Returns

Get a list of orders

Retrieves a list of orders using the filters from the request parameters shown below. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by Client.Name, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
dueDateFrom
dueDateFrom True date-time

Filter by due date start date.

dueDateTo
dueDateTo True date-time

Filter by due date end date.

employeeNumber
employeeNumber string

Filter by employee number.

pageNumber
pageNumber integer

Start Page number (default 1).

pageSize
pageSize integer

Page size (default 500).

Returns

Get a list of subscriptions

Retrieves a list of web hook subscriptions. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by SubscriptionId, and in ascending order. Sort parameters are not configurable.

Returns

Get a list of timekeeping entries

Retrieves a list of timekeeping entries based on date range. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by ClockInTime, and then by TimekeepingStatusId, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
fromDate
fromDate True date-time

Start date.

toDate
toDate True date-time

End date.

employeeNumber
employeeNumber string

Employee number.

approved
approved boolean

Filter for approved entry only.

closedOnly
closedOnly boolean

Filter for closed entry only.

excludeFormData
excludeFormData boolean

Filter for excluding form data.

pageNumber
pageNumber integer

Start Page number (default 1).

pageSize
pageSize integer

Page size (default 1000).

Returns

Get a list of trips

Retrieves a list of trips for a specific time period. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by StartUtcTIme, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
fromDate
fromDate True date-time

Date range start. Recommendation: Please use big date ranges (>=4 hours) instead of small date ranges.

toDate
toDate True date-time

Date range end. Recommendation: Please use big date ranges (>=4 hours) instead of small date ranges.

employeeNumber
employeeNumber string

Employee number.

vin
vin string

Vehicle's VIN number.

pageNumber
pageNumber integer

Start page number. The default is 1.

pageSize
pageSize integer

Page size. The default is 1000.

useMetric
useMetric boolean

Use metric system or not.

Returns

Get a list of users

Retrieves a list of clients. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by UserId, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
pageNumber
pageNumber integer

Start page number. The default is 1.

pageSize
pageSize integer

Page size. The default is 500.

Returns

Get a timekeeping entry

Retrieves an entry by its Id.

Parameters

Name Key Required Type Description
id
id True string

Id of the record.

Returns

Get a user

Gets a user by its Id.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Get a vehicle by ID

Retrieves a single vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Vehicle Data Model.

Get a vehicles list

Retrieves a vehicles list.

Parameters

Name Key Required Type Description
pageNumber
pageNumber integer

Page number.

pageSize
pageSize integer

Max number of items in a page. Default = 1000. Max value = 2000.

activeOnly
activeOnly boolean

if true - returns only active vehicles. Default value = false.

Returns

Get an order

Gets an existing order by its Id.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

include-status-history
include-status-history string

If true, response will contain all status history and form data for this order.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Get custom list data by CustomListID

Retrieves all the data records in a single custom list using the CustomListID. Results are sorted by column, and paging is supported. Errors: 404 - there is no custom list for provided customListId.

Parameters

Name Key Required Type Description
customListId
customListId True integer

Custom list id.

pageNumber
pageNumber integer

Start page number.

pageSize
pageSize integer

Page size.

Returns

Container for custom list column data array.

Get custom list definitions

Retrieves a Custom List definition listing. The definition listing contains the CustomListID, Name and Version for all existing custom lists.

Returns

Get custom list fields listing by CustomListID

Retrieves a list of fields for a single custom list, using the CustomListID.

Parameters

Name Key Required Type Description
customListId
customListId True integer

Custom list id.

Returns

Custom List Model.

Get GPS data entries

Retrieves GPS data entries for a specified date range. Also returns a continuation token and a link to get the next data portion. You can specify the number of pages returned and the number of elements per page.

Positions for deleted users/vehicles are not returned. However, if the user/vehicle existed when data was requested and was later removed, then data for the user/vehicle requested by a continuation token will be returned.

Results are automatically sorted by UtcTime, and in ascending order. Sort parameters are not configurable.

Parameters

Name Key Required Type Description
fromDate
fromDate date-time

Date range start. Recommendation: Please use big date ranges (>=4 hours) instead of small date ranges.

toDate
toDate date-time

Date range end. Recommendation: Please use big date ranges (>=4 hours) instead of small date ranges.

employeeNumber
employeeNumber string

Employee number.

vin
vin string

Vehicle's VIN number.

useMetric
useMetric boolean

Use metric system or not.

token
token string

Continuation token that is returned by the initial call, and shall be used in the successive call.

Returns

Get minor version

Returns the current minor version of API.

Get single record from custom list

Retrieves single custom list data record found by CustomListId and unique column value. Errors: 404 - there is no custom list record for provided customListId and unique column value

Parameters

Name Key Required Type Description
customListId
customListId True integer

Custom list id.

id
id True string

Unique value.

Returns

Container for custom list column data array.

Partial update a vehicle

Partial update a vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Resets event web hook subscription status

Changes subscription status to the status = 1 ("Running").

Parameters

Name Key Required Type Description
subscriptionId
subscriptionId True integer

Subscription id.

Resets subscription status

Changes subscription status to the status = 1 ("Running").

Parameters

Name Key Required Type Description
subscriptionId
subscriptionId True integer

Subscription id.

Submit event

Submits event.

Parameters

Name Key Required Type Description
EventDefinitionId
EventDefinitionId string

Event Definition Id.

EmployeeNumber
EmployeeNumber string

Employee number.

VehicleNumber
VehicleNumber string

Vehicle number.

DeviceSerialNumber
DeviceSerialNumber string

Device serial number.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Time
Time date-time

Returns

response
object

Subscribe GPS data web hook

Adds new GPS Tracking data (GPS positions) web hook. Web hooks allow you to receive GPS positions occurring on a specified URL.

Parameters

Name Key Required Type Description
Url
Url string

Url containing the address of the WebHookSubscriptionParamsApiModel.

SecurityToken
SecurityToken string

Security Token associated with this WebHookSubscriptionParamsApiModel.

Returns

Subscribe to events web hook

Adds new events web hook subscription. Web hooks allow you to receive automatic notifications on company events occurring on a specified URL.

Parameters

Name Key Required Type Description
Url
Url string

Url containing the address of the WebHookSubscriptionParamsApiModel.

SecurityToken
SecurityToken string

Security Token associated with this WebHookSubscriptionParamsApiModel.

Returns

Unsubscribe from events web hook

Deletes an events web hook subscription by its ID.

Parameters

Name Key Required Type Description
subscriptionId
subscriptionId True string

Subscription Id to delete.

Unsubscribe GPS data web hook

Deletes a GPS data web hook subscription by its ID.

Parameters

Name Key Required Type Description
subscriptionId
subscriptionId True string

Subscription Id to delete.

Update a client

Updates an existing client.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

External Id
External Id string

External Use Id for the Client - API Extension Property.

FieldIndex
FieldIndex integer

Field index.

Value
Value

Field value.

Name
Name string

Name of the Client.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Name
Name string

Name of the ContactApiModel.

PhoneNumber
PhoneNumber string

PhoneNumber of the ContactApiModel.

Email
Email string

Email of the ContactApiModel.

geocode
geocode boolean

Should address be geocoded or not.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Update a user

Updates an existing user.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

UserName
UserName string

UserName of the User.

Password
Password password

Password of the User.

GroupName
GroupName string

Name of Group of the User.

FirstName
FirstName string

First name of the User.

LastName
LastName string

Last name of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

Email
Email string

Email address of the User.

Phone
Phone string

Phone number of the User.

RoleId
RoleId integer

RoleId of the User - (Admin: 1, User: 3, Power User: 5).

IsActive
IsActive boolean

Active status of the User.

EPTTEnabled
EPTTEnabled boolean

Status of Enhanced Push-to-Talk feature for User: boolean.

EPTTNumber
EPTTNumber string

Phone number for Enhanced Push-to-Talk feature for User: string.

EPTTWebMDN
EPTTWebMDN string

Phone number used to Authenticate the User to the Kodiak EPTT system - Provided by Kodiak.

EPTTToken
EPTTToken string

API Token used to Authenticate the User to Kodiak EPTT system - Provided by Kodiak.

GPSEnabled
GPSEnabled boolean

Status of GPS Feature for the User.

MobileOnly
MobileOnly boolean

Status of desktop web application access for CAB - (No WebApp Access: True, Full App Access: False).

LicenseType
LicenseType integer

Type of License assigned to the user: - 0 for Undefined, 1 for Regular, 2 for WebOnly, and 3 for Employee.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Update a vehicle

Update a vehicle by ID.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the useExternal Id parameter.

Number
Number string
Name
Name string
Type
Type string
Tag
Tag string
UserEmployeeNumber
UserEmployeeNumber string
GroupName
GroupName string
TimeZone
TimeZone string
Make
Make string
Year
Year integer
Model
Model string
Color
Color string
VIN
VIN string
IsActive
IsActive boolean
DeviceType
DeviceType integer
DeviceSerialNumber
DeviceSerialNumber string
use-external-id
use-external-id boolean

Use external id or not.

Returns

response
integer

Update an existing geofence

Updates an existing geofence by its Id.

Parameters

Name Key Required Type Description
id
id True integer

Geofence Id.

GroupNames
GroupNames string
Latitude
Latitude double
Longitude
Longitude double
Name
Name string

Name of the GeofenceApiModelBase.

Type
Type string

Type of the GeofenceApiModel.

Shape
Shape integer

Shape: 0 for circle, and 1 for polygon.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Radius
Radius double

Radius of the GeofenceApiModel.

UseGeofenceAddress
UseGeofenceAddress boolean

UseGeofenceAddress of the GeofenceApiModel.

useMetric
useMetric boolean

Use metric system or not.

geocode
geocode boolean

Should address be geocoded or not.

Returns

Update an order

Updates an existing order.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

IsClosed
IsClosed boolean

Status showing if the UpdateOrderApiModel closed.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

Name
Name string

Name of the ContactApiModel.

PhoneNumber
PhoneNumber string

PhoneNumber of the ContactApiModel.

Email
Email string

Email of the ContactApiModel.

DueDate
DueDate date-time

Point in time this BaseUpdateOrderApiModel is due for completion (obsolete in v1.3).

StartTime
StartTime date-time

Point in time this BaseUpdateOrderApiModel should start (introduced in v1.3).

EndTime
EndTime date-time

Point in time this BaseUpdateOrderApiModel should end (introduced in v1.3).

Caption
Caption True string
Value
Value

Value of the UpdateFormFieldApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Point in time value was captured.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

EmployeeNumber
EmployeeNumber True string

EmployeeNumber of the User that created this NewOrderStatusApiModel.

StatusLabel
StatusLabel True string

Label content for the StatusLabel associated with this NewOrderStatusApiModel.

StatusStartDateTime
StatusStartDateTime True date-time

Point in time this NewOrderStatusApiModel Status was started.

Caption
Caption True string
Value
Value

Value of the UpdateFormFieldApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Point in time value was captured.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

Custom fields module version.

FieldIndex
FieldIndex integer

Field index.

Value
Value

Field value.

geocode
geocode boolean

Should address be geocoded or not.

use-external-id
use-external-id boolean

Use external id or not.

Returns

Update order status

Changes an existing order status.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

EmployeeNumber
EmployeeNumber True string

EmployeeNumber of the User that created this NewOrderStatusApiModel.

StatusLabel
StatusLabel True string

Label content for the StatusLabel associated with this NewOrderStatusApiModel.

StatusStartDateTime
StatusStartDateTime True date-time

Point in time this NewOrderStatusApiModel Status was started.

Caption
Caption True string
Value
Value

Value of the UpdateFormFieldApiModel.

"NFC" field value format: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" field value format (binary reference): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" field value format (binary reference): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

Point in time value was captured.

Latitude
Latitude double
Longitude
Longitude double
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

use-external-id
use-external-id boolean

Use external id or not.

Returns

response
integer

Update part of a user

Updates part of user's properties.

Parameters

Name Key Required Type Description
id
id True string

External Id or InternalId depends on the value in the use-external-id parameter.

use-external-id
use-external-id boolean

Use external id or not.

Returns

response
integer

Upload binary file

Use this option to upload form file attachments. Binary size is limited to 10MB. Supported file types are:

  • JPEG
  • PNG
  • MP4

Returns

response
object

Web hook callback with events feed

This example method is used by events/subscribe to post back event data feed using customer provided URL.

Parameters

Name Key Required Type Description
Id
Id string

Url containing the address of the WebHookSubscriptionParamsApiModel.

EventType
EventType integer
EventCode
EventCode string
EventTime
EventTime date-time

ISO format with Local and Offset.

DeviceId
DeviceId string

Device Id associated with the subscription.

DeviceType
DeviceType integer

Device type: Handset (0), CalAmp (1), Geotab (2), Xirgo (3).

UserId
UserId integer

User Id.

VehicleId
VehicleId integer

Vehicle Id.

UserLinkedToVehicle
UserLinkedToVehicle boolean

Whether a user linked to the vehicle.

Lat
Lat double

Latitude.

Lon
Lon double

Longitude.

CustomEventDefinitionId
CustomEventDefinitionId string

Returns

response
object

Webhook callback with GPS data feed

This example method is used by gpsdata/subscribe to post back data feed using customer provided URL.

Parameters

Name Key Required Type Description
Id
Id string

Url containing the address of the WebHookSubscriptionParamsApiModel.

DeviceId
DeviceId string

Device Id associated with the subscription.

DeviceType
DeviceType integer

Device type: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).

Timestamp
Timestamp date-time

ISO format with Local and Offset.

CompanyId
CompanyId integer

Company Id.

UserId
UserId integer

User Id.

VehicleId
VehicleId integer

Vehicle Id.

UserLinkedToVehicle
UserLinkedToVehicle boolean

Whether a user linked to the vehicle.

LocationProvider
LocationProvider string

Location provider name.

Lat
Lat double

Latitude.

Lon
Lon double

Longitude.

AccuracyFt
AccuracyFt double

Position accuracy (Feet).

AltitudeFt
AltitudeFt double

Altitude (Feet).

Heading
Heading integer

Compass direction in degrees.

SpeedMph
SpeedMph double

Speed of movement (Mph).

BatteryStatus
BatteryStatus integer

Battery status: Not charging(0), Charging(1).

BatteryLevel
BatteryLevel integer

Battery level in percent.

ActivityState
ActivityState integer

Activity state: Staying(1), Modving(2).

IsNetworkConnected
IsNetworkConnected boolean

Is the device connected to the network at the moment.

Rssi
Rssi integer

Received Signal Strength Indicator.

DOdoMl
DOdoMl double

Device Odometer (Miles).

VOdoMl
VOdoMl double

Vehicle Odometer (Miles).

Returns

response
object

Triggers

Form data poll

The Forms API polling endpoint allows your application to continually poll and process recently submitted standalone forms.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently submitted form records exist; response body will display form data.
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains the necessary parameters required to ensure forms are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by FormHeaderId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest form data change.

Order statuses poll

The Order Statuses API polling endpoint allows your application to continually poll and process recent changes to orders.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently changed order status records exist; response body will display order status data
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains those necessary to ensure order statuses are not missing from the request.

Results are sorted by ModifiedUtc and then by StatusId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest order status data change.

Orders poll

The Orders API polling endpoint allows your application to continually poll and process recent changes to orders.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently changed orders exist; response body will display order data.
  • HTTP Response code 202 No recently changed orders exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains the necessary parameters required to ensure order changes are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by OrderId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest order data change.

Timekeeping poll

The Timekeeping API polling endpoint allows your application to continually poll and process recently submitted timekeeping entries.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently submitted timekeeping records exist; response body will display timekeeping entry data.
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains those necessary to ensure timekeeping entries are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by TimekeepingStatusId and then in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest timekeeping status change.

Form data poll

The Forms API polling endpoint allows your application to continually poll and process recently submitted standalone forms.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently submitted form records exist; response body will display form data.
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains the necessary parameters required to ensure forms are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by FormHeaderId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest form data change.

Returns

Order statuses poll

The Order Statuses API polling endpoint allows your application to continually poll and process recent changes to orders.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently changed order status records exist; response body will display order status data
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains those necessary to ensure order statuses are not missing from the request.

Results are sorted by ModifiedUtc and then by StatusId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest order status data change.

Parameters

Name Key Required Type Description
excludeFormData
excludeFormData boolean

If true, FieldValues will always be an empty array.

Returns

Orders poll

The Orders API polling endpoint allows your application to continually poll and process recent changes to orders.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently changed orders exist; response body will display order data.
  • HTTP Response code 202 No recently changed orders exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains the necessary parameters required to ensure order changes are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by OrderId, in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest order data change.

Parameters

Name Key Required Type Description
excludeFormData
excludeFormData boolean

If true, OrderFormFields will always be an empty array.

excludeCustomFieldData
excludeCustomFieldData boolean

If true, CustomFields will not be returned.

Returns

Timekeeping poll

The Timekeeping API polling endpoint allows your application to continually poll and process recently submitted timekeeping entries.

Integration: This endpoint is designed to work out of the box with Microsoft Flow as a polling trigger integration. Alternatively, you may develop your own custom integration using any language.

Usage: In a typical scenario, the first request to this endpoint should not provide any parameters. There are two (2) possible successful responses:

  • HTTP Response code 200 - Recently submitted timekeeping records exist; response body will display timekeeping entry data.
  • HTTP Response code 202 No recently submitted records exist; response body will be empty.

In both cases, there are two (2) important headers in the response:

  • Location The URL for the next request.
  • Retry-After The recommended time interval in seconds for next request. For example, if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.

Note: These are just recommended values your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. Do not add more parameters to the URL, as it already contains those necessary to ensure timekeeping entries are not missing from the request.

Results are automatically sorted by ModifiedUtc and then by TimekeepingStatusId and then in ascending order. Sort parameters are not configurable. ModifiedUtc definition: internal time tag = time of latest timekeeping status change.

Parameters

Name Key Required Type Description
excludeFormData
excludeFormData boolean

If true, ClockInFormData and ClockOutFormData will always be null.

Returns

Definitions

CustomerAPI.Models.Client.ReadClientApiModel

Name Path Type Description
Id
Id integer

Id of the Client.

External Id
External Id string

External Use Id for the Client - API Extension Property.

CreatedUtc
CreatedUtc date-time

The original point in time that the Client was created.

ModifiedUtc
ModifiedUtc date-time

The last point in time that the Client was updated.

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Name
Name string

Name of the Client.

Address
Address CustomerAPI.Models.LocationApiModel
Contact
Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name Path Type Description
FieldIndex
FieldIndex integer

Field index.

Caption
Caption string

Field caption.

DataType
DataType integer

Field data type.

DateTimeFormat
DateTimeFormat integer

DateTime format.

Value
Value

Field value.

CustomerAPI.Models.LocationApiModel

Name Path Type Description
LatLon
LatLon System.Nullable_1_Actsoft.Common.Geo.LatLon_
AddressLine1
AddressLine1 string

AddressLine1 of this LocationApiModel.

AddressLine2
AddressLine2 string

AddressLine1 of this LocationApiModel.

City
City string

City of the LocationApiModel.

RegionName
RegionName string

Region Name of the LocationApiModel.

PostalCode
PostalCode string

Postal Code of the LocationApiModel.

CountryCode
CountryCode string

ISO 3166-1 alpha-2 code.

SubRegionName
SubRegionName string

SubRegion of the LocationApiModel.

SubRegionCode
SubRegionCode string

SubRegion Code of the LocationApiModel.

RegionCode
RegionCode string

Region Code of the LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Name Path Type Description
Name
Name string

Name of the ContactApiModel.

PhoneNumber
PhoneNumber string

PhoneNumber of the ContactApiModel.

Email
Email string

Email of the ContactApiModel.

System.Nullable_1_Actsoft.Common.Geo.LatLon_

Name Path Type Description
Latitude
Latitude double
Longitude
Longitude double

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Defines Custom List Definition List Item API Model.

Name Path Type Description
CustomListId
CustomListId integer

Custom List Id.

Name
Name string

Custom List Name.

Version
Version string

Custom List Version.

CustomerAPI.Models.CustomLists.CustomListApiModel

Custom List Model.

Name Path Type Description
CustomListId
CustomListId integer

Custom List Id.

Name
Name string

Custom List Name.

Version
Version string

Custom List Version.

Definition
Definition CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Defines Custom List definition API model.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Defines Custom List definition API model.

Name Path Type Description
Columns
Columns array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Custom List Columns.

UniqueColumnIndexIndex
UniqueColumnIndexIndex integer

Unique Column Index.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Defines Custom List Definition Column API Model.

Name Path Type Description
Index
Index integer

Column Index.

DataType
DataType integer

Column DataType (Text: 0, Numeric: 1, Date: 2, Time: 3, DateTime: 4, Email: 5).

Name
Name string

Column Name.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Container for custom list column data array.

Name Path Type Description
ColumnValues
ColumnValues array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Array of columns with data.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

This model defines custom list column value.

Name Path Type Description
ColumnIndex
ColumnIndex integer

Custom list column index.

Caption
Caption string

Custom list column caption.

Value
Value

Custom list column value.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Custom Event Definition Model.

Name Path Type Description
Id
Id string
Name
Name string
ReverseGeocode
ReverseGeocode boolean
Parameters
Parameters array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name Path Type Description
Name
Name string
Type
Type integer
Caption
Caption string
Required
Required boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name Path Type Description
EventId
EventId integer

Event Id.

EventType
EventType integer
EventCode
EventCode string

Event code.

EventTime
EventTime date-time

ISO format with Local and Offset.

User
User CustomerAPI.Models.UserReferenceApiModel
Vehicle
Vehicle CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle
UserLinkedToVehicle boolean

If enabled then the event's vehicle has assigned user.

Location
Location CustomerAPI.Models.LocationApiModel
PrimaryGeofence
PrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId
CustomEventDefinitionId string

External event definition Id.

EventParams
EventParams object

Event parameters.

CustomerAPI.Models.UserReferenceApiModel

Name Path Type Description
UserId
UserId integer

UserId of the User.

FirstName
FirstName string

First name of the User.

LastName
LastName string

Last name of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

GroupName
GroupName string

Name of Group assigned to the User.

CustomerAPI.Models.ReadVehicleApiModel

Name Path Type Description
VehicleId
VehicleId integer

Id of the BaseVehicleApiModel.

Name
Name string

Name of the BaseVehicleApiModel.

VIN
VIN string

Vehicle Identification Number of the BaseVehicleApiModel.

DeviceName
DeviceName string

Name of Device associated with the BaseVehicleApiModel.

SerialNumber
SerialNumber string

SerialNumber of the BaseVehicleApiModel.

GroupName
GroupName string

GroupName of the BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name Path Type Description
GeofenceId
GeofenceId integer

Id of the Geofence.

Name
Name string

Name of the Geofence.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name Path Type Description
SubscriptionId
SubscriptionId string

Id of the WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name Path Type Description
SubscriptionId
SubscriptionId string
Url
Url string
Status
Status integer

Subscription status - (Running: 1, Stopped: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name Path Type Description
Id
Id integer

Id associated with this StandaloneFormApiModel - (Legacy comment: FormHeaderId).

FormId
FormId integer

Id of the Form referenced by this StandaloneFormApiModel.

FormName
FormName string

Name of the Form referenced by this StandaloneFormApiModel.

Reviewed
Reviewed boolean

Status of the Review of this StandaloneFormApiModel.

User
User CustomerAPI.Models.UserReferenceApiModel
SubmittedTime
SubmittedTime date-time

Point in time when the StandaloneFormApiModel was submitted.

StartTime
StartTime date-time

Point in time when the StandaloneFormApiModel was started.

SubmittedLocation
SubmittedLocation CustomerAPI.Models.LocationApiModel
FormData
FormData array of CustomerAPI.Models.Forms.FormFieldDataApiModel

List of the Fields associated with this StandaloneFormApiModel.

ApiModuleId
ApiModuleId string

Id of the ApiModule associated with this StandaloneFormApiModel.

SharedUrl
SharedUrl string

Shared url of this StandaloneFormApiModel.

ReviewedByUser
ReviewedByUser CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime
ReviewedByTime date-time

Time of the form review

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name Path Type Description
Repeatables
Repeatables array of array
items
Repeatables array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id
Id string

Id of the FormFieldDataApiModel.

Value
Value

Value of the FormFieldDataApiModel.

DisplayValue
DisplayValue

DisplayValue of the FormFieldDataApiModel.

CapturedTime
CapturedTime date-time

Point in time value was captured of the FormFieldDataApiModel.

CapturedLocation
CapturedLocation CustomerAPI.Models.LocationApiModel
Caption
Caption string

Caption content of the FormFieldDataApiModel.

ApiFieldId
ApiFieldId string

Id of the ApiField of the FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name Path Type Description
Id
Id string

Id of the FormFieldDataApiModel.

Value
Value

Value of the FormFieldDataApiModel.

DisplayValue
DisplayValue

DisplayValue of the FormFieldDataApiModel.

CapturedTime
CapturedTime date-time

Point in time value was captured of the FormFieldDataApiModel.

CapturedLocation
CapturedLocation CustomerAPI.Models.LocationApiModel
Caption
Caption string

Caption content of the FormFieldDataApiModel.

ApiFieldId
ApiFieldId string

Id of the ApiField of the FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name Path Type Description
GeofenceId
GeofenceId integer

GeofenceId of the GeofenceApiModel.

CreatedUtc
CreatedUtc date-time

CreatedUtc of the GeofenceApiModel.

ModifiedUtc
ModifiedUtc date-time

ModifiedUtc of the GeofenceApiModel.

GroupNames
GroupNames array of string

GroupPaths of the GeofenceApiModel.

Name
Name string

Name of the GeofenceApiModelBase.

Type
Type string

Type of the GeofenceApiModel.

Shape
Shape integer

Shape: 0 for circle, and 1 for polygon.

Address
Address CustomerAPI.Models.LocationApiModel
Radius
Radius double

Radius of the GeofenceApiModel.

UseGeofenceAddress
UseGeofenceAddress boolean

UseGeofenceAddress of the GeofenceApiModel.

Actsoft.Common.Geo.LatLon

Name Path Type Description
Latitude
Latitude double
Longitude
Longitude double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name Path Type Description
GeofenceId
GeofenceId integer

GeofenceId of the GeofenceApiModel.

CreatedUtc
CreatedUtc date-time

CreatedUtc of the GeofenceApiModel.

ModifiedUtc
ModifiedUtc date-time

ModifiedUtc of the GeofenceApiModel.

GroupNames
GroupNames array of string

GroupPaths of the GeofenceApiModel.

Polygon
Polygon array of Actsoft.Common.Geo.LatLon

Polygon points. Should be filled when Shape equals 1.

Name
Name string

Name of the GeofenceApiModelBase.

Type
Type string

Type of the GeofenceApiModel.

Shape
Shape integer

Shape: 0 for circle, and 1 for polygon.

Address
Address CustomerAPI.Models.LocationApiModel
Radius
Radius double

Radius of the GeofenceApiModel.

UseGeofenceAddress
UseGeofenceAddress boolean

UseGeofenceAddress of the GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Name Path Type Description
OrderId
OrderId integer

Id of the OrderBaseApiModel.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

DueDate
DueDate date-time

Point in time this OrderBaseApiModel is due for completion (obsolete in v1.3).

StartTime
StartTime date-time

Point in time this OrderBaseApiModel should start (introduced in v1.3).

EndTime
EndTime date-time

Point in time this OrderBaseApiModel is due for completion (introduced in v1.3).

ServiceType
ServiceType string

ServiceType associated with this OrderBaseApiModel.

CreatedUTCDate
CreatedUTCDate date-time

Point in time this OrderBaseApiModel was created.

OrderNumber
OrderNumber string

Order Number associated with this OrderBaseApiModel.

IsClosed
IsClosed boolean

Status showing if the OrderBaseApiModel is closed.

Status
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

External Use Id for the Client - API Extension Property.

ClientId
ClientId integer

internal Use Id for the Client - API Extension Property.

Client
Client CustomerAPI.Models.Client.BaseClientApiModel
ApiServiceId
ApiServiceId string

Id of the ApiService Associated with this OrderBaseApiModel.

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

Custom fields module version.

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

CustomerAPI.Models.Order.OrderStatusApiModel

Name Path Type Description
StatusIndex
StatusIndex integer

Index of the OrderStatusApiModel.

StatusType
StatusType integer

Order status: 0 for new order, 1 for dispatched, 2 for in-progress, 3 for complete, and 4 for cancelled.

StatusLabel
StatusLabel string

Label content of the OrderStatusApiModel.

StatusId
StatusId integer

Id of the OrderStatusApiModel.

StatusStartDateTime
StatusStartDateTime date-time

Point in time of Start of the OrderStatusApiModel.

User
User CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Client.BaseClientApiModel

Name Path Type Description
Name
Name string

Name of the Client.

Address
Address CustomerAPI.Models.LocationApiModel
Contact
Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name Path Type Description
StatusHistory
StatusHistory array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

List of the OrderStatusListItems Associated with this OrderApiModel.

OrderFormFields
OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
OrderId
OrderId integer

Id of the OrderBaseApiModel.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

DueDate
DueDate date-time

Point in time this OrderBaseApiModel is due for completion (obsolete in v1.3).

StartTime
StartTime date-time

Point in time this OrderBaseApiModel should start (introduced in v1.3).

EndTime
EndTime date-time

Point in time this OrderBaseApiModel is due for completion (introduced in v1.3).

ServiceType
ServiceType string

ServiceType associated with this OrderBaseApiModel.

CreatedUTCDate
CreatedUTCDate date-time

Point in time this OrderBaseApiModel was created.

OrderNumber
OrderNumber string

Order Number associated with this OrderBaseApiModel.

IsClosed
IsClosed boolean

Status showing if the OrderBaseApiModel is closed.

Status
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

External Use Id for the Client - API Extension Property.

ClientId
ClientId integer

internal Use Id for the Client - API Extension Property.

Client
Client CustomerAPI.Models.Client.BaseClientApiModel
ApiServiceId
ApiServiceId string

Id of the ApiService Associated with this OrderBaseApiModel.

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

Custom fields module version.

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name Path Type Description
StatusStartDateTime
StatusStartDateTime date-time

Point in time this OrderStatusHistoryListItemApiModel Status was started.

StatusEndDateTime
StatusEndDateTime date-time

Point in time this OrderStatusHistoryListItemApiModel Status was ended.

StatusId
StatusId integer

Id associated with this OrderStatusHistoryListItemApiModel.

StatusIndex
StatusIndex integer

Index associated with this OrderStatusHistoryListItemApiModel.

StatusLabel
StatusLabel string

Label content associated with this OrderStatusHistoryListItemApiModel.

StatusType
StatusType integer

Order status: 0 for new order, 1 for dispatched, 2 for in-progress, 3 for complete, and 4 for cancelled.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

OrderId
OrderId integer

OrderId associated with this OrderStatusHistoryListItemApiModel.

User
User CustomerAPI.Models.UserReferenceApiModel
StartAddress
StartAddress CustomerAPI.Models.LocationApiModel
EndAddress
EndAddress CustomerAPI.Models.LocationApiModel
ApiServiceId
ApiServiceId string

Id of the ApiService associated with this OrderStatusHistoryListItemApiModel.

FieldValues
FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name Path Type Description
OrderFormFields
OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
OrderId
OrderId integer

Id of the OrderBaseApiModel.

ExternalOrderId
ExternalOrderId string

External Use OrderId for the Client - API Extension Property.

DueDate
DueDate date-time

Point in time this OrderBaseApiModel is due for completion (obsolete in v1.3).

StartTime
StartTime date-time

Point in time this OrderBaseApiModel should start (introduced in v1.3).

EndTime
EndTime date-time

Point in time this OrderBaseApiModel is due for completion (introduced in v1.3).

ServiceType
ServiceType string

ServiceType associated with this OrderBaseApiModel.

CreatedUTCDate
CreatedUTCDate date-time

Point in time this OrderBaseApiModel was created.

OrderNumber
OrderNumber string

Order Number associated with this OrderBaseApiModel.

IsClosed
IsClosed boolean

Status showing if the OrderBaseApiModel is closed.

Status
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

External Use Id for the Client - API Extension Property.

ClientId
ClientId integer

internal Use Id for the Client - API Extension Property.

Client
Client CustomerAPI.Models.Client.BaseClientApiModel
ApiServiceId
ApiServiceId string

Id of the ApiService Associated with this OrderBaseApiModel.

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

Custom fields module version.

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name Path Type Description
Id
Id integer

Id of the Timekeeping entry (legacy comment: RootSubmittedStatusId).

User
User CustomerAPI.Models.UserReferenceApiModel
ClockInTime
ClockInTime date-time

Point in time when the User clocked into the system.

ClockInLocation
ClockInLocation CustomerAPI.Models.LocationApiModel
ClockOutTime
ClockOutTime date-time

Point in time when the User clocked out of the system.

ClockOutLocation
ClockOutLocation CustomerAPI.Models.LocationApiModel
TotalHours
TotalHours double

Total number of hours for this Timekeeping entry.

TotalBreakHours
TotalBreakHours double

Total number of break (non-working) hours for this Timekeeping entry.

NetHours
NetHours double

Total number of hours chargeable for this Timekeeping entry.

Approved
Approved boolean

Status of Supervisor approval for this Timekeeping entry.

Breaks
Breaks array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData
ClockInFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData
ClockOutFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion
ModuleVersion System.Version
CompanyModuleId
CompanyModuleId integer

Id of the Company Module used to submit this Timekeeping entry.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name Path Type Description
Id
Id integer

SubmittedStatusId.

StartTime
StartTime date-time

Start time.

StartLocation
StartLocation CustomerAPI.Models.LocationApiModel
EndTime
EndTime date-time

End time.

EndLocation
EndLocation CustomerAPI.Models.LocationApiModel
DurationHours
DurationHours double

Duration in hours. It can be null if EndTime is null.

StatusType
StatusType integer

Status type: 1 for break, and 2 for lunch.

StartLabel
StartLabel string

Start label.

EndLabel
EndLabel string

End label.

Caption
Caption string

Caption.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name Path Type Description
CompanyModuleId
CompanyModuleId integer
ModuleVersion
ModuleVersion System.Version
FieldValues
FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name Path Type Description
_Major
_Major integer
_Minor
_Minor integer
_Build
_Build integer
_Revision
_Revision integer

CustomerAPI.Models.Tracking.TripApiModel

Name Path Type Description
User
User CustomerAPI.Models.UserReferenceApiModel
Vehicle
Vehicle CustomerAPI.Models.ReadVehicleApiModel
StartTime
StartTime date-time

Point in time this TripApiModel Status was started.

EndTime
EndTime date-time

Point in time this TripApiModel Status was ended.

StartLocation
StartLocation CustomerAPI.Models.LocationApiModel
EndLocation
EndLocation CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence
StartPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence
EndPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime
TotalStopTime double

Amount of stop time in hours associate with this TripApiModel.

TotalIdleTime
TotalIdleTime double

Amount of idle time in hours associate with this TripApiModel.

TotalDuration
TotalDuration double

Full amount of time in hours associate with this TripApiModel.

Distance
Distance double

Distance travelled in localized units associated with this TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name Path Type Description
Records
Records array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken
ContinuationToken string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name Path Type Description
User
User CustomerAPI.Models.UserReferenceApiModel
Vehicle
Vehicle CustomerAPI.Models.ReadVehicleApiModel
TimeTag
TimeTag date-time

TimeTag associated with this GpsDataRecordApiModel.

Location
Location System.Nullable_1_Actsoft.Common.Geo.LatLon_
Geofence
Geofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Speed
Speed double

Speed of movement associated with this GpsDataRecordApiModel.

Heading
Heading double

Compass direction in degrees associated with this GpsDataRecordApiModel.

Status
Status integer

ApiMovementStatus associated with the OrderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.

StatusTime
StatusTime string

Point in time this GpsDataRecordApiModel Status was set.

Distance
Distance double

Distance traveled in localized units associated with this TripApiModel.

IgnitionOn
IgnitionOn boolean

Status of vehicle ignition associated with this GpsDataRecordApiModel.

LocationProvider
LocationProvider integer

Api Location Provider associated with this GpsDataRecordApiModel - (GPS: 1, Network: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name Path Type Description
UserName
UserName string

UserName of the User.

UserId
UserId integer

Id value of the User.

GroupName
GroupName string

Name of Group of the User.

FirstName
FirstName string

First name of the User.

LastName
LastName string

Last name of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

Email
Email string

Email address of the User.

Phone
Phone string

Phone number of the User.

RoleId
RoleId integer

RoleId of the User - (Admin: 1, User: 3, Power User: 5).

IsActive
IsActive boolean

Active status of the User.

EPTTEnabled
EPTTEnabled boolean

Status of Enhanced Push-to-Talk feature for User: boolean.

EPTTNumber
EPTTNumber string

Phone number for Enhanced Push-to-Talk feature for User: string.

EPTTWebMDN
EPTTWebMDN string

Phone number used to Authenticate the User to the Kodiak EPTT system - Provided by Kodiak.

EPTTToken
EPTTToken string

API Token used to Authenticate the User to Kodiak EPTT system - Provided by Kodiak.

GPSEnabled
GPSEnabled boolean

Status of GPS Feature for the User.

MobileOnly
MobileOnly boolean

Status of desktop web application access for CAB - (No WebApp Access: True, Full App Access: False).

LicenseType
LicenseType integer

Type of License assigned to the user: - 0 for Undefined, 1 for Regular, 2 for WebOnly, and 3 for Employee.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name Path Type Description
UserId
UserId integer

Id value of the User.

FirstName
FirstName string

First name of the User.

LastName
LastName string

Last name of the User.

EmployeeNumber
EmployeeNumber string

Employee number of the User.

Email
Email string

Email address of the User.

Phone
Phone string

Phone number of the User.

RoleId
RoleId integer

RoleId of the User - (Admin: 1, User: 3, Power User: 5).

IsActive
IsActive boolean

Active status of the User.

EPTTEnabled
EPTTEnabled boolean

Status of Enhanced Push-to-Talk feature for User: boolean.

EPTTNumber
EPTTNumber string

Phone number for Enhanced Push-to-Talk feature for User: string.

EPTTWebMDN
EPTTWebMDN string

Phone number used to Authenticate the User to the Kodiak EPTT system - Provided by Kodiak.

EPTTToken
EPTTToken string

API Token used to Authenticate the User to Kodiak EPTT system - Provided by Kodiak.

GPSEnabled
GPSEnabled boolean

Status of GPS Feature for the User.

MobileOnly
MobileOnly boolean

Status of desktop web application access for CAB - (No WebApp Access: True, Full App Access: False).

LicenseType
LicenseType integer

Type of License assigned to the user: - 0 for Undefined, 1 for Regular, 2 for WebOnly, and 3 for Employee.

CustomerAPI.Models.Vehicles.VehicleReadApi

Vehicle Data Model.

Name Path Type Description
InternalId
InternalId integer
Number
Number string
Name
Name string
Type
Type string
Tag
Tag string
UserEmployeeNumber
UserEmployeeNumber string
GroupName
GroupName string
TimeZone
TimeZone string
Make
Make string
Year
Year integer
Model
Model string
Color
Color string
VIN
VIN string
IsActive
IsActive boolean
DeviceType
DeviceType integer
DeviceSerialNumber
DeviceSerialNumber string

object

This is the type 'object'.

integer

This is the basic data type 'integer'.