JSON Reference

Download JSDoc Helper
© 2021 Trak-iT Wireless Inc.
Updated Thursday December 14, 2023 05:01PM
Version 4.36.1

API Definitions

bytenumber

8bit unsigned integer

Format

Value range:

codifiedstring

Codified names
A lower-case string with all the apostrophes and quotation marks [", ', `, â€œ, and â€] removed, and all non-alphanumeric character sequences replaced with a single minus sign. Diacritics such as Â®, Ã©, and Ã§ are also replaced with their alhpabetic equivalents (r, e, and c).

Examples

Input	Output
Truck	`truck`
Truck 13	`truck-13`
Truck #19	`truck-19`
Dave's Truck (#36)	`daves-truck-36`
Greg's "Rusty" Truck (#42)	`gregs-rusty-truck-42`

colourstring

Colour
A string that contains only a valid CSS colour.

Format	Description
`#RGB[A]`	Shorthand hexadecimal colour notation [with alpha (transparency)].
`#RRGGBB[AA]`	Hexadecimal colour notation [with alpha (transparency)].
`rgb[a](R, G, B[, A])`	Function call notation [with alpha (transparency)]. Each of the RGB values is specified as a number from 0 to 255. The alpha value is specified as a decimal between 0 and 1 with three digits of precision.
`rgb[a](R%, G%, B%[, A])`	Function call notation [with alpha (transparency)]. Each of the RGB values is specified as a number from 0% to 100%. The alpha value is specified as a decimal between 0 and 1 with three digits of precision.
`hsl[a](H, S%, L%[, A])`	Hue-Saturation-Lightness function call notation [with alpha (transparency)]. Hue is given as a number between 0 and 360. Saturation is given as a number between 0% and 100%. Lightness is given as a number between 0% and 100%. The alpha value is specified as a decimal between 0 and 1 with three digits of precision.
`hsv[a](H, S%, L%[, A])`	Hue-Saturation-Value function call notation [with alpha (transparency)]. Hue is given as a number between 0 and 360. Value is given as a number between 0% and 100%. Value is given as a number between 0% and 100%. The alpha value is specified as a decimal between 0 and 1 with three digits of precision.

Flag	Meaning
`R`	Red
`G`	Green
`B`	Blue
`A`	Alpha (transparency)
`H`	Hue
`S`	Saturation
`L`	Lightness
`V`	Value

datetimestring

Date and Time
A serialized-string representation of a date and time in ISO-8601 format. Square brackets [] are used to show optional format information. All other non-alphabetic characters are required.

Format

yyyy-MM-ddTHH:mm:ss[.fff]Z

Legend

Flag	Meaning
`yyyy`	Four digit year.
`MM`	Two digit month.
`dd`	Two digit day of the month.
`T`	Separator between date and time.
`HH`	Two digit hours ranging from `00` to `23`.
`mm`	Two digit minute.
`ss`	Two digit second.
`fff`	Optional three digit millisecond.
`Z`	A terminator representing the UTC timezone.

datetimetemplatestring

Date and Time formatting
These formats define the text representation of dates and times.

Legend

Flag	Meaning
`yy`	Two digit year.
`yyyy`	Four digit year.
`M`	One or two digit month.
`MM`	Two digit month.
`MMM`	Abbreviated month name (ie: Jan).
`MMMM`	Month name.
`d`	One or two digit day of the month.
`dd`	Two digit day of the month.
`ddd`	Abbreviated day name (ie: Mon).
`dddd`	Day name (ie: Monday).
`h`	One or two digit hour ranging from `1` to `12`.
`H`	One or two digit hour ranging from `0` to `23`.
`hh`	Two digit hour ranging from `01` to `12`.
`HH`	Two digit hours ranging from `00` to `23`.
`m`	One or two digit minute.
`mm`	Two digit minute.
`s`	One or two digit second
`ss`	Two digit second.
`f`	One digit millisecond.
`ff`	Two digit millisecond.
`fff`	Three digit millisecond.
`t`	First letter of meridium (ie: a or p).
`T`	First letter of meridium (ie: A or P).
`tt`	Meridium (ie: am or pm).
`TT`	Meridium (ie: AM or PM).
`\`	Escape the next character.

Examples

Input	Output
ddd MMM d, yyyy	Tue Oct 19, 2021
h:mm:ss tt	1:42:15 pm
H\h m\m	13h 42m
yyyy-MM-dd\THH:mm:ss.fffZ	2021-10-19T17:42:15.843Z

doublenumber

Double-precision floating point number

Format

Value range:

-1.7976931348623157e+308

1.7976931348623157e+308

emailstring

Email address (RFC 2822)
An email address identifies a mailbox to which messages are delivered. We follow the RFC 2822 pattern for addresses.

ErrorCodeuint16number

The possible errors returned by the system.

Value	Description
0	Success! Operation completed without error.
1	An unknown error, or some kind or error by the client.
2	Service error not because of client input.
3	Invalid data. Client input could not be properly parsed.
4 Deprecated	Not a valid PermissionType.
5	Permission denied. The operation not successful because access is restricted.
6	Version keys sent with request do not match service version. In these cases, treat the service version as most recent.
61	Unknown command.
62	Timezone not found.
105	Command not processed due to flooding.
108	The long-running operation is queued, and will run when resources are ready.
109	The long-running operation is currently executing.
110	The long-running operation has failed; see `message` and `errorDetails` for more information.
125	The object or operation has not changed since the last request.
126	The collection has no content or the operation produced no results.
130	Invalid operation. Due to either the request or the objects' state, the operation cannot be performed.
Assets
20	Asset not found.
21	Asset not deleted.
22	One or more Assets in the list not found.
63	AssetMessage not found.
96	Asset suspended.
97	Asset not suspended.
101	AssetMessage not deleted.
Behaviours
23	BehaviourScript not found.
24	BehaviourScript not deleted.
25	BehaviourScript currently implemented by one or more Behaviours. In order to delete a BehaviourScript, all Behaviours implementing the script must be deleted first.
26	Behaviour not found.
27	Behaviour not deleted.
Billing
111	BillingProfile not found.
112	BillingProfile not deleted.
113	BillableHostingRule not found.
114	BillableHostingRule not deleted.
117	BillableHostingLicense not found.
118	BillableHostingLicense not deleted.
119	BillingReport not found.
120	BillingReport not deleted.
Companies
28	Company not found.
29	Company not deleted.
58 Deprecated	Company.labels codes must be unique.
59 Deprecated	Company.tags codes must be unique.
Contacts
31	Contact not found.
32	Contact not deleted.
121	Contact currently in use by one or more Users and/or Assets. In order to delete a Contact, all Users/Assets must first be altered or deleted.
Dispatch
64	DispatchTask not found.
80	There was an error retrieving the address' coordinates. Check the `errorDetails` for more information.
81	No coordinates could be found for the given address. Ensure the address is correct, or try again without postal code.
82	There was an error calculating the directions or too many stops were given. Check the `errorDetails` for more information.
83	Directions could not be calculated between two or more stops. Ensure the each stop is correct, or try a shorter route.
100	DispatchTask not deleted.
137	DispatchTemplate not found.
138	DispatchTemplate not deleted.
139	DispatchJob not found.
140	DispatchJob not deleted.
File Hosting
33	Icon not found.
34	Icon not deleted.
68	Picture not found.
69	One or more Pictures in the list not found.
70	Picture not deleted.
90	Unsupported MIME type.
91	File is too large.
122	Document not found.
123	Document not deleted.
124	One or more Documents in the list not found.
132	FormTemplate not found.
133	FormTemplate not deleted.
134	FormResult not found.
135	FormResult not deleted.
136	One or more FormResults in the list not found.
141	One or more DispatchJobs in the list not found.
142	FormTemplate currently in use by one or more FormResults. In order to delete a FormTemplate, all FormResults must first be expired or deleted.
Hours of Service
76	HosCarrier not found.
77	HosCarrier not deleted.
78	HosInspection not found.
79	HosInspection not deleted.
84	HosEvent not found.
Maintenance
35	MaintenanceJob not found.
36	MaintenanceJob not deleted.
37	MaintenanceSchedule not found.
38	MaintenanceSchedule not deleted.
39 Deprecated	MaintenanceSchedule currently in use by one or more MaintenanceJobs. In order to delete a MaintenanceSchedule, all MaintenanceJobs referencing this schedule must be deleted first.
Places
40	Place not found.
41	Place not deleted.
42	One or more Places in the list not found.
Providers and Configurations
43	Provider not found.
44	Provider not deleted.
45	One or more Providers in the list not found.
46 Deprecated	Cannot access deleted Provider. Throws providerNotFound instead.
47	ProviderConfigurationType not found.
48	ProviderConfig or ProviderConfiguration not found.
49	ProviderConfig or ProviderConfiguration not deleted.
50	ProviderConfig or ProviderConfiguration currently in use by one or more Providers. In order to delete a ProviderConfig/ProviderConfiguration, all Providers using the configuration must be deleted first, or have their configuration changed.
51	Invalid ProviderConfiguration options.
86	Trying to remove an expired or completed ProviderRegistration.
89	ProviderRegistration timeout has elapsed.
92 Deprecated	Unknown or invalid ProviderType. Use invalidData instead.
98	Provider suspended.
99	Provider not suspended.
102	ProviderScript not found.
103	ProviderScript not deleted.
104	ProviderScript currently in use by one or more ProviderConfigs. In order to delete a ProviderScript, all ProviderConfigs must first be deleted.
Reports
52	ReportTemplate not found.
53	ReportTemplate not deleted.
67	ReportResult not found.
75	ReportResult not deleted.
93	ReportSchedule not found.
94	ReportSchedule not deleted.
95	ReportResult not ready to serve ReportSummary or ReportBreakdown data.
Users and Groups
7	User's session is expired or unknown.
8	Please login before all other operations.
9	User's session was forcibly killed by another user, or by SessionPolicy's rules.
10	The session has ended.
11	Invalid credentials.
12	The given client UserAgent is not allowed.
13	IPAddress not allowed. IP restrictions are in place, and the client IP is not in the allowed list.
14	Session is active from another client, and the SessionPolicy's rules are set to SessionMultiUser.deny.
15	Password doesn't comply with the password policy. See the PasswordPolicy for a reason as to why your password does not meet the criteria.
16	Your password has expired. Please change your password. An expired password does not mean your session has expired. If you create a new session, it will ask you to update your password again.
17	When changing a password, it must not be the same as the previous password.
18 Deprecated	Unable to Kill the session.
19	Session not found.
30	UserGroup not found.
54	User not found.
55	User not deleted.
56 Deprecated	Cannot access deleted User. Throws userNotFound instead.
57	Cannot kill your own Session, or delete/disable your own User.
60	One or more UserGroups in the list not found.
65	UserGroup currently in use by one or more Users. In order to delete a UserGroup, all Users must first be removed as members.
66	UserGroup not deleted.
71	Unable to perform operation because resulting Permissions would be greater than your own.
72	A User with this login already exists.
73	Session or connection not allowed due to flooding.
74	One or more Users in the list not found.
85	User has been disabled.
127	Machine not found.
128	Machine not deleted.
129	The Machine cannot access the requested API.
131	A client using a Machine is trying to access the system from an unknown URL.
White-labelling
106	CompanyReseller not found.
107	CompanyReseller not deleted.

expressionstring

Search expression patterns
A targeting pattern is a string that represents an in-the-moment search for objects. The operators used depend entirely on the context of the search, and compatibility with the sub-system.

Input	Output
To match all East Coast assets (Asset 1 and 3)	`label:east-coast` or `labels:east-coast` or `label:"East Coast"`
To match all East Coast assets (Asset 1 and 3)	`label:east-coast` or `labels:east-coast` or `label:"East Coast"`
To match all people (Asset 2 and 3)	`person:*`
To match Asset 1 specifically	`#1234`
To match assets with the string "ike" in the name (Asset 3)	`ike`
To match people labelled East Coast (Asset 3)	`person:* label:east-coast`
To match all assets labelled East Coast and labelled Head Office (Asset 1)	`label:east-coast,head-office` or `label:east-coast label:head-office`
To match all assets labelled East Coast or labelled Head Office (Asset 1, 2, and 3)	`label:"East Coast" \| label:head-office`
To match all assets without the East Coast label, use the negative operator.	`!label:east-coast`
Negative searches also work for terms, not just operators. The following will match only Asset 1 because the name has no "e" in it.	`!e`

guidstring

Universally Unique Identifier
Globally/Universally Unique Identifier. It is a 36 character long string made up of letters, numbers, and dashes. The letters can be transmitted as upper-case, lower-case, or a combination.

HostedTotalobject

Summary information about hosted files and other media.

JSON description

Property	Type	Description
bytes	uint64	Total file size of all referenced files currently hosted.
count	uint32	Total number of referenced files currently hosted.
newest	datetime	Timestamp for the most recently added file.
oldest	datetime	Timestamp for the least recently added file.

JSON structure

{
	"bytes": number,
	"count": number,
	"newest": string,
	"oldest": string
}

int16number

16bit integer

Format

Value range:

-32768

int32number

32bit integer

Format

Value range:

-2147483648

2147483647

int64number

64bit integer

Format

Value range:

-9223372036854775808

9223372036854775807

ipv4string

IP Address (IPv4 only)
A serialized-string representation of an IPv4 Address. Square brackets [] are used to show optional format information. All other non-alphabetic characters are required.

Format

n.n.n.n[/r]

Legend

Flag	Meaning
`n`	A number ranging from `0` to `255`.
`r`	CIDR notation to indicate a range of IPv4 addresses. The number ranges from `32` to `0`.

LatLngobject

A coordinate on the globe

JSON description

Property	Type	Description
lat	double	Latitude
lng	double	Longitude

JSON structure

{
	"lat": number,
	"lng": number
}

LatLngBoundsobject

A boundary on the globe

JSON description

Property	Type	Description
east	double	Eastern longitude
north	double	Northern latitude
south	double	Southern latitude
west	double	Western longitude

JSON structure

{
	"east": number,
	"north": number,
	"south": number,
	"west": number
}

ParamNoOperationBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

ParamTimezoneGetBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
timezone	ParamCode	always	An object to contain the "code" of the Timezone.
timezone.code	string	always	A "code" identifying a resource.

Request structure

{
	"reqId": number,
	"timezone": {
		"code": string
	}
}

ParamTimezoneListBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

ParamUnknownBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

phonenumber

Phone Number
A phone number for a phone in Canada or the United States of America. All phone numbers start with a 1 and are eleven digits long.

Format

[1]AAALLLSSSS

Legend

Flag	Meaning
`1`	Prefix
`AAA`	Area Code
`LLL`	Local switch number
`SSSS`	Subscriber number (Line number)

Pointobject

A coordinate on a flat surface

JSON description

Property	Type	Description
x	double	Horizontal coordinate
y	double	Vertical coordinate

JSON structure

{
	"x": number,
	"y": number
}

polylinestring

Encoded Polyline Algorithm Format
The algorithm is a lossy compression that stores a series of coordinates as a single string. All coordinates are rounded to six decimal places before encoding, but this should be accurate to within roughly one and a half meters.

RespNoOperationobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespTimezoneGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
timezone	Timezone	The requested Timezone.
timezone.code	codified	Unique timezone code
timezone.dst	boolean	Indicates whether this timezone abides by daylight savings
timezone.name	string	Common timezone name
timezone.offset	int16	Minutes offset from GMT

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"timezone": {
		"code": string,
		"dst": boolean,
		"name": string,
		"offset": number
	}
}

RespTimezoneListBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
timezones	Array.<Timezone>	The list of valid system Timezones.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"timezones": [
		{
			"code": string,
			"dst": boolean,
			"name": string,
			"offset": number
		}
	]
}

RespUnknownBaseResponseobject

Response description

Property	Type	Description
commandName	string	Name of the command you attempted to execute.
data	string	The first `100` characters of data sent with the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"commandName": string,
	"data": string,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

sbytenumber

8bit integer

Format

Value range:

-128

singlenumber

Single-precision floating point number

Format

Value range:

-3.40282347E+38F

3.40282347E+38F

Sizeobject

Dimensions on a flat surface

JSON description

Property	Type	Description
height	double	Height
width	double	Width

JSON structure

{
	"height": number,
	"width": number
}

Squareobject

A boundary on a flat surface

JSON description

Property	Type	Description
bottom	double	Lowest vertical coordinate
left	double	Left-most horizontal coordinate
right	double	Right-most horizontal coordinate
top	double	Highest vertical coordinate

JSON structure

{
	"bottom": number,
	"left": number,
	"right": number,
	"top": number
}

timespanstring

Duration
A serialized-string representation of a duration of time. There are two possible formats when using a duration string. Square brackets [] are used to show optional format information. All other non-alphabetic characters are required.

Format

[-][d.]H:mm[:ss[.fff]]

[-]d

Legend

Flag	Meaning
`-`	Optional minus sign to indicate a negative duration.
`d`	Optional days, ranging from `0` to `10675199`.
`HH`	One or two digit hours ranging from `0` to `23`.
`mm`	Two digit minute
`ss`	Optional two digit second
`fff`	Optional three digit millisecond. When including milliseconds, the two-digit seconds are also required even if the value is `00`.

Timezoneobject

Timezone definition

JSON description

Property	Type	Description
code	codified	Unique timezone code
dst	boolean	Indicates whether this timezone abides by daylight savings
name	string	Common timezone name
offset	int16	Minutes offset from GMT

JSON structure

{
	"code": string,
	"dst": boolean,
	"name": string,
	"offset": number
}

uint16number

16bit unsigned integer

Format

Value range:

uint32number

32bit unsigned integer

Format

Value range:

4294967295

uint64number

64bit unsigned integer

Format

Value range:

18446744073709551615

urlstring

URL (Uniform Resource Locator)
Most commonly a website address, but can also be any other type of locator like ssh:. We follow the RFC 1738 pattern for addresses.

API Definitions - Errors

ErrorDetailobject Abstract

An object which contains details about the error.

JSON description

Property	Type	Description
kind	string	A hint for deserializing the error's details.

JSON structure

{
	"kind": string
}

ErrorDetailBadIdsErrorDetailobject

These details contain unique identifiers that caused the failure.

JSON description

Property	Type	Value	Description
invalid	Array.<uint64>
kind	string	`"badIds"`	A hint for deserializing the error's details.

JSON structure

{
	"invalid": [
		number
	],
	"kind": string
}

ErrorDetailBadIndexesErrorDetailobject

These details contain array indexes that caused the failure.

JSON description

Property	Type	Value	Description
invalid	Array.<int32>
kind	string	`"badIndexes"`	A hint for deserializing the error's details.

JSON structure

{
	"invalid": [
		number
	],
	"kind": string
}

ErrorDetailBadKeysErrorDetailobject

These details contain a list of bad keys, labels or tags, or parameter names that caused the failure.

JSON description

Property	Type	Value	Description
invalid	Array.<string>
kind	string	`"badKeys"`	A hint for deserializing the error's details.

JSON structure

{
	"invalid": [
		string
	],
	"kind": string
}

ErrorDetailBatchErrorDetailobject

For batch commands, these are the errors thrown by the sub-command.

JSON description

Property	Type	Value	Description
errors	Array.<ErrorDetailBatchInner>		Index-presevered list of sub-command errors.
kind	string	`"batch"`	A hint for deserializing the error's details.

JSON structure

{
	"errors": [
		{
			"errorCode": number,
			"errorDetails": {
				"kind": string
			},
			"message": string
		}
	],
	"kind": string
}

ErrorDetailBatchInnerobject

The error responses as thrown by the sub-command.

JSON description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.

JSON structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string
}

ErrorDetailContactInUseErrorDetailUserGroupInUseErrorDetailobject

Details for how many and which Assets and Users are still using this Contact.

JSON description

Property	Type	Value	Description
assets	Array.<uint64> for values see: Asset.id		A list of Assets currently being referenced.
kind	string	`"contactInUse"`	A hint for deserializing the error's details.
users	Array.<email> for values see: User.login		A list of Users currently being referenced.

JSON structure

{
	"assets": [
		number
	],
	"kind": string,
	"users": [
		string
	]
}

ErrorDetailCountErrorDetailobject

These are the details when a number of things create the exception.

JSON description

Property	Type	Value	Description
count	int32		The number of items that failed, or number of items preventing success
kind	string	`"count"`	A hint for deserializing the error's details.

JSON structure

{
	"count": number,
	"kind": string
}

ErrorDetailEnumErrorDetailInputErrorDetailobject

These are the details of an enum input that failed to parse.

JSON description

Property	Type	Value	Description
input	string		The given input which caused the error.
kind	string	`"enum"`	A hint for deserializing the error's details.
valid	Array.<string>		This is a list of possible values the input should have been.

JSON structure

{
	"input": string,
	"kind": string,
	"valid": [
		string
	]
}

ErrorDetailEscalationErrorDetailobject

Details of a permission escallation error thrown when modifying a resource or user that would grant the following extra permissions.

JSON description

Property	Type	Value	Description
escalations	Array.<PermissionEscalation> for keys see: Company.id		This is a dictionary of company id and list of PermissionTypes.
kind	string	`"escalation"`	A hint for deserializing the error's details.

JSON structure

{
	"escalations": [
		{
			"after": {
				"labels": [
					string
				],
				"level": string
			},
			"before": {
				"labels": [
					string
				],
				"level": string
			},
			"company": number,
			"direction": string,
			"kind": string
		}
	],
	"kind": string
}

ErrorDetailExternalsErrorDetailobject

These are the errors/warnings taken from the output of some other system.

JSON description

Property	Type	Value	Description
errors	Array.<string>		List of errors.
kind	string	`"externals"`	A hint for deserializing the error's details.
messages	Array.<string>		List of messages.
warnings	Array.<string>		List of warnings.

JSON structure

{
	"errors": [
		string
	],
	"kind": string,
	"messages": [
		string
	],
	"warnings": [
		string
	]
}

ErrorDetailFormTemplateInUseErrorDetailobject

Details for how many and which FormResults are still using this FormTemplate.

JSON description

Property	Type	Value	Description
formResults	Array.<uint64> for values see: FormResult.id		A list of FormResults currently being referenced.
kind	string	`"formTemplateInUse"`	A hint for deserializing the error's details.

JSON structure

{
	"formResults": [
		number
	],
	"kind": string
}

ErrorDetailInputErrorDetailobject

These are the details of an input or format exception.

JSON description

Property	Type	Value	Description
input	string		The given input which caused the error.
kind	string	`"input"`	A hint for deserializing the error's details.

JSON structure

{
	"input": string,
	"kind": string
}

ErrorDetailLockedErrorDetailobject

Details for how long a resource is locked, or if a command cannot be executed right away, how long until it can be executed.

JSON description

Property	Type	Value	Description
kind	string	`"locked"`	A hint for deserializing the error's details.
timeout	timespan		The amount of time the resource is locked, or you are prevented from issuing the command.
until	datetime		This timestamp represents the moment the resource becomes available again.

JSON structure

{
	"kind": string,
	"timeout": string,
	"until": string
}

ErrorDetailMinMaxErrorDetailMinMaxErrorDetailobject

These are the details of when a value needed to be within a certain range, and was not.

JSON description

Property	Type	Value	Description
kind	string	`"minMax"`	A hint for deserializing the error's details.
max	double?
min	double?

JSON structure

{
	"kind": string,
	"max": number,
	"min": number
}

ErrorDetailParentErrorDetailobject

Details for how a circular company tree would have been created.

JSON description

Property	Type	Value	Description
descendant	uint64		ID of the child Company that would cause a circular reference.
kind	string	`"parent"`	A hint for deserializing the error's details.
parent	uint64		The Company.parent specified in the parameters.

JSON structure

{
	"descendant": number,
	"kind": string,
	"parent": number
}

ErrorDetailParseErrorDetailobject

These are the details of an exception while trying to parse the JSON input.

JSON description

Property	Type	Value	Description
after	string		The last sucessfully parsed object.
column	int32		The character on which the failure occurred.
kind	string	`"parse"`	A hint for deserializing the error's details.
line	int32		The line number in the input string.

JSON structure

{
	"after": string,
	"column": number,
	"kind": string,
	"line": number
}

ErrorDetailPhoneErrorDetailInputErrorDetailobject

These are the details of a phone number input that failed to parse.

JSON description

Property	Type	Value	Description
input	string		The given input which caused the error.
kind	string	`"phone"`	A hint for deserializing the error's details.
number	uint64		The number that was parsed from the input.
usable	string		The digital characters used to try to parse the number.

JSON structure

{
	"input": string,
	"kind": string,
	"number": number,
	"usable": string
}

ErrorDetailStackErrorDetailobject

For unhandled exceptions, a full stack trace may be given.

JSON description

Property	Type	Value	Description
kind	string	`"stack"`	A hint for deserializing the error's details.
message	string		Exception message.
stack	string		The full stack trace if available.

JSON structure

{
	"kind": string,
	"message": string,
	"stack": string
}

ErrorDetailThrottledErrorDetailobject

Each command or session being throttled needs to provide these details. Instead of using an anonymous class as errorDetails, use this one so we can write it out properly

JSON description

Property	Type	Value	Description
command	string		The name of the WebSocket command, or the RESTful route.
count	int32		How many times this command was invoked during the window. Alternatively, can be the maximum number of times this command can be invoked (like creating a session).
ghostId	guid		The session identifier being throttled.
ip	ipv4		The client IP address.
kind	string	`"throttled"`	A hint for deserializing the error's details.
login	email		The User being throttled.
timeout	timespan		The size of the window. If this throttled command has no window (ie; creating too many sessions) this value is null.

JSON structure

{
	"command": string,
	"count": number,
	"ghostId": string,
	"ip": string,
	"kind": string,
	"login": string,
	"timeout": string
}

ErrorDetailUserGroupInUseErrorDetailobject

Details for how many and which Users are still in the UserGroup.

JSON description

Property	Type	Value	Description
kind	string	`"userGroupInUse"`	A hint for deserializing the error's details.
users	Array.<email> for values see: User.login		A list of Users currently being referenced.

JSON structure

{
	"kind": string,
	"users": [
		string
	]
}

API Definitions - Requests

BaseParametersobject Abstract

Base class for all command parameters. All command parameter classes use this as the base.

JSON description

Property	Type	Description
reqId	int32?	Identifier used by external system to correlate requests to responses.

JSON structure

{
	"reqId": number
}

ParamCodeobject

A container class used to house the "code" identifying a resource.

JSON description

Property	Type	Required	Description
code	string	always	A "code" identifying a resource.

JSON structure

{
	"code": string
}

ParamGuidobject

A container class used to house the guid identifying a resource.

JSON description

Property	Type	Required	Description
guid	guid	always	The global unique identifier.

JSON structure

{
	"guid": string
}

ParamHandleobject

A container class used to house the "handle" identifying a session.

JSON description

Property	Type	Required	Description
handle	string	always	A "handle" identifying a session.

JSON structure

{
	"handle": string
}

ParamIdobject

A container class used to house the id of the object requested.

JSON description

Property	Type	Required	Description
id	uint64	always	Identifier given as input for the command.

JSON structure

{
	"id": number
}

ParamIdentifierobject

A container class used to house the string identifying a Provider.

JSON description

Property	Type	Required	Description
id	string	always	The Provider's identifier.

JSON structure

{
	"id": string
}

ParamKeyobject

A container class used to house the key identifying a Machine.

JSON description

Property	Type	Required	Description
key	string	always	The Machine's login.

JSON structure

{
	"key": string
}

ParamLoginobject

A container class used to house the login identifying a User. Used specifically to get session details.

JSON description

Property	Type	Required	Description
login	email	always	The User's login.

JSON structure

{
	"login": string
}

API Definitions - Responses

BaseResponseobject Abstract

Base class for all responses from commands. All command response classes use this as the base.

JSON description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

JSON structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDeletedRespDeletedRespIdCompanyRespIdobject

For delete/restore commands, this contains the id, owning Asset.id, owning Company.id, and deleted state.

JSON description

Property	Type	Description
asset	uint64	Identifier of the Asset to which this object belongs.
company	uint64	Identifier of the Company to which this object belongs.
deleted	boolean	Flag showing if the object is deleted.
id	uint64?	Identifier given as input for the command.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"v": [
		number
	]
}

RespBlankBaseResponseobject

Blank response message for commands with no additional response members.

JSON description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

JSON structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDeletedRespIdCompanyRespIdobject

For delete/restore commands, this contains the id, version keys, owning Company.id, and deleted state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
deleted	boolean	Flag showing if the object is deleted.
id	uint64?	Identifier given as input for the command.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"v": [
		number
	]
}

RespIdobject

A container for the id of the object requested/created.

JSON description

Property	Type	Description
id	uint64?	Identifier given as input for the command.

JSON structure

{
	"id": number
}

RespIdAssetRespIdCompanyRespIdobject

A container for the id, owning Asset.id, and owning Company.id of the object requested/created.

JSON description

Property	Type	Description
asset	uint64	Identifier of the Asset to which this object belongs
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.

JSON structure

{
	"asset": number,
	"company": number,
	"id": number
}

RespIdBillingProfileRespIdCompanyRespIdobject

A container for the id, BillingProfile.id, and owning Company.id of the billing object requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.
profile	uint64	Identifier of the BillingProfile to which this object belongs

JSON structure

{
	"company": number,
	"id": number,
	"profile": number
}

RespIdCompanyRespIdobject

A container for the id and owning Company.id of the object requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.

JSON structure

{
	"company": number,
	"id": number
}

RespIdCompanyTemplateRespIdCompanyRespIdobject

A container for the id, owning ReportTemplate id, and owning Company.id of the report object requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.
template	uint64?	Identifier of the ReportTemplate the report object implements.

JSON structure

{
	"company": number,
	"id": number,
	"template": number
}

RespIdendifierobject

A container for the id of the Provider requested/created.

JSON description

Property	Type	Description
id	string	Identifier given as input for the command.

JSON structure

{
	"id": string
}

RespIdendifierAssetRespIdendifierCompanyRespIdendifierobject

A container for the id, Asset id, and owning Company.id of the Provider requested/created.

JSON description

Property	Type	Description
asset	uint64?	Identifier of the Asset to which this object belongs.
company	uint64	Identifier of the Company to which this object belongs.
id	string	Identifier given as input for the command.

JSON structure

{
	"asset": number,
	"company": number,
	"id": string
}

RespIdendifierCompanyRespIdendifierobject

A container for the id and owning Company.id of the Provider requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	string	Identifier given as input for the command.

JSON structure

{
	"company": number,
	"id": string
}

RespIdendifierDeletedRespIdendifierCompanyRespIdendifierobject

For delete/restore commands, this contains the Provider id, version keys, owning Company.id, and deleted state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
deleted	boolean	Flag showing if the object is deleted.
id	string	Identifier given as input for the command.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": string,
	"v": [
		number
	]
}

RespIdendifierSuspendedRespIdendifierCompanyRespIdendifierobject

For suspend/revive commands, this contains the Provider id, version keys, owning Company.id, and suspended state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	string	Identifier given as input for the command.
suspended	boolean	Flag showing if the object is suspended.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"id": string,
	"suspended": boolean,
	"v": [
		number
	]
}

RespIdParentRespIdobject

A container for the id and the requested/created Company.parent.

JSON description

Property	Type	Description
id	uint64?	Identifier given as input for the command.
parent	uint64?	Identifier of the parent to which this company belongs

JSON structure

{
	"id": number,
	"parent": number
}

RespIdScriptRespIdCompanyRespIdobject

A container for the id, script id, and owning Company.id of the object requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.
script	uint64	Identifier of the script to which this object belongs.

JSON structure

{
	"company": number,
	"id": number,
	"script": number
}

RespKeyobject

A container for the key of the Machine requested/created.

JSON description

Property	Type	Description
key	string	The Machine's key.

JSON structure

{
	"key": string
}

RespKeyCompanyRespKeyobject

A container for the SelfMachine.key and owning Company.id of the Machine requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which the Machine belongs.
key	string	The Machine's key.

JSON structure

{
	"company": number,
	"key": string
}

RespKeyDeletedRespKeyCompanyRespKeyobject

For delete/restore commands, this contains the SelfMachine.key, version keys, owning Company.id, and deleted state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which the Machine belongs.
deleted	boolean	Flag showing if the object is deleted.
key	string	The Machine's key.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"key": string,
	"v": [
		number
	]
}

RespLoginobject

A container for the login of the User requested/created.

JSON description

Property	Type	Description
login	string	The User's login.

JSON structure

{
	"login": string
}

RespLoginCompanyRespLoginobject

A container for the User login and owning Company.id of the user requested/created.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which the User belongs.
login	string	The User's login.

JSON structure

{
	"company": number,
	"login": string
}

RespLoginDeletedRespLoginCompanyRespLoginobject

For delete/restore commands, this contains the User login, version keys, owning Company.id, and deleted state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which the User belongs.
deleted	boolean	Flag showing if the object is deleted.
login	string	The User's login.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"login": string,
	"v": [
		number
	]
}

RespParentDeletedRespIdobject

For delete/restore commands, this contains the id, owning Company.parent, and deleted state.

JSON description

Property	Type	Description
deleted	boolean	Flag showing if the object is deleted.
id	uint64?	Identifier given as input for the command.
parent	uint64	Identifier of the parent to which the Company is a child.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"deleted": boolean,
	"id": number,
	"parent": number,
	"v": [
		number
	]
}

RespSuspendedRespIdCompanyRespIdobject

For suspend/revive commands, this contains the id, version keys, owning Company.id, and suspended state.

JSON description

Property	Type	Description
company	uint64	Identifier of the Company to which this object belongs.
id	uint64?	Identifier given as input for the command.
suspended	boolean	Flag showing if the object is suspended.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"id": number,
	"suspended": boolean,
	"v": [
		number
	]
}

Assets

Assetobject

The full details of an Asset, containing all the properties from the AssetGeneral and AssetAdvanced objects.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
company	uint64 see: Company.id	The company to which this asset belongs.
dispatch	AssetDispatch	Current jobs dispatched and driving directions.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
messages	Array.<AssetMessage>	A list of messages sent to or from this asset.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
odometer	double	The cumulative distance travelled in kilometres.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<int32> fixed count: 3	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the AssetGeneral properties.
v[1]	int32	The second element is for the AssetAdvanced properties.
v[2]	int32	The third element is for the Asset.dispatch properties.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"company": number,
	"dispatch": {
		"company": number,
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"lastDispatched": string,
		"processedUtc": string,
		"tasks": [
			{
				"address": string,
				"arrived": string,
				"asset": number,
				"attachments": [
					number
				],
				"company": number,
				"completed": string,
				"created": string,
				"duration": string,
				"eta": string,
				"id": number,
				"instructions": string,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"processedUtc": string,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"messages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"messagingAddress": string,
	"name": string,
	"notes": string,
	"odometer": number,
	"pictures": [
		number
	],
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	]
}

AssetAdvancedobject

Often changing details about a thing.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
company	uint64 see: Company.id	The company to which this asset belongs.
id	uint64 see: Asset.id	Unique identifier of this asset.
odometer	double	The cumulative distance travelled in kilometres.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"company": number,
	"id": number,
	"odometer": number,
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	]
}

AssetAttributeobject

An attribute given to an asset by a behaviour script.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The related asset which provided this attribute.
complex	string	Parse-able/formatted string for complex display. May contain HTML.
dts	datetime	Date/time stamp from when this attribute was recorded (or reported) by the device.
global	boolean	When false, indicates that this attribute is used by an internal system and should be left untouched.
name	string maximum-length: 100	Display name of the attribute.
provider	string see: Provider.id	The device which provided this attribute.
raw	Object	Raw value like 3.76 (volts) or true (on).
simple	string	Computed/contextual value from the behaviour. Like "3.76 volts" or "on".
unit	string see: ProviderDataUnit	Text representation of unit like "Â°C" or "Km".

JSON structure

{
	"asset": number,
	"complex": string,
	"dts": string,
	"global": boolean,
	"name": string,
	"provider": string,
	"raw": Object,
	"simple": string,
	"unit": string
}

AssetDeletedobject

The message format for when a deleted Asset is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this asset belongs.
deleted	boolean	`true`	Indicates whether this Asset is deleted.
icon	uint64 see: Icon.id		The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id		Unique identifier of this asset.
kind	AssetType		Type of asset.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names.
name	string maximum-length: 100		This thing's name.
notes	string		Notes about it.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

AssetGeneralobject

Seldom changing details about a thing.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this asset belongs.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
processedUtc	datetime	When the was change procesed.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"messagingAddress": string,
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"processedUtc": string,
	"reference": string,
	"references": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

AssetPlaceStatusobject

A simple status for each place an Asset visits.

JSON description

Property	Type	Description
enter	datetime	The date/time stamp for when the Asset first began interacting with the Place.
kind	AssetPlaceStatusType	The kind of interaction.
latest	datetime	The most recent date/time stamp for the interaction.

JSON structure

{
	"enter": string,
	"kind": string,
	"latest": string
}

AssetPlaceStatusTypestring

The kinds of interactions had with a Place.

Value	Description
enter	Occurs when an asset is outside a Place, then goes inside the boundary.
exit	Occurs when an asset was inside the boundary of a Place, but then moves outside the boundary.
inside	Occurs when the asset was inside the boundary before, and is still inside the boundary now.

AssetSuspendedobject

The message format for when a suspended Asset is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this asset belongs.
icon	uint64 see: Icon.id		The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id		Unique identifier of this asset.
kind	AssetType		Type of asset.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names.
name	string maximum-length: 100		This thing's name.
notes	string		Notes about it.
since	datetime		A timestamp from the moment the object was suspended.
suspended	boolean	`true`	Indicates whether this Asset is suspended from event processing.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"suspended": boolean,
	"v": [
		number
	]
}

AssetTypestring

The four supported types of trackable things.

Value	Description
asset	Generic thing.
person	Human (or alien) Person.
trailer	A towed vehicle without an engine.
vehicle	A vehicle that moves with its own power.

ParamAssetAdvancedGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Asset.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamAssetAdvancedListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetAdvanceds.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"reqId": number
}

ParamAssetAdvancedListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetAdvanceds.
labels	Array.<string> see: AssetGeneral.labels	optional		A list of label codes used to match Assets. All labels must match to include an Asset in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ParamAssetAdvancedListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetAdvanceds.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: AssetGeneral.references	optional		Case-insensitive reference pairs used to match Assets.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamAssetBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
assets	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assets": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamAssetBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
assets	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assets": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"colour": string,
			"company": number,
			"contact": number,
			"engineHours": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"make": string,
			"messagingAddress": string,
			"model": string,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"plate": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"serial": string,
			"tags": [
				string
			],
			"v": [
				number
			],
			"vin": string,
			"year": number
		}
	],
	"reqId": number
}

ParamAssetBatchReviveBaseParametersobject

Request description

Property	Type	Required	Description
assets	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assets": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamAssetBatchSuspendBaseParametersobject

Request description

Property	Type	Required	Description
assets	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assets": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamAssetDeleteBaseParametersobject

Request description

Property	Type	Required	Description
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetDispatchGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Asset.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamAssetDispatchListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetDispatches.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"reqId": number
}

ParamAssetDispatchListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetDispatches.
labels	Array.<string> see: AssetGeneral.labels	optional		A list of label codes used to match Assets. All labels must match to include an Asset in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ParamAssetDispatchListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended AssetDispatches.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: AssetGeneral.references	optional		Case-insensitive reference pairs used to match Assets.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamAssetGeneralGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Asset.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamAssetGeneralListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamAssetGeneralListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
labels	Array.<string> see: AssetGeneral.labels	optional		A list of label codes used to match Assets. All labels must match to include an Asset in the result.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"labels": [
		string
	],
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamAssetGeneralListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: AssetGeneral.references	optional		Case-insensitive reference pairs used to match Assets.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamAssetGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Asset.
includeMessages	boolean	optional	`false`	When true, the command will also return AssetMessages for the asset.
includeTasks	boolean	optional	`false`	When true, the command will also return the AssetDispatch for the asset.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"includeDeleted": boolean,
	"includeMessages": boolean,
	"includeTasks": boolean,
	"reqId": number
}

ParamAssetListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeMessages	boolean	optional	`false`	When true, the command will also return AssetMessages for the asset.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
includeTasks	boolean	optional	`false`	When true, the command will also return DispatchTasks for the asset.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeMessages": boolean,
	"includeSuspended": boolean,
	"includeTasks": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamAssetListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeMessages	boolean	optional	`false`	When true, the command will also return AssetMessages for the asset.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
includeTasks	boolean	optional	`false`	When true, the command will also return DispatchTasks for the asset.
labels	Array.<string> see: AssetGeneral.labels	optional		A list of label codes used to match Assets. All labels must match to include an Asset in the result.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeMessages": boolean,
	"includeSuspended": boolean,
	"includeTasks": boolean,
	"labels": [
		string
	],
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamAssetListByRefBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeMessages	boolean	optional	`false`	When true, the command will also return AssetMessages for the asset.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
includeTasks	boolean	optional	`false`	When true, the command will also return DispatchTasks for the asset.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reference	string see: AssetGeneral.reference	optional		Case-insensitive reference used to match Assets.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeMessages": boolean,
	"includeSuspended": boolean,
	"includeTasks": boolean,
	"limit": number,
	"lowest": number,
	"reference": string,
	"reqId": number
}

ParamAssetListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeMessages	boolean	optional	`false`	When true, the command will also return AssetMessages for the asset.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Assets.
includeTasks	boolean	optional	`false`	When true, the command will also return DispatchTasks for the asset.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: AssetGeneral.references	optional		Case-insensitive reference pairs used to match Assets.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeMessages": boolean,
	"includeSuspended": boolean,
	"includeTasks": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamAssetMergeBaseParametersobject

Request description

Property	Type	Required	Description
asset	Object.<string, ?>	always	A simple object to contain the Asset parameters.
asset.attributes	Object.<string, AssetAttribute>	optional	Allows you to add, remove, and replace attributes. For each AssetAttribute in the attributes object, the value will be replaced on the Asset. If value is null, the attribute is removed from the Asset. If the key in the attributes object is different from the codified(AssetAttribute.name) in the object, the attribute of the key is removed from the Asset, and one of the codified name is added to the Asset. If a new value or null is not provided for a current attribute, no change is made.
asset.colour	colour maximum-length: 22	optional	The pretty-pretty colour of this Vehicle or Trailer. Only applicable if `asset.kind` is AssetType.vehicle or AssetType.trailer.
asset.company	uint64?	create	The identifier of the Company to which this Asset belongs. After creation, this value is read-only.
asset.contact	uint64?	create (for person)	The contact card details for this Asset. Only applicable if `asset.kind` is AssetType.person.
asset.engineHours	double?	optional	The number of hours the engine has been running for this Vehicle. Only applicable if `asset.kind` is AssetType.vehicle.
asset.icon	uint64? see: Icon.id	create	The identifier of the Icon used to represent this Asset in the UI.
asset.id	uint64?	update	The unique identifier of the Asset you want to update.
asset.kind	AssetType?	create	The kind of Asset being created. After creation, this value is read-only.
asset.labels	Array.<codified> for values see: LabelStyle.code	optional	A list of codified label names to categorize/organize this Asset.
asset.make	string	optional	The manufacturer of this Vehicle or Trailer. Only applicable if `asset.kind` is AssetType.vehicle or AssetType.trailer.
asset.messagingAddress	string	optional	The email address or phone number of this Asset when a Person's Contact card is blank, or the Provider's PND is not installed.
asset.model	string	optional	The model of this Vehicle or Trailer. Only applicable if `asset.kind` is AssetType.vehicle or AssetType.trailer.
asset.name	string maximum-length: 100	create	Name for the Asset.
asset.notes	string	optional	Notes for the Asset.
asset.odometer	double?	optional	The distance travelled by this Asset. Can be a GPS odometer, OBD-II odometer, or other depending on scripts.
asset.pictures	Array.<uint64> for values see: Picture.id	optional	The identifiers of Pictures of this Asset.
asset.plate	string	optional	The license plate of this Vehicle or Trailer. Only applicable if `asset.kind` is AssetType.vehicle or AssetType.trailer.
asset.references	Object.<string, string>	optional	Name/value collections of custom fields used to refer to external systems. If the value is null, the references are removed from the Asset.
asset.relationships	Array.<uint64> for values see: Asset.id	optional	A list of related asset identifiers like a driver for a Vehicle, or Trailer for a truck.
asset.serial	string	optional	The manufacturer's identification number of this Trailer. Only applicable if `asset.kind` is AssetType.vehicle.
asset.tags	Array.<string>	optional	Replaces the Asset's status tags with the given list of codified tags.
asset.v	Array.<int32>	optional
asset.vin	string	optional	The Vehicle Identification Number of this Vehicle. Only applicable if `asset.kind` is AssetType.trailer.
asset.year	uint16?	optional	The year this Vehicle or Trailer was built. Only applicable if `asset.kind` is AssetType.vehicle or AssetType.trailer.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"colour": string,
		"company": number,
		"contact": number,
		"engineHours": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"make": string,
		"messagingAddress": string,
		"model": string,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"plate": string,
		"references": {
			string: string
		},
		"relationships": [
			number
		],
		"serial": string,
		"tags": [
			string
		],
		"v": [
			number
		],
		"vin": string,
		"year": number
	},
	"reqId": number
}

ParamAssetRestoreBaseParametersobject

Request description

Property	Type	Required	Description
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetReviveBaseParametersobject

Request description

Property	Type	Required	Description
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetSuspendBaseParametersobject

Request description

Property	Type	Required	Description
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"reqId": number
}

PersonAssetobject

The full details of a Person, containing all the properties from the PersonGeneral and AssetAdvanced objects.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
company	uint64 see: Company.id	The company to which this asset belongs.
contact	uint64 see: Contact.id	A reference to their Company's Contact information.
dispatch	AssetDispatch	Current jobs dispatched and driving directions.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
messages	Array.<AssetMessage>	A list of messages sent to or from this asset.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
odometer	double	The cumulative distance travelled in kilometres.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<int32> fixed count: 3	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the AssetGeneral properties.
v[1]	int32	The second element is for the AssetAdvanced properties.
v[2]	int32	The third element is for the Asset.dispatch properties.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"company": number,
	"contact": number,
	"dispatch": {
		"company": number,
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"lastDispatched": string,
		"processedUtc": string,
		"tasks": [
			{
				"address": string,
				"arrived": string,
				"asset": number,
				"attachments": [
					number
				],
				"company": number,
				"completed": string,
				"created": string,
				"duration": string,
				"eta": string,
				"id": number,
				"instructions": string,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"processedUtc": string,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"messages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"messagingAddress": string,
	"name": string,
	"notes": string,
	"odometer": number,
	"pictures": [
		number
	],
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	]
}

PersonGeneralAssetGeneralobject

Seldom changing details about a person.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this asset belongs.
contact	uint64 see: Contact.id	A reference to their Company's Contact information.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
processedUtc	datetime	When the was change procesed.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"contact": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"messagingAddress": string,
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"processedUtc": string,
	"reference": string,
	"references": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

Positionobject

GPS position information

JSON description

Property	Type	Description
accuracy	uint32?	Threshold in meters for the accuracy of a position
address	string	The road segment description
altitude	double?	Distance in meters from the sea level
bearing	uint16?	Direction of travel
dts	datetime	The Date/Time of the GPS reading
lat	double?	Latitude
lng	double?	Longitude
origin	string	Provider Identifier
speed	double?	Speed
speedLimit	double?	The posted speed limit for the road segment
streetAddress	StreetAddress	A better description of the current road-segment

JSON structure

{
	"accuracy": number,
	"address": string,
	"altitude": number,
	"bearing": number,
	"dts": string,
	"lat": number,
	"lng": number,
	"origin": string,
	"speed": number,
	"speedLimit": number,
	"streetAddress": {
		"city": string,
		"country": string,
		"isToll": boolean,
		"number": string,
		"postal": string,
		"province": string,
		"region": string,
		"street": string
	}
}

RespAssetAdvancedGetBaseResponseobject

Response description

Property	Type	Description
assetAdvanced	AssetAdvanced	The requested Asset.
assetAdvanced.attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
assetAdvanced.company	uint64 see: Company.id	The company to which this asset belongs.
assetAdvanced.id	uint64 see: Asset.id	Unique identifier of this asset.
assetAdvanced.odometer	double	The cumulative distance travelled in kilometres.
assetAdvanced.places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
assetAdvanced.position	Position	The things GPS coordinates including speed, bearing, and street information.
assetAdvanced.position.accuracy	uint32?	Threshold in meters for the accuracy of a position
assetAdvanced.position.address	string	The road segment description
assetAdvanced.position.altitude	double?	Distance in meters from the sea level
assetAdvanced.position.bearing	uint16?	Direction of travel
assetAdvanced.position.dts	datetime	The Date/Time of the GPS reading
assetAdvanced.position.lat	double?	Latitude
assetAdvanced.position.lng	double?	Longitude
assetAdvanced.position.origin	string	Provider Identifier
assetAdvanced.position.speed	double?	Speed
assetAdvanced.position.speedLimit	double?	The posted speed limit for the road segment
assetAdvanced.position.streetAddress	StreetAddress	A better description of the current road-segment
assetAdvanced.position.streetAddress.city	string	City name.
assetAdvanced.position.streetAddress.country	string fixed length: 2	Country code. Codes should be a value from ISO 3166-1 alpha-2.
assetAdvanced.position.streetAddress.isToll	boolean	Indicates that there is a toll for the current road segment.
assetAdvanced.position.streetAddress.number	string	House number.
assetAdvanced.position.streetAddress.postal	string	Postal or zip code.
assetAdvanced.position.streetAddress.province	string fixed length: 2	Province or state code. Codes should be a value from ISO 3166-2.
assetAdvanced.position.streetAddress.region	string	Region name.
assetAdvanced.position.streetAddress.street	string	Full street name.
assetAdvanced.processedUtc	datetime	When the was change procesed.
assetAdvanced.providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
assetAdvanced.relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
assetAdvanced.tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
assetAdvanced.updated		by: login, from: monster
assetAdvanced.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetAdvanced": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"id": number,
		"odometer": number,
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetAdvancedListByCompanyBaseResponseobject

Response description

Property	Type	Description
assetAdvanceds	Array.<AssetAdvanced>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetAdvanceds": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"id": number,
			"odometer": number,
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetAdvancedListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
assetAdvanceds	Array.<AssetAdvanced>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetAdvanceds": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"id": number,
			"odometer": number,
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespAssetAdvancedListByRefPairsBaseResponseobject

Response description

Property	Type	Description
assetAdvanceds	Array.<AssetAdvanced>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetAdvanceds": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"id": number,
			"odometer": number,
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespAssetBatchDeleteBaseResponseobject

Response description

Property	Type	Description
assets	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetBatchMergeBaseResponseobject

Response description

Property	Type	Description
assets	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetBatchReviveBaseResponseobject

Response description

Property	Type	Description
assets	Array.<RespSuspended>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"company": number,
			"id": number,
			"suspended": boolean,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetBatchSuspendBaseResponseobject

Response description

Property	Type	Description
assets	Array.<RespSuspended>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"company": number,
			"id": number,
			"suspended": boolean,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDeleteBaseResponseobject

Response description

Property	Type	Description
asset	RespDeleted	An object which contains the Asset's id, owning Company id, and deleted status.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.deleted	boolean	Flag showing if the object is deleted.
asset.id	uint64?	Identifier given as input for the command.
asset.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDispatchGetBaseResponseobject

Response description

Property	Type	Description
assetDispatch	AssetDispatch	The requested AssetDispatch.
assetDispatch.company	uint64 see: Company.id	The company to which this asset belongs.
assetDispatch.directions	Array.<DispatchDirection>	Driving directions and route path details.
assetDispatch.id	uint64 see: Asset.id	Unique identifier of this asset.
assetDispatch.jobs	Array.<uint64> see: DispatchJob	The current list of DispatchJobs assigned to the asset.
assetDispatch.lastDispatched	datetime	Timestamp from the last update to this AssetDispatch by a User, Machine, Asset, or an assigned DispatchJob.
assetDispatch.processedUtc	datetime	When the was change procesed.
assetDispatch.tasks Deprecated	Array.<DispatchTask>	The current list of tasks assigned to this asset.
assetDispatch.updated		by: login, from: monster
assetDispatch.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatch": {
		"company": number,
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"lastDispatched": string,
		"processedUtc": string,
		"tasks": [
			{
				"address": string,
				"arrived": string,
				"asset": number,
				"attachments": [
					number
				],
				"company": number,
				"completed": string,
				"created": string,
				"duration": string,
				"eta": string,
				"id": number,
				"instructions": string,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"processedUtc": string,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDispatchListByCompanyBaseResponseobject

Response description

Property	Type	Description
assetDispatches	Array.<AssetDispatch>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatches": [
		{
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDispatchListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
assetDispatches	Array.<AssetDispatch>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatches": [
		{
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespAssetDispatchListByRefPairsBaseResponseobject

Response description

Property	Type	Description
assetDispatches	Array.<AssetDispatch>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatches": [
		{
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespAssetGeneralGetBaseResponseobject

Response description

Property	Type	Description
assetGeneral	AssetGeneral	The requested Asset.
assetGeneral.company	uint64 see: Company.id	The company to which this asset belongs.
assetGeneral.icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
assetGeneral.id	uint64 see: Asset.id	Unique identifier of this asset.
assetGeneral.kind	AssetType	Type of asset.
assetGeneral.labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
assetGeneral.messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
assetGeneral.name	string maximum-length: 100	This thing's name.
assetGeneral.notes	string	Notes about it.
assetGeneral.pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
assetGeneral.processedUtc	datetime	When the was change procesed.
assetGeneral.reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
assetGeneral.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
assetGeneral.updated		by: login, from: monster
assetGeneral.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetGeneral": {
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetGeneralListByCompanyBaseResponseobject

Response description

Property	Type	Description
assetGenerals	Array.<AssetGeneral>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetGenerals": [
		{
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetGeneralListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
assetGenerals	Array.<AssetGeneral>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetGenerals": [
		{
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespAssetGeneralListByRefPairsBaseResponseobject

Response description

Property	Type	Description
assetGenerals	Array.<AssetGeneral>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetGenerals": [
		{
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespAssetGetBaseResponseobject

Response description

Property	Type	Description
asset	Asset	The requested Asset.
asset.attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
asset.company	uint64 see: Company.id	The company to which this asset belongs.
asset.dispatch	AssetDispatch	Current jobs dispatched and driving directions.
asset.dispatch.company	uint64 see: Company.id	The company to which this asset belongs.
asset.dispatch.directions	Array.<DispatchDirection>	Driving directions and route path details.
asset.dispatch.id	uint64 see: Asset.id	Unique identifier of this asset.
asset.dispatch.jobs	Array.<uint64> see: DispatchJob	The current list of DispatchJobs assigned to the asset.
asset.dispatch.lastDispatched	datetime	Timestamp from the last update to this AssetDispatch by a User, Machine, Asset, or an assigned DispatchJob.
asset.dispatch.processedUtc	datetime	When the was change procesed.
asset.dispatch.tasks Deprecated	Array.<DispatchTask>	The current list of tasks assigned to this asset.
asset.dispatch.updated		by: login, from: monster
asset.dispatch.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
asset.icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
asset.id	uint64	Unique identifier of this asset.
asset.kind	AssetType	Type of asset.
asset.labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
asset.messages	Array.<AssetMessage>	A list of messages sent to or from this asset.
asset.messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
asset.name	string maximum-length: 100	This thing's name.
asset.notes	string	Notes about it.
asset.odometer	double	The cumulative distance travelled in kilometres.
asset.pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
asset.places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
asset.position	Position	The things GPS coordinates including speed, bearing, and street information.
asset.position.accuracy	uint32?	Threshold in meters for the accuracy of a position
asset.position.address	string	The road segment description
asset.position.altitude	double?	Distance in meters from the sea level
asset.position.bearing	uint16?	Direction of travel
asset.position.dts	datetime	The Date/Time of the GPS reading
asset.position.lat	double?	Latitude
asset.position.lng	double?	Longitude
asset.position.origin	string	Provider Identifier
asset.position.speed	double?	Speed
asset.position.speedLimit	double?	The posted speed limit for the road segment
asset.position.streetAddress	StreetAddress	A better description of the current road-segment
asset.position.streetAddress.city	string	City name.
asset.position.streetAddress.country	string fixed length: 2	Country code. Codes should be a value from ISO 3166-1 alpha-2.
asset.position.streetAddress.isToll	boolean	Indicates that there is a toll for the current road segment.
asset.position.streetAddress.number	string	House number.
asset.position.streetAddress.postal	string	Postal or zip code.
asset.position.streetAddress.province	string fixed length: 2	Province or state code. Codes should be a value from ISO 3166-2.
asset.position.streetAddress.region	string	Region name.
asset.position.streetAddress.street	string	Full street name.
asset.processedUtc	datetime	When the was change procesed.
asset.providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
asset.reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
asset.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
asset.relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
asset.tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
asset.updated		by: login, from: monster
asset.v	Array.<int32> fixed count: 3	Object version keys used to validate synchronization for all object properties.
asset.v[0]	int32	The first element is for the AssetGeneral properties.
asset.v[1]	int32	The second element is for the AssetAdvanced properties.
asset.v[2]	int32	The third element is for the Asset.dispatch properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"dispatch": {
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		},
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messages": [
			{
				"asset": number,
				"body": string,
				"company": number,
				"delivered": string,
				"folder": string,
				"from": string,
				"id": number,
				"incoming": boolean,
				"kind": string,
				"processed": string,
				"processedUtc": string,
				"readBy": string,
				"status": string,
				"subject": string,
				"to": string,
				"updated": {
				},
				"user": string,
				"v": [
					number
				]
			}
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"reference": string,
		"references": {
			string: string
		},
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetListByCompanyBaseResponseobject

Response description

Property	Type	Description
assets	Array.<Asset>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"dispatch": {
				"company": number,
				"directions": [
					{
						"directions": [
							{ /* recursive DispatchDirection objects */ }
						],
						"distance": number,
						"duration": string,
						"instructions": string,
						"job": number,
						"path": string,
						"step": number
					}
				],
				"id": number,
				"jobs": [
					number
				],
				"lastDispatched": string,
				"processedUtc": string,
				"tasks": [
					{
						"address": string,
						"arrived": string,
						"asset": number,
						"attachments": [
							number
						],
						"company": number,
						"completed": string,
						"created": string,
						"duration": string,
						"eta": string,
						"id": number,
						"instructions": string,
						"latlng": {
							"lat": number,
							"lng": number
						},
						"name": string,
						"notes": string,
						"place": number,
						"processedUtc": string,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"updated": {
						},
						"v": [
							number
						]
					}
				],
				"updated": {
				},
				"v": [
					number
				]
			},
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messages": [
				{
					"asset": number,
					"body": string,
					"company": number,
					"delivered": string,
					"folder": string,
					"from": string,
					"id": number,
					"incoming": boolean,
					"kind": string,
					"processed": string,
					"processedUtc": string,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"updated": {
					},
					"user": string,
					"v": [
						number
					]
				}
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
assets	Array.<Asset>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"dispatch": {
				"company": number,
				"directions": [
					{
						"directions": [
							{ /* recursive DispatchDirection objects */ }
						],
						"distance": number,
						"duration": string,
						"instructions": string,
						"job": number,
						"path": string,
						"step": number
					}
				],
				"id": number,
				"jobs": [
					number
				],
				"lastDispatched": string,
				"processedUtc": string,
				"tasks": [
					{
						"address": string,
						"arrived": string,
						"asset": number,
						"attachments": [
							number
						],
						"company": number,
						"completed": string,
						"created": string,
						"duration": string,
						"eta": string,
						"id": number,
						"instructions": string,
						"latlng": {
							"lat": number,
							"lng": number
						},
						"name": string,
						"notes": string,
						"place": number,
						"processedUtc": string,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"updated": {
						},
						"v": [
							number
						]
					}
				],
				"updated": {
				},
				"v": [
					number
				]
			},
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messages": [
				{
					"asset": number,
					"body": string,
					"company": number,
					"delivered": string,
					"folder": string,
					"from": string,
					"id": number,
					"incoming": boolean,
					"kind": string,
					"processed": string,
					"processedUtc": string,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"updated": {
					},
					"user": string,
					"v": [
						number
					]
				}
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespAssetListByRefBaseResponseobject

Response description

Property	Type	Description
assets	Array.<Asset>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reference	string	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"dispatch": {
				"company": number,
				"directions": [
					{
						"directions": [
							{ /* recursive DispatchDirection objects */ }
						],
						"distance": number,
						"duration": string,
						"instructions": string,
						"job": number,
						"path": string,
						"step": number
					}
				],
				"id": number,
				"jobs": [
					number
				],
				"lastDispatched": string,
				"processedUtc": string,
				"tasks": [
					{
						"address": string,
						"arrived": string,
						"asset": number,
						"attachments": [
							number
						],
						"company": number,
						"completed": string,
						"created": string,
						"duration": string,
						"eta": string,
						"id": number,
						"instructions": string,
						"latlng": {
							"lat": number,
							"lng": number
						},
						"name": string,
						"notes": string,
						"place": number,
						"processedUtc": string,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"updated": {
						},
						"v": [
							number
						]
					}
				],
				"updated": {
				},
				"v": [
					number
				]
			},
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messages": [
				{
					"asset": number,
					"body": string,
					"company": number,
					"delivered": string,
					"folder": string,
					"from": string,
					"id": number,
					"incoming": boolean,
					"kind": string,
					"processed": string,
					"processedUtc": string,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"updated": {
					},
					"user": string,
					"v": [
						number
					]
				}
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reference": string,
	"reqId": number
}

RespAssetListByRefPairsBaseResponseobject

Response description

Property	Type	Description
assets	Array.<Asset>	The list of requested Assets.
company	RespId	An object to contain the "id" of the Company to which the array of Assets belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assets": [
		{
			"attributes": {
				string: {
					"asset": number,
					"complex": string,
					"dts": string,
					"global": boolean,
					"name": string,
					"provider": string,
					"raw": Object,
					"simple": string,
					"unit": string
				}
			},
			"company": number,
			"dispatch": {
				"company": number,
				"directions": [
					{
						"directions": [
							{ /* recursive DispatchDirection objects */ }
						],
						"distance": number,
						"duration": string,
						"instructions": string,
						"job": number,
						"path": string,
						"step": number
					}
				],
				"id": number,
				"jobs": [
					number
				],
				"lastDispatched": string,
				"processedUtc": string,
				"tasks": [
					{
						"address": string,
						"arrived": string,
						"asset": number,
						"attachments": [
							number
						],
						"company": number,
						"completed": string,
						"created": string,
						"duration": string,
						"eta": string,
						"id": number,
						"instructions": string,
						"latlng": {
							"lat": number,
							"lng": number
						},
						"name": string,
						"notes": string,
						"place": number,
						"processedUtc": string,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"updated": {
						},
						"v": [
							number
						]
					}
				],
				"updated": {
				},
				"v": [
					number
				]
			},
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"messages": [
				{
					"asset": number,
					"body": string,
					"company": number,
					"delivered": string,
					"folder": string,
					"from": string,
					"id": number,
					"incoming": boolean,
					"kind": string,
					"processed": string,
					"processedUtc": string,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"updated": {
					},
					"user": string,
					"v": [
						number
					]
				}
			],
			"messagingAddress": string,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"places": {
				string: {
					"enter": string,
					"kind": string,
					"latest": string
				}
			},
			"position": {
				"accuracy": number,
				"address": string,
				"altitude": number,
				"bearing": number,
				"dts": string,
				"lat": number,
				"lng": number,
				"origin": string,
				"speed": number,
				"speedLimit": number,
				"streetAddress": {
					"city": string,
					"country": string,
					"isToll": boolean,
					"number": string,
					"postal": string,
					"province": string,
					"region": string,
					"street": string
				}
			},
			"processedUtc": string,
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespAssetMergeBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object which contains the "id" and "company" keys.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetRestoreBaseResponseobject

Response description

Property	Type	Description
asset	RespDeleted	An object which contains the Asset's id, owning Company id, and deleted status.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.deleted	boolean	Flag showing if the object is deleted.
asset.id	uint64?	Identifier given as input for the command.
asset.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetReviveBaseResponseobject

Response description

Property	Type	Description
asset	RespSuspended	An object which contains the Asset's unique identifier and suspended status.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
asset.suspended	boolean	Flag showing if the object is suspended.
asset.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number,
		"suspended": boolean,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetSuspendBaseResponseobject

Response description

Property	Type	Description
asset	RespSuspended	An object which contains the Asset's unique identifier and suspended status.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
asset.suspended	boolean	Flag showing if the object is suspended.
asset.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number,
		"suspended": boolean,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

StreetAddressobject

A road segment description

JSON description

Property	Type	Description
city	string	City name.
country	string fixed length: 2	Country code. Codes should be a value from ISO 3166-1 alpha-2.
isToll	boolean	Indicates that there is a toll for the current road segment.
number	string	House number.
postal	string	Postal or zip code.
province	string fixed length: 2	Province or state code. Codes should be a value from ISO 3166-2.
region	string	Region name.
street	string	Full street name.

JSON structure

{
	"city": string,
	"country": string,
	"isToll": boolean,
	"number": string,
	"postal": string,
	"province": string,
	"region": string,
	"street": string
}

TrailerAssetobject

The full details of a Trailer, containing all the properties from the TrailerGeneral and AssetAdvanced objects.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
colour	colour maximum-length: 22	Primary colour of the trailer (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this asset belongs.
dispatch	AssetDispatch	Current jobs dispatched and driving directions.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
make	string maximum-length: 50	Manufacturer's name.
messages	Array.<AssetMessage>	A list of messages sent to or from this asset.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
model	string maximum-length: 50	Manufacturer's model name/number.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
odometer	double	The cumulative distance travelled in kilometres.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
plate	string maximum-length: 50	The license plate.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
serial	string maximum-length: 50	Manufacturer's unique identification number for this trailer.
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<int32> fixed count: 3	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the AssetGeneral properties.
v[1]	int32	The second element is for the AssetAdvanced properties.
v[2]	int32	The third element is for the Asset.dispatch properties.
year	uint16	Year of manufacturing.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"colour": string,
	"company": number,
	"dispatch": {
		"company": number,
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"lastDispatched": string,
		"processedUtc": string,
		"tasks": [
			{
				"address": string,
				"arrived": string,
				"asset": number,
				"attachments": [
					number
				],
				"company": number,
				"completed": string,
				"created": string,
				"duration": string,
				"eta": string,
				"id": number,
				"instructions": string,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"processedUtc": string,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"make": string,
	"messages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"messagingAddress": string,
	"model": string,
	"name": string,
	"notes": string,
	"odometer": number,
	"pictures": [
		number
	],
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"plate": string,
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"serial": string,
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	],
	"year": number
}

TrailerGeneralAssetGeneralobject

Seldom changing details about a trailer.

JSON description

Property	Type	Description
colour	colour maximum-length: 22	Primary colour of the trailer (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this asset belongs.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
make	string maximum-length: 50	Manufacturer's name.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
model	string maximum-length: 50	Manufacturer's model name/number.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
plate	string maximum-length: 50	The license plate.
processedUtc	datetime	When the was change procesed.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
serial	string maximum-length: 50	Manufacturer's unique identification number for this trailer.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
year	uint16	Year of manufacturing.

JSON structure

{
	"colour": string,
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"make": string,
	"messagingAddress": string,
	"model": string,
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"plate": string,
	"processedUtc": string,
	"reference": string,
	"references": {
		string: string
	},
	"serial": string,
	"updated": {
	},
	"v": [
		number
	],
	"year": number
}

VehicleAssetobject

The full details of a Vehicle, containing all the properties from the VehicleGeneral and VehicleAdvanced objects.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
colour	colour maximum-length: 22	Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this asset belongs.
dispatch	AssetDispatch	Current jobs dispatched and driving directions.
engineHours	double	The cumulative duration that the vehicle's engine has been running (in decimal hours).
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
make	string maximum-length: 50	Manufacturer's name.
messages	Array.<AssetMessage>	A list of messages sent to or from this asset.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
model	string maximum-length: 50	Manufacturer's model name/number.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
odometer	double	The cumulative distance travelled in kilometres.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
plate	string maximum-length: 50	The license plate.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<int32> fixed count: 3	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the AssetGeneral properties.
v[1]	int32	The second element is for the AssetAdvanced properties.
v[2]	int32	The third element is for the Asset.dispatch properties.
vin	string maximum-length: 50	Manufacturer's unique identification number (Vehicle Identification Number).
year	uint16	Year of manufacturing.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"colour": string,
	"company": number,
	"dispatch": {
		"company": number,
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"lastDispatched": string,
		"processedUtc": string,
		"tasks": [
			{
				"address": string,
				"arrived": string,
				"asset": number,
				"attachments": [
					number
				],
				"company": number,
				"completed": string,
				"created": string,
				"duration": string,
				"eta": string,
				"id": number,
				"instructions": string,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"processedUtc": string,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"engineHours": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"make": string,
	"messages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"messagingAddress": string,
	"model": string,
	"name": string,
	"notes": string,
	"odometer": number,
	"pictures": [
		number
	],
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"plate": string,
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	],
	"vin": string,
	"year": number
}

VehicleAdvancedAssetAdvancedobject

Often changing details about a vehicle.

JSON description

Property	Type	Description
attributes	Object.<codified, AssetAttribute> for keys see: AssetAttribute.name	A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
company	uint64 see: Company.id	The company to which this asset belongs.
engineHours	double	The cumulative duration that the vehicle's engine has been running (in decimal hours).
id	uint64 see: Asset.id	Unique identifier of this asset.
odometer	double	The cumulative distance travelled in kilometres.
places	Object.<uint64, AssetPlaceStatus> for keys see: Place.id	The current state of this asset's interaction with known Places.
position	Position	The things GPS coordinates including speed, bearing, and street information.
processedUtc	datetime	When the was change procesed.
providers	Array.<string> for values see: Provider.id	The list of devices providing events for this asset.
relationships	Array.<uint64> for values see: Asset.id	A list of assets related to this one; like a Person for a Vehicle (driver).
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"attributes": {
		string: {
			"asset": number,
			"complex": string,
			"dts": string,
			"global": boolean,
			"name": string,
			"provider": string,
			"raw": Object,
			"simple": string,
			"unit": string
		}
	},
	"company": number,
	"engineHours": number,
	"id": number,
	"odometer": number,
	"places": {
		string: {
			"enter": string,
			"kind": string,
			"latest": string
		}
	},
	"position": {
		"accuracy": number,
		"address": string,
		"altitude": number,
		"bearing": number,
		"dts": string,
		"lat": number,
		"lng": number,
		"origin": string,
		"speed": number,
		"speedLimit": number,
		"streetAddress": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		}
	},
	"processedUtc": string,
	"providers": [
		string
	],
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	]
}

VehicleGeneralAssetGeneralobject

Seldom changing details about a vehicle.

JSON description

Property	Type	Description
colour	colour maximum-length: 22	Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this asset belongs.
icon	uint64 see: Icon.id	The icon that represents this asset on the map and in lists.
id	uint64 see: Asset.id	Unique identifier of this asset.
kind	AssetType	Type of asset.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names.
make	string maximum-length: 50	Manufacturer's name.
messagingAddress	string maximum-length: 254	The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
model	string maximum-length: 50	Manufacturer's model name/number.
name	string maximum-length: 100	This thing's name.
notes	string	Notes about it.
pictures	Array.<uint64> for values see: Picture.id	A list of photos of this thing.
plate	string maximum-length: 50	The license plate.
processedUtc	datetime	When the was change procesed.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Use asset.references[AssetGeneral.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
vin	string maximum-length: 50	Manufacturer's unique identification number (Vehicle Identification Number).
year	uint16	Year of manufacturing.

JSON structure

{
	"colour": string,
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"make": string,
	"messagingAddress": string,
	"model": string,
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"plate": string,
	"processedUtc": string,
	"reference": string,
	"references": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	],
	"vin": string,
	"year": number
}

Behaviours

Behaviourobject

The applied behaviour which includes all parameters and targets specific assets.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this behaviour belongs.
filters	expression	A search pattern used to filter the providers which can implement this behaviour.
id	uint64	Unique identifier of this behaviour.
name	string maximum-length: 100	The name of this behaviour.
notes	string	Notes.
parameters	Object.<string, BehaviourParameter>	The list of defined variable name/value pairs for the script requires.
priority	byte	The priority flag allows you to define an execution order for all behaviours for a provider.
processedUtc	datetime	When the was change procesed.
script	uint64 see: BehaviourScript.id	The script which this behaviour implements.
targets	expression	The search pattern used to target the assets which will embed this behaviour in their execution context.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"filters": string,
	"id": number,
	"name": string,
	"notes": string,
	"parameters": {
		string: {
			"context": string,
			"notes": string,
			"type": string,
			"value": string
		}
	},
	"priority": number,
	"processedUtc": string,
	"script": number,
	"targets": string,
	"updated": {
	},
	"v": [
		number
	]
}

BehaviourDeletedobject

The message format for when a deleted Behaviour is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this behaviour belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this behaviour.
name	string maximum-length: 100		The name of this behaviour.
notes	string		Notes.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

BehaviourLogobject

A debug message available to script writers to help debug and trace output from a BehaviourScript.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset which whose behaviours created this log entry.
behaviour	uint64? see: Behaviour.id	The behaviour to which this log message belongs.
character	uint32?	The character column where the error was generated.
company	uint64 see: Company.id	The company to which this log message belongs.
dts	datetime	When the log entry was generated by the script.
id	uint64	Unique identifier of this log message.
kind	BehaviourLogType	The category of message.
line	uint32	The line number of the script which generated this message.
message	string	The body of the message.
processedUtc	datetime	When the was change procesed.
script	uint64 see: BehaviourScript.id	The script which generated this log message.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"behaviour": number,
	"character": number,
	"company": number,
	"dts": string,
	"id": number,
	"kind": string,
	"line": number,
	"message": string,
	"processedUtc": string,
	"script": number,
	"updated": {
	},
	"v": [
		number
	]
}

BehaviourLogDeletedobject

The message format for when a deleted BehaviourLog is retrieved

JSON description

Property	Type	Value	Description
asset	uint64 see: Asset.id		The asset which whose behaviours created this log entry.
company	uint64 see: Company.id		The company to which this log message belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this log message.
kind	BehaviourLogType		The category of message.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"since": string,
	"v": [
		number
	]
}

BehaviourLogTypestring

The type of logged message.

Value	Description
err	Used for errors.
info	Used for more important messages.
log	Used for general information messages.
warn	Used for warnings.

BehaviourParameterobject

Definition of an argument passed to a Behaviour Script.

JSON description

Property	Type	Description
context	string	Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types.
notes	string	Usage notes.
type	BehaviourParameterType	Simple type information for the compiler.
value	string	The value is given as a string, but parsed into native type when compiled.

JSON structure

{
	"context": string,
	"notes": string,
	"type": string,
	"value": string
}

BehaviourParameterTypestring

Possible data-types given to BehaviourParameters.

Value	Description
boolean	True or false.
json	Object or array literal.
number	Numeric value (signed double-precision floating point number).
string	Text.

BehaviourScriptobject

Business logic run by the system to react to GPS events and device information.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this script belongs.
compiles	boolean	Flag set by the compiler if this code compiles
fill	colour maximum-length: 22	The background colour given to this script for easy visual identification.
filters	expression	A list of targeting expressions. These expressions are defaults for derived Behaviours.
global	boolean	Indicates whether this script is available to child companies.
graphic	codified maximum-length: 22	The codified graphic name given to this script for easy visual identification.
id	uint64	Unique identifier of this script.
name	string maximum-length: 100	The nickname given to this script.
notes	string	Usage notes and instructions for users on how best to setup this script.
parameters	Object.<string, BehaviourParameter>	Listed parameters for the Behaviour function.
processedUtc	datetime	When the was change procesed.
source	string maximum-length: 8060	The source code.
stroke	colour maximum-length: 22	The text/graphic colour given to this script for easy visual identification.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"compiles": boolean,
	"fill": string,
	"filters": string,
	"global": boolean,
	"graphic": string,
	"id": number,
	"name": string,
	"notes": string,
	"parameters": {
		string: {
			"context": string,
			"notes": string,
			"type": string,
			"value": string
		}
	},
	"processedUtc": string,
	"source": string,
	"stroke": string,
	"updated": {
	},
	"v": [
		number
	]
}

BehaviourScriptDeletedobject

The message format for when a deleted BehaviourScript is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this script belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this script.
name	string maximum-length: 100		The nickname given to this script.
notes	string		Usage notes and instructions for users on how best to setup this script.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ParamBehaviourBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
behaviours	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviours": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamBehaviourBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
behaviours	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviours": [
		{
			"company": number,
			"filters": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"context": string,
					"notes": string,
					"type": string,
					"value": string
				}
			},
			"priority": number,
			"script": number,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamBehaviourDeleteBaseParametersobject

Request description

Property	Type	Required	Description
behaviour	ParamId	always	An object to contain the "id" key.
behaviour.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviour	ParamId	always		An object to contain the "id" key.
behaviour.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Behaviour.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamBehaviourListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourListByScriptBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviourScript	ParamId	always		An object to contain the "id" of the Company.
behaviourScript.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogClearByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogClearByBehaviourBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviour	ParamId	always		An object to contain the "id" of the Behaviour.
behaviour.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogClearByScriptBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviourScript	ParamId	always		An object to contain the "id" of the BehaviourScript.
behaviourScript.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogListByBehaviourBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviour	ParamId	always		An object to contain the "id" of the Behaviour.
behaviour.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourLogListByScriptBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviourScript	ParamId	always		An object to contain the "id" of the BehaviourScript.
behaviourScript.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBehaviourMergeBaseParametersobject

Request description

Property	Type	Required	Description
behaviour	Object.<string, ?>	always	A simple object to contain the Behaviour parameters.
behaviour.company	uint64?	create
behaviour.filters	expression	optional	A search pattern used to select the assets which will embed this Behaviour in their execution context.
behaviour.id	uint64?	update	The unique identifier of the Behaviour you want to update.
behaviour.name	string maximum-length: 100	create	Name for the Behaviour.
behaviour.notes	string	optional	Notes for the Behaviour.
behaviour.parameters	Object.<string, BehaviourParameter>	optional	The values needed to implement the script. Each key in this object is the name of a required script argument.
behaviour.priority	byte?	optional	The order in which this Behaviour is executed.
behaviour.script	uint64?	create	Identifier of the BehaviourScript to which this Behaviour belongs. After creation, this value is read-only.
behaviour.targets	expression	optional	A search pattern used to select the providers which can implement this Behaviour.
behaviour.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"company": number,
		"filters": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,
				"value": string
			}
		},
		"priority": number,
		"script": number,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamBehaviourRestoreBaseParametersobject

Request description

Property	Type	Required	Description
behaviour	ParamId	always	An object to contain the "id" key.
behaviour.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourScriptBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
behaviourScripts	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScripts": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamBehaviourScriptBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
behaviourScripts	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScripts": [
		{
			"company": number,
			"fill": string,
			"filters": string,
			"global": boolean,
			"graphic": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"context": string,
					"notes": string,
					"type": string,
					"value": string
				}
			},
			"source": string,
			"stroke": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamBehaviourScriptDeleteBaseParametersobject

Request description

Property	Type	Required	Description
behaviourScript	ParamId	always	An object to contain the "id" key.
behaviourScript.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourScriptGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
behaviourScript	ParamId	always		An object to contain the "id" key.
behaviourScript.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted BehaviourScript.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamBehaviourScriptListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional		When true (default) the getter to retrieve the given Company's list of BehaviourScripts as well as any publicly available BehaviourScripts for the Company's parent(s).

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number,
	"tree": boolean
}

ParamBehaviourScriptMergeBaseParametersobject

Request description

Property	Type	Required	Description
behaviourScript	Object.<string, ?>	always	A simple object to contain the BehaviourScript parameters.
behaviourScript.company	uint64?	create	Identifier of the Company to which this BehaviourScript belongs. After creation, this value is read-only.
behaviourScript.fill	string	optional	Background and fill colour in the UI.
behaviourScript.filters	expression	optional	A search pattern used to select the providers.
behaviourScript.global	boolean	optional	When set to true, this Company as well as all child companies will be able to implement this BehaviourScript for that companies assets.
behaviourScript.graphic	string	optional	The name of the symbol shown in the UI.
behaviourScript.id	uint64?	update	The unique identifier of the BehaviourScript you want to update.
behaviourScript.name	string maximum-length: 100	create	Name for the BehaviourScript.
behaviourScript.notes	string	optional	Notes for the BehaviourScript.
behaviourScript.parameters	Object.<string, BehaviourParameter>	optional	The defined arguments for this BehaviourScript. Each key in the object is the name of an argument.
behaviourScript.source	string	create	Source code of the BehaviourScript.
behaviourScript.stroke	string	optional	Text and outline colour in the UI.
behaviourScript.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"company": number,
		"fill": string,
		"filters": string,
		"global": boolean,
		"graphic": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,
				"value": string
			}
		},
		"source": string,
		"stroke": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamBehaviourScriptRestoreBaseParametersobject

Request description

Property	Type	Required	Description
behaviourScript	ParamId	always	An object to contain the "id" key.
behaviourScript.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

RespBehaviourBatchDeleteBaseResponseobject

Response description

Property	Type	Description
behaviours	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviours": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourBatchMergeBaseResponseobject

Response description

Property	Type	Description
behaviours	Array.<RespIdScript>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviours": [
		{
			"company": number,
			"id": number,
			"script": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourDeleteBaseResponseobject

Response description

Property	Type	Description
behaviour	RespDeleted	An object which contains the Behaviour's id, owning Company id, and deleted status.
behaviour.company	uint64	Identifier of the Company to which this object belongs.
behaviour.deleted	boolean	Flag showing if the object is deleted.
behaviour.id	uint64?	Identifier given as input for the command.
behaviour.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourGetBaseResponseobject

Response description

Property	Type	Description
behaviour	Behaviour	The requested Behaviour.
behaviour.company	uint64 see: Company.id	The company to which this behaviour belongs.
behaviour.filters	expression	A search pattern used to filter the providers which can implement this behaviour.
behaviour.id	uint64	Unique identifier of this behaviour.
behaviour.name	string maximum-length: 100	The name of this behaviour.
behaviour.notes	string	Notes.
behaviour.parameters	Object.<string, BehaviourParameter>	The list of defined variable name/value pairs for the script requires.
behaviour.priority	byte	The priority flag allows you to define an execution order for all behaviours for a provider.
behaviour.processedUtc	datetime	When the was change procesed.
behaviour.script	uint64 see: BehaviourScript.id	The script which this behaviour implements.
behaviour.targets	expression	The search pattern used to target the assets which will embed this behaviour in their execution context.
behaviour.updated		by: login, from: monster
behaviour.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"filters": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,
				"value": string
			}
		},
		"priority": number,
		"processedUtc": string,
		"script": number,
		"targets": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourListByCompanyBaseResponseobject

Response description

Property	Type	Description
behaviours	Array.<Behaviour>	The list of reqested Behaviours.
company	RespId	An object to contain the "id" of the Company to which the array of Behaviours belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviours": [
		{
			"company": number,
			"filters": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"context": string,
					"notes": string,
					"type": string,
					"value": string
				}
			},
			"priority": number,
			"processedUtc": string,
			"script": number,
			"targets": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourListByScriptBaseResponseobject

Response description

Property	Type	Description
behaviours	Array.<Behaviour>	The list of reqested Behaviours.
behaviourScript	RespIdCompany	An object to contain the "id" of the Company to which the array of Behaviours belong.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviours": [
		{
			"company": number,
			"filters": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"context": string,
					"notes": string,
					"type": string,
					"value": string
				}
			},
			"priority": number,
			"processedUtc": string,
			"script": number,
			"targets": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogClearByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of BehaviourLogs relates.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
count	int32	The total number of behaviour logs cleared.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"count": number,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogClearByBehaviourBaseResponseobject

Response description

Property	Type	Description
behaviour	RespIdScript	An object to contain the "id" of the Behaviour to which the array of BehaviourLogs belong.
behaviour.company	uint64	Identifier of the Company to which this object belongs.
behaviour.id	uint64?	Identifier given as input for the command.
behaviour.script	uint64	Identifier of the script to which this object belongs.
count	int32	The total number of behaviour logs cleared.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"id": number,
		"script": number
	},
	"count": number,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogClearByScriptBaseResponseobject

Response description

Property	Type	Description
behaviourScript	RespIdCompany	An object to contain the "id" of the BehaviourScript to which the array of BehaviourLogs belong.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.id	uint64?	Identifier given as input for the command.
count	int32	The total number of behaviour logs cleared.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"count": number,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of BehaviourLogs relates.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
behaviourLogs	Array.<BehaviourLog>	The list of requested BehaviourLogs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"behaviourLogs": [
		{
			"asset": number,
			"behaviour": number,
			"character": number,
			"company": number,
			"dts": string,
			"id": number,
			"kind": string,
			"line": number,
			"message": string,
			"processedUtc": string,
			"script": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogListByBehaviourBaseResponseobject

Response description

Property	Type	Description
behaviour	RespIdScript	An object to contain the "id" of the Behaviour to which the array of BehaviourLogs belong.
behaviour.company	uint64	Identifier of the Company to which this object belongs.
behaviour.id	uint64?	Identifier given as input for the command.
behaviour.script	uint64	Identifier of the script to which this object belongs.
behaviourLogs	Array.<BehaviourLog>	The list of requested BehaviourLogs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"id": number,
		"script": number
	},
	"behaviourLogs": [
		{
			"asset": number,
			"behaviour": number,
			"character": number,
			"company": number,
			"dts": string,
			"id": number,
			"kind": string,
			"line": number,
			"message": string,
			"processedUtc": string,
			"script": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogListByScriptBaseResponseobject

Response description

Property	Type	Description
behaviourLogs	Array.<BehaviourLog>	The list of requested BehaviourLogs.
behaviourScript	RespIdCompany	An object to contain the "id" of the BehaviourScript to which the array of BehaviourLogs belong.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourLogs": [
		{
			"asset": number,
			"behaviour": number,
			"character": number,
			"company": number,
			"dts": string,
			"id": number,
			"kind": string,
			"line": number,
			"message": string,
			"processedUtc": string,
			"script": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourMergeBaseResponseobject

Response description

Property	Type	Description
behaviour	RespIdScript	An object which contains the "id", "company", and "script" keys when there is no error.
behaviour.company	uint64	Identifier of the Company to which this object belongs.
behaviour.id	uint64?	Identifier given as input for the command.
behaviour.script	uint64	Identifier of the script to which this object belongs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"id": number,
		"script": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourRestoreBaseResponseobject

Response description

Property	Type	Description
behaviour	RespDeleted	An object which contains the Behaviour's id, owning Company id, and deleted status.
behaviour.company	uint64	Identifier of the Company to which this object belongs.
behaviour.deleted	boolean	Flag showing if the object is deleted.
behaviour.id	uint64?	Identifier given as input for the command.
behaviour.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviour": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptBatchDeleteBaseResponseobject

Response description

Property	Type	Description
behaviourScripts	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScripts": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptBatchMergeBaseResponseobject

Response description

Property	Type	Description
behaviourScripts	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScripts": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptDeleteBaseResponseobject

Response description

Property	Type	Description
behaviourScript	RespDeleted	An object which contains the BehaviourScript's id, owning Company id, and deleted status.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.deleted	boolean	Flag showing if the object is deleted.
behaviourScript.id	uint64?	Identifier given as input for the command.
behaviourScript.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScript": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptGetBaseResponseobject

Response description

Property	Type	Description
behaviourScript	BehaviourScript	The requested BehaviourScript.
behaviourScript.company	uint64 see: Company.id	The company to which this script belongs.
behaviourScript.compiles	boolean	Flag set by the compiler if this code compiles
behaviourScript.fill	colour maximum-length: 22	The background colour given to this script for easy visual identification.
behaviourScript.filters	expression	A list of targeting expressions. These expressions are defaults for derived Behaviours.
behaviourScript.global	boolean	Indicates whether this script is available to child companies.
behaviourScript.graphic	codified maximum-length: 22	The codified graphic name given to this script for easy visual identification.
behaviourScript.id	uint64	Unique identifier of this script.
behaviourScript.name	string maximum-length: 100	The nickname given to this script.
behaviourScript.notes	string	Usage notes and instructions for users on how best to setup this script.
behaviourScript.parameters	Object.<string, BehaviourParameter>	Listed parameters for the Behaviour function.
behaviourScript.processedUtc	datetime	When the was change procesed.
behaviourScript.source	string maximum-length: 8060	The source code.
behaviourScript.stroke	colour maximum-length: 22	The text/graphic colour given to this script for easy visual identification.
behaviourScript.updated		by: login, from: monster
behaviourScript.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScript": {
		"company": number,
		"compiles": boolean,
		"fill": string,
		"filters": string,
		"global": boolean,
		"graphic": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,
				"value": string
			}
		},
		"processedUtc": string,
		"source": string,
		"stroke": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptListByCompanyBaseResponseobject

Response description

Property	Type	Description
behaviourScripts	Array.<BehaviourScript>	The list of requested BehaviourScripts.
company	RespId	An object to contain the "id" of the Company to which the array of BehaviourScripts belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScripts": [
		{
			"company": number,
			"compiles": boolean,
			"fill": string,
			"filters": string,
			"global": boolean,
			"graphic": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"context": string,
					"notes": string,
					"type": string,
					"value": string
				}
			},
			"processedUtc": string,
			"source": string,
			"stroke": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptMergeBaseResponseobject

Response description

Property	Type	Description
behaviourScript	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptRestoreBaseResponseobject

Response description

Property	Type	Description
behaviourScript	RespDeleted	An object which contains the BehaviourScript's id, owning Company id, and deleted status.
behaviourScript.company	uint64	Identifier of the Company to which this object belongs.
behaviourScript.deleted	boolean	Flag showing if the object is deleted.
behaviourScript.id	uint64?	Identifier given as input for the command.
behaviourScript.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"behaviourScript": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

Billing

BillableHostingLicenseobject

A hardware license for providers

JSON description

Property	Type	Description
amount	double	Cost per cycle for this plan
company	uint64 see: Company.id	Unique identifier of the Company that owns this hosting rule.
end	datetime	Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
id	uint64	Unique identifier of this hosting rule.
kind	BillableLicenseType	The type of hardware license
limit	uint32?	The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
name	string maximum-length: 254	The name of this billing rule.
notes	string	Notes about billing this rule.
processedUtc	datetime	When the was change procesed.
profile	uint64 see: BillingProfile.id	Unique identifier of this rule's billing profile.
reference	string maximum-length: 100	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
sku	string maximum-length: 20	SKU or SOC code
start	datetime	Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
suspended	boolean	Does this hosting rule apply to suspended resources
targets	expression	Which assets are targeted by this hosting rule
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"amount": number,
	"company": number,
	"end": string,
	"id": number,
	"kind": string,
	"limit": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"profile": number,
	"reference": string,
	"sku": string,
	"start": string,
	"suspended": boolean,
	"targets": string,
	"updated": {
	},
	"v": [
		number
	]
}

BillableHostingLicenseDeletedobject

The message format for when a deleted BillableHostingLicense is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		Unique identifier of the Company that owns this hosting rule.
deleted	boolean	`true`
id	uint64		Unique identifier of this hosting rule.
kind	BillableLicenseType		The type of hardware license
name	string maximum-length: 254		The name of this billing rule.
notes	string		Notes about billing this rule.
profile	uint64 see: BillingProfile.id		Unique identifier of this rule's billing profile.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillableHostingRuleobject

A billing rule for assets

JSON description

Property	Type	Description
amount	double	Cost per cycle for this plan
company	uint64 see: Company.id	Unique identifier of the Company that owns this hosting rule.
end	datetime	Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
id	uint64	Unique identifier of this hosting rule.
limit	uint32?	The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
name	string maximum-length: 254	The name of this billing rule.
notes	string	Notes about billing this rule.
processedUtc	datetime	When the was change procesed.
profile	uint64 see: BillingProfile.id	Unique identifier of this rule's billing profile.
reference	string maximum-length: 100	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
service	BillableHostingType	The type of service being billed.
sku	string maximum-length: 20	SKU or SOC code
start	datetime	Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
suspended	boolean	Does this hosting rule apply to suspended resources
targets	expression	Which assets are targeted by this hosting rule
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"amount": number,
	"company": number,
	"end": string,
	"id": number,
	"limit": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"profile": number,
	"reference": string,
	"service": string,
	"sku": string,
	"start": string,
	"suspended": boolean,
	"targets": string,
	"updated": {
	},
	"v": [
		number
	]
}

BillableHostingRuleDeletedobject

The message format for when a deleted BillableHostingRule is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		Unique identifier of the Company that owns this hosting rule.
deleted	boolean	`true`
id	uint64		Unique identifier of this hosting rule.
name	string maximum-length: 254		The name of this billing rule.
notes	string		Notes about billing this rule.
profile	uint64 see: BillingProfile.id		Unique identifier of this rule's billing profile.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillableHostingTypestring

The kind of service being billed.

Value	Description
asset	Generic dot-on-a-map tracking
dispatch	Tasks assignable to vehicles or persons
elogs	FMCSA compliant E-Logs and Hours of Service
mobile	Employee/driver tracking
vehicle	Vehicle tracking (includes VBus data, and engine hours)

BillableLicenseTypestring

The kind of license being billed.

Value	Description
bewhere	BeWhere license fee see: ProviderType.bewhere
calamp	CalAmp PULS fee see: ProviderType.calamp
smartwitness	SmartWitness data hosting fee see: ProviderType.smartwitness

BillableSmsProfileobject

Description of a tiered SMS messaging limit

JSON description

Property	Type	Description
amount	double	Cost per SMS message sent. Received messages are free.
limit	uint32	The maximum number of messages sent per cycle

JSON structure

{
	"amount": number,
	"limit": number
}

BillingCurrencystring

Used for invoices.

Value	Description
CAD	Canadian dollars
EURO	Eurozone currency
USD	American dollars

BillingCyclestring

The type of repeating cycle used for generating bills.

Value	Description
annually	Once per year
monthly	Once a month
quarterly	Every three months

BillingProfileobject

A profile used to generate billable orders for a customer.

JSON description

Property	Type	Description
billee	uint64 see: Company.id	Unique identifier of the Company receiving the bill. Most of the time, this value is the same as the target.
company	uint64 see: Company.id	Unique identifier of the Company that owns this profile and is sending the bill.
currency	BillingCurrency	kind of money
cycle	BillingCycle	Repeating cycle used for generating bills
cycleEnd	datetime	When should the cycle end (customer cancelled)
cyclePostDated	boolean	Pro-rated, or post-dated.
cycleStart	datetime	When is the first day of the billing cycle
googleServicesEnabled	boolean	Are the Google services available to be proxied by the service?
id	uint64	Unique identifier of this billing profile
messages	Array.<BillableSmsProfile>	SMS messaging tiers
name	string maximum-length: 254	The name for this profile
notes	string maximum-length: 1000	Notes about the billing profile for the billee or target.
processedUtc	datetime	When the was change procesed.
target	uint64 see: Company.id	Unique identifier of the Company to which this rule pertains.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"billee": number,
	"company": number,
	"currency": string,
	"cycle": string,
	"cycleEnd": string,
	"cyclePostDated": boolean,
	"cycleStart": string,
	"googleServicesEnabled": boolean,
	"id": number,
	"messages": [
		{
			"amount": number,
			"limit": number
		}
	],
	"name": string,
	"notes": string,
	"processedUtc": string,
	"target": number,
	"updated": {
	},
	"v": [
		number
	]
}

BillingProfileDeletedobject

The message format for when a deleted BillingProfile is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		Unique identifier of the Company that owns this profile and is sending the bill.
deleted	boolean	`true`
id	uint64		Unique identifier of this billing profile
name	string maximum-length: 254		The name for this profile
notes	string maximum-length: 1000		Notes about the billing profile for the billee or target.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

BillingReportobject

Report generated per billee company.

JSON description

Property	Type	Description
billee	uint64 see: Company.id	Unique identifier of the Company receiving the bill.
breakdown	Array.<BillingReportBreakdown>	Individual amounts per company, used to calculate the results of the report.
company	uint64 see: Company.id	The company to which this report belongs and is sending the bill.
currency	BillingCurrency	Currency being billed in
endDate	datetime	Last day of the billing cycle
error	string see: BillingReportStatus maximum-length: 250	A field which contains report error details if the BillingReport.status is BillingReportStatus.failed.
id	uint64	Unique identifier
name	string maximum-length: 100	Name of this report.
notes	string	Notes about this report.
processedUtc	datetime	When the was change procesed.
profile	uint64 see: BillingProfile.id	The profile to which this report belongs
startDate	datetime	First day of the billing cycle
status	BillingReportStatus	The processing status of this report.
summary	Array.<BillingReportSummary>	Summary contains totals per target for this billee
total	double	Total amount being billed.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"billee": number,
	"breakdown": [
		{
			"licenses": [
				{
					"billableDays": number,
					"cost": number,
					"created": string,
					"deleted": string,
					"firmware": string,
					"kind": string,
					"name": string,
					"notes": string,
					"phoneNumber": number,
					"provider": string,
					"total": number
				}
			],
			"services": [
				{
					"asset": number,
					"billableDays": number,
					"cost": number,
					"created": string,
					"deleted": string,
					"kind": string,
					"labels": [
						string
					],
					"name": string,
					"notes": string,
					"phoneNumbers": [
						number
					],
					"providers": [
						string
					],
					"restored": string,
					"revived": string,
					"suspended": string,
					"suspendedCost": number,
					"suspendedDays": number,
					"total": number,
					"updatedDts": string
				}
			],
			"target": number
		}
	],
	"company": number,
	"currency": string,
	"endDate": string,
	"error": string,
	"id": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"profile": number,
	"startDate": string,
	"status": string,
	"summary": [
		{
			"hosting": [
				{
					"cost": number,
					"count": number,
					"sku": string,
					"total": number
				}
			],
			"name": string,
			"notes": string,
			"parent": number,
			"target": number
		}
	],
	"total": number,
	"updated": {
	},
	"v": [
		number
	]
}

BillingReportBreakdownobject

Billing breakdown per target company.

JSON description

Property	Type	Description
licenses	Array.<BillingReportLicenseBreakdown>	Individual amounts for licensing per targeted providers.
services	Array.<BillingReportServiceBreakdown>	Individual amounts billed per targeted assets.
target	uint64 see: Company.id	The target company to which this breakdown instance belongs.

JSON structure

{
	"licenses": [
		{
			"billableDays": number,
			"cost": number,
			"created": string,
			"deleted": string,
			"firmware": string,
			"kind": string,
			"name": string,
			"notes": string,
			"phoneNumber": number,
			"provider": string,
			"total": number
		}
	],
	"services": [
		{
			"asset": number,
			"billableDays": number,
			"cost": number,
			"created": string,
			"deleted": string,
			"kind": string,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"phoneNumbers": [
				number
			],
			"providers": [
				string
			],
			"restored": string,
			"revived": string,
			"suspended": string,
			"suspendedCost": number,
			"suspendedDays": number,
			"total": number,
			"updatedDts": string
		}
	],
	"target": number
}

BillingReportDeletedobject

The message format for when a deleted BillingReport is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this report belongs and is sending the bill.
deleted	boolean	`true`	Indicates whether this report is deleted.
id	uint64		Unique identifier
name	string maximum-length: 100		Name of this report.
notes	string		Notes about this report.
profile	uint64 see: BillingProfile.id		The profile to which this report belongs
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillingReportHostingSummaryobject

Amount billed for a type of hosting (service or license) per target company.

JSON description

Property	Type	Description
cost	double	Cost per billing cycle for this SKU.
count	double	Number of items for this SKU.
sku	string	SKU being billed
total	double	Total amount being billed for this SKU.

JSON structure

{
	"cost": number,
	"count": number,
	"sku": string,
	"total": number
}

BillingReportLicenseBreakdownobject

Full breakdown of licensing details per targeted provider.

JSON description

Property	Type	Description
billableDays	double	Number of days this Provider is being billed for.
cost	double	Licensing cost per billing cycle for this provider.
created	datetime	Indicates when this Provider was created.
deleted	datetime	Indicates when this Provider was deleted.
firmware	string maximum-length: 100	The firmware/application version number.
kind	ProviderType	Type of provider.
name	string maximum-length: 100	Provider name.
notes	string	Notes about the provider.
phoneNumber	uint64?	The phone number for this provider.
provider	string see: Provider.id	The provider to which this breakdown instance belongs.
total	double	Total amount being billed for this provider.

JSON structure

{
	"billableDays": number,
	"cost": number,
	"created": string,
	"deleted": string,
	"firmware": string,
	"kind": string,
	"name": string,
	"notes": string,
	"phoneNumber": number,
	"provider": string,
	"total": number
}

BillingReportServiceBreakdownobject

Full breakdown of billable details per targeted asset.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this breakdown instance belongs.
billableDays	double	Number of days this Asset is being billed for.
cost	double	Cost per billing cycle for this asset.
created	datetime	Indicates when this Asset was created.
deleted	datetime	Indicates when this Asset was deleted.
kind	AssetType	Type of asset.
labels	Array.<codified> see: LabelStyle.code for values see: LabelStyle.code	Codified label names.
name	string maximum-length: 100	Asset's name.
notes	string	Notes about the asset.
phoneNumbers	Array.<phone>	The list of phone numbers for this asset.
providers	Array.<string> see: Provider.id	The list of devices providing events for this asset.
restored	datetime	Indicates when this Asset was restored after being deleted.
revived	datetime	Indicates when this Asset was revived after being suspended.
suspended	datetime	Indicates when this Asset wass suspended from event processing.
suspendedCost	double	Cost per billing cycle for suspended asset.
suspendedDays	double	Number of days this Asset was suspended.
total	double	Total amount being billed for this asset.
updatedDts	datetime	Indicates when this Asset was last updated.

JSON structure

{
	"asset": number,
	"billableDays": number,
	"cost": number,
	"created": string,
	"deleted": string,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"phoneNumbers": [
		number
	],
	"providers": [
		string
	],
	"restored": string,
	"revived": string,
	"suspended": string,
	"suspendedCost": number,
	"suspendedDays": number,
	"total": number,
	"updatedDts": string
}

BillingReportStatusstring

The lifetime of building a BillingReport.

Value	Description
completed	The BillingReport is available for retrieval.
created	The BillingReport has been requested, but not yet begun processing.
failed	There was an error processing the BillingReport; see the BillingReport.error for a description.
queued	The BillingReport is waiting for required resources to begin processing.
running	The BillingReport is currently being processed.

BillingReportSummaryobject

Summarized bill per target.

JSON description

Property	Type	Description
hosting	Array.<BillingReportHostingSummary>	Summary contains totals per type of hosting (services and licenses) for this target
name	string maximum-length: 100	Target's name.
notes	string	Notes about the target.
parent	uint64 see: Company.id	The target company's parent.
target	uint64 see: Company.id	The target company to which this summary instance belongs.

JSON structure

{
	"hosting": [
		{
			"cost": number,
			"count": number,
			"sku": string,
			"total": number
		}
	],
	"name": string,
	"notes": string,
	"parent": number,
	"target": number
}

BillingSkuTypestring

The kind of SKU being billed.

Value	Description
license	Hardware license for providers
ratePlan	Cellular/data rate plan
service	Hosting service
support	Support contract

ParamBillingProfileBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
billingProfiles	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfiles": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamBillingProfileBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
billingProfiles	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfiles": [
		{
			"billee": number,
			"company": number,
			"currency": string,
			"cycle": string,
			"cycleEnd": string,
			"cyclePostDated": boolean,
			"cycleStart": string,
			"googleServicesEnabled": boolean,
			"id": number,
			"messages": [
				{
					"amount": number,
					"limit": number
				}
			],
			"name": string,
			"notes": string,
			"target": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamBillingProfileDeleteBaseParametersobject

Request description

Property	Type	Required	Description
billingProfile	ParamId	always	An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingProfileGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
billingProfile	ParamId	always		An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted BillingProfile.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamBillingProfileListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamBillingProfileMergeBaseParametersobject

Request description

Property	Type	Required	Description
billingProfile	Object.<string, ?>	always	A simple object to contain the BillingProfile parameters.
billingProfile.billee	uint64?	optional	Unique identifier of the Company receiving the bill.
billingProfile.company	uint64?	optional	Unique identifier of the Company that owns this BillingProfile and is sending the bill.
billingProfile.currency	BillingCurrency?	optional	Kind of money.
billingProfile.cycle	BillingCycle?	optional	Repeating cycle used for generating bills.
billingProfile.cycleEnd	datetime	optional	When should the cycle end (customer cancelled); null means it never ends.
billingProfile.cyclePostDated	boolean	optional	Pro-rated, or post-dated.
billingProfile.cycleStart	datetime	optional	When is the first day of the billing cycle.
billingProfile.googleServicesEnabled	boolean	optional	Are the Google services available to be proxied by the service?
billingProfile.id	uint64?	optional	Unique identifier of the BillingProfile you want to update.
billingProfile.messages	Array.<BillableSmsProfile>	optional	SMS messaging tiers.
billingProfile.name	string	optional	Name for the BillingProfile
billingProfile.notes	string	optional	Notes about the BillingProfile for the billee or target.
billingProfile.target	uint64?	optional	Unique identifier of the Company to which this rule pertains.
billingProfile.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"billee": number,
		"company": number,
		"currency": string,
		"cycle": string,
		"cycleEnd": string,
		"cyclePostDated": boolean,
		"cycleStart": string,
		"googleServicesEnabled": boolean,
		"id": number,
		"messages": [
			{
				"amount": number,
				"limit": number
			}
		],
		"name": string,
		"notes": string,
		"target": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamBillingProfileRestoreBaseParametersobject

Request description

Property	Type	Required	Description
billingProfile	ParamId	always	An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
billingReports	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingReports": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamBillingReportDeleteBaseParametersobject

Request description

Property	Type	Required	Description
billingReport	ParamId	always	An object to contain the "id" of the BillingReport.
billingReport.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingReport": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
billingReport	ParamId	always		An object to contain the "id" of the BillingReport.
billingReport.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted BillingReport.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingReport": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamBillingReportListByBillingProfileBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
billingProfile	ParamId	always		An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"billingProfile": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamBillingReportListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamBillingReportRestoreBaseParametersobject

Request description

Property	Type	Required	Description
billingReport	ParamId	always	An object to contain the "id" of the BillingReport.
billingReport.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingReport": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
hostingLicenses	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicenses": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamHostingLicenseBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
hostingLicenses	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicenses": [
		{
			"amount": number,
			"end": string,
			"id": number,
			"kind": string,
			"limit": number,
			"name": string,
			"notes": string,
			"profile": number,
			"reference": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamHostingLicenseDeleteBaseParametersobject

Request description

Property	Type	Required	Description
hostingLicense	ParamId	always	An object to contain the "id" of the BillableHostingLicense.
hostingLicense.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicense": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
hostingLicense	ParamId	always		An object to contain the "id" of the BillableHostingLicense.
hostingLicense.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted BillableHostingLicense.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicense": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamHostingLicenseListByBillingProfileBaseParametersobject

Request description

Property	Type	Required	Default	Description
billingProfile	ParamId	always		An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamHostingLicenseMergeBaseParametersobject

Request description

Property	Type	Required	Description
hostingLicense	Object.<string, ?>	always	A simple object to contain the BillableHostingLicense parameters.
hostingLicense.amount	double?	optional	Cost per cycle for this plan
hostingLicense.end	datetime	optional	Date this BillableHostingLicense is applied until; null means it never ends.
hostingLicense.id	uint64?	update	Unique identifier of the BillableHostingLicense you want to update.
hostingLicense.kind	BillableLicenseType?	create	The type of hardware BillableLicenseType.
hostingLicense.limit	uint32?	optional	The number of units to which this BillableHostingLicense applies. Should be a non-zero value; null means unlimited
hostingLicense.name	string	create	Name for the BillableHostingLicense
hostingLicense.notes	string	optional	Notes about the BillableHostingLicense.
hostingLicense.profile	uint64?	create	Unique identifier of this BillableHostingLicense's BillingProfile.
hostingLicense.reference	string	optional	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingLicense.start	datetime	optional	Date this BillableHostingLicense takes effect.
hostingLicense.suspended	boolean	optional	Does this BillableHostingLicense apply to suspended resources
hostingLicense.targets	expression	optional	Which assets are targetted by this BillableHostingLicense
hostingLicense.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicense": {
		"amount": number,
		"end": string,
		"id": number,
		"kind": string,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamHostingLicenseRestoreBaseParametersobject

Request description

Property	Type	Required	Description
hostingLicense	ParamId	always	An object to contain the "id" of the BillableHostingLicense.
hostingLicense.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingLicense": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
hostingRules	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRules": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamHostingRuleBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
hostingRules	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRules": [
		{
			"amount": number,
			"end": string,
			"id": number,
			"limit": number,
			"name": string,
			"notes": string,
			"profile": number,
			"reference": string,
			"service": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamHostingRuleDeleteBaseParametersobject

Request description

Property	Type	Required	Description
hostingRule	ParamId	always	An object to contain the "id" of the BillableHostingRule.
hostingRule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRule": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
hostingRule	ParamId	always		An object to contain the "id" of the BillableHostingRule.
hostingRule.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted BillableHostingRule.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRule": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamHostingRuleListByBillingProfileBaseParametersobject

Request description

Property	Type	Required	Default	Description
billingProfile	ParamId	always		An object to contain the "id" of the BillingProfile.
billingProfile.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"billingProfile": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamHostingRuleMergeBaseParametersobject

Request description

Property	Type	Required	Description
hostingRule	Object.<string, ?>	always	A simple object to contain the BillableHostingRule parameters.
hostingRule.amount	double?	optional	Cost per cycle for this plan
hostingRule.end	datetime	create	Date this BillableHostingRule is applied until; null means it never ends.
hostingRule.id	uint64?	update	Unique identifier of the BillableHostingRule you want to update.
hostingRule.limit	uint32?	optional	The number of units to which this BillableHostingRule applies. Should be a non-zero value; null means unlimited
hostingRule.name	string	create	Name for the BillableHostingRule
hostingRule.notes	string	optional	Notes about the BillableHostingRule.
hostingRule.profile	uint64?	create	Unique identifier of this BillableHostingRule's BillingProfile.
hostingRule.reference	string	optional	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingRule.service	BillableHostingType?	create	The type of service being billed.
hostingRule.start	datetime	create	Date this BillableHostingRule takes effect.
hostingRule.suspended	boolean	optional	Does this BillableHostingRule apply to suspended resources
hostingRule.targets	expression	optional	Which assets are targetted by this BillableHostingRule
hostingRule.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRule": {
		"amount": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"service": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamHostingRuleRestoreBaseParametersobject

Request description

Property	Type	Required	Description
hostingRule	ParamId	always	An object to contain the "id" of the BillableHostingRule.
hostingRule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"hostingRule": {
		"id": number
	},
	"reqId": number
}

RespBillingProfileBatchDeleteBaseResponseobject

Response description

Property	Type	Description
billingProfiles	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfiles": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileBatchMergeBaseResponseobject

Response description

Property	Type	Description
billingProfiles	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfiles": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileDeleteBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespDeleted	An object which contains the BillingProfile's unique identifier and deleted status.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.deleted	boolean	Flag showing if the object is deleted.
billingProfile.id	uint64?	Identifier given as input for the command.
billingProfile.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileGetBaseResponseobject

Response description

Property	Type	Description
billingProfile	BillingProfile	The requested BillingProfile.
billingProfile.billee	uint64 see: Company.id	Unique identifier of the Company receiving the bill. Most of the time, this value is the same as the target.
billingProfile.company	uint64 see: Company.id	Unique identifier of the Company that owns this profile and is sending the bill.
billingProfile.currency	BillingCurrency	kind of money
billingProfile.cycle	BillingCycle	Repeating cycle used for generating bills
billingProfile.cycleEnd	datetime	When should the cycle end (customer cancelled)
billingProfile.cyclePostDated	boolean	Pro-rated, or post-dated.
billingProfile.cycleStart	datetime	When is the first day of the billing cycle
billingProfile.googleServicesEnabled	boolean	Are the Google services available to be proxied by the service?
billingProfile.id	uint64	Unique identifier of this billing profile
billingProfile.messages	Array.<BillableSmsProfile>	SMS messaging tiers
billingProfile.name	string maximum-length: 254	The name for this profile
billingProfile.notes	string maximum-length: 1000	Notes about the billing profile for the billee or target.
billingProfile.processedUtc	datetime	When the was change procesed.
billingProfile.target	uint64 see: Company.id	Unique identifier of the Company to which this rule pertains.
billingProfile.updated		by: login, from: monster
billingProfile.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"billee": number,
		"company": number,
		"currency": string,
		"cycle": string,
		"cycleEnd": string,
		"cyclePostDated": boolean,
		"cycleStart": string,
		"googleServicesEnabled": boolean,
		"id": number,
		"messages": [
			{
				"amount": number,
				"limit": number
			}
		],
		"name": string,
		"notes": string,
		"processedUtc": string,
		"target": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileListByCompanyBaseResponseobject

Response description

Property	Type	Description
billingProfiles	Array.<BillingProfile>	The list of requested BillingProfiles.
company	RespId	An object to contain the "id" of the Company to which the array of BillingProfiles belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfiles": [
		{
			"billee": number,
			"company": number,
			"currency": string,
			"cycle": string,
			"cycleEnd": string,
			"cyclePostDated": boolean,
			"cycleStart": string,
			"googleServicesEnabled": boolean,
			"id": number,
			"messages": [
				{
					"amount": number,
					"limit": number
				}
			],
			"name": string,
			"notes": string,
			"processedUtc": string,
			"target": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileMergeBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespIdCompany	An object which contains the "id", "company", and "profile" keys.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileRestoreBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespDeleted	An object which contains the BillingProfile's unique identifier and deleted status.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.deleted	boolean	Flag showing if the object is deleted.
billingProfile.id	uint64?	Identifier given as input for the command.
billingProfile.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportBatchDeleteBaseResponseobject

Response description

Property	Type	Description
billingReports	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingReports": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportDeleteBaseResponseobject

Response description

Property	Type	Description
billingReport	RespDeleted	An object which contains the BillingReport's unique identifier and deleted status.
billingReport.company	uint64	Identifier of the Company to which this object belongs.
billingReport.deleted	boolean	Flag showing if the object is deleted.
billingReport.id	uint64?	Identifier given as input for the command.
billingReport.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingReport": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportGetBaseResponseobject

Response description

Property	Type	Description
billingReport	BillingReport	The requested BillingReport.
billingReport.billee	uint64 see: Company.id	Unique identifier of the Company receiving the bill.
billingReport.breakdown	Array.<BillingReportBreakdown>	Individual amounts per company, used to calculate the results of the report.
billingReport.company	uint64 see: Company.id	The company to which this report belongs and is sending the bill.
billingReport.currency	BillingCurrency	Currency being billed in
billingReport.endDate	datetime	Last day of the billing cycle
billingReport.error	string see: BillingReportStatus maximum-length: 250	A field which contains report error details if the BillingReport.status is BillingReportStatus.failed.
billingReport.id	uint64	Unique identifier
billingReport.name	string maximum-length: 100	Name of this report.
billingReport.notes	string	Notes about this report.
billingReport.processedUtc	datetime	When the was change procesed.
billingReport.profile	uint64 see: BillingProfile.id	The profile to which this report belongs
billingReport.startDate	datetime	First day of the billing cycle
billingReport.status	BillingReportStatus	The processing status of this report.
billingReport.summary	Array.<BillingReportSummary>	Summary contains totals per target for this billee
billingReport.total	double	Total amount being billed.
billingReport.updated		by: login, from: monster
billingReport.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingReport": {
		"billee": number,
		"breakdown": [
			{
				"licenses": [
					{
						"billableDays": number,
						"cost": number,
						"created": string,
						"deleted": string,
						"firmware": string,
						"kind": string,
						"name": string,
						"notes": string,
						"phoneNumber": number,
						"provider": string,
						"total": number
					}
				],
				"services": [
					{
						"asset": number,
						"billableDays": number,
						"cost": number,
						"created": string,
						"deleted": string,
						"kind": string,
						"labels": [
							string
						],
						"name": string,
						"notes": string,
						"phoneNumbers": [
							number
						],
						"providers": [
							string
						],
						"restored": string,
						"revived": string,
						"suspended": string,
						"suspendedCost": number,
						"suspendedDays": number,
						"total": number,
						"updatedDts": string
					}
				],
				"target": number
			}
		],
		"company": number,
		"currency": string,
		"endDate": string,
		"error": string,
		"id": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"profile": number,
		"startDate": string,
		"status": string,
		"summary": [
			{
				"hosting": [
					{
						"cost": number,
						"count": number,
						"sku": string,
						"total": number
					}
				],
				"name": string,
				"notes": string,
				"parent": number,
				"target": number
			}
		],
		"total": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportListByBillingProfileBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespIdCompany	An object to contain the "id" of the BillingProfile to which the array of BillableHostingRules belong.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.id	uint64?	Identifier given as input for the command.
billingReports	Array.<BillingReport>	The list of requested BillingReports.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"billingReports": [
		{
			"billee": number,
			"breakdown": [
				{
					"licenses": [
						{
							"billableDays": number,
							"cost": number,
							"created": string,
							"deleted": string,
							"firmware": string,
							"kind": string,
							"name": string,
							"notes": string,
							"phoneNumber": number,
							"provider": string,
							"total": number
						}
					],
					"services": [
						{
							"asset": number,
							"billableDays": number,
							"cost": number,
							"created": string,
							"deleted": string,
							"kind": string,
							"labels": [
								string
							],
							"name": string,
							"notes": string,
							"phoneNumbers": [
								number
							],
							"providers": [
								string
							],
							"restored": string,
							"revived": string,
							"suspended": string,
							"suspendedCost": number,
							"suspendedDays": number,
							"total": number,
							"updatedDts": string
						}
					],
					"target": number
				}
			],
			"company": number,
			"currency": string,
			"endDate": string,
			"error": string,
			"id": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"profile": number,
			"startDate": string,
			"status": string,
			"summary": [
				{
					"hosting": [
						{
							"cost": number,
							"count": number,
							"sku": string,
							"total": number
						}
					],
					"name": string,
					"notes": string,
					"parent": number,
					"target": number
				}
			],
			"total": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportListByCompanyBaseResponseobject

Response description

Property	Type	Description
billingReports	Array.<BillingReport>	The list of requested BillingReports.
company	RespId	An object to contain the "id" of the Company to which the array of BillingReports belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingReports": [
		{
			"billee": number,
			"breakdown": [
				{
					"licenses": [
						{
							"billableDays": number,
							"cost": number,
							"created": string,
							"deleted": string,
							"firmware": string,
							"kind": string,
							"name": string,
							"notes": string,
							"phoneNumber": number,
							"provider": string,
							"total": number
						}
					],
					"services": [
						{
							"asset": number,
							"billableDays": number,
							"cost": number,
							"created": string,
							"deleted": string,
							"kind": string,
							"labels": [
								string
							],
							"name": string,
							"notes": string,
							"phoneNumbers": [
								number
							],
							"providers": [
								string
							],
							"restored": string,
							"revived": string,
							"suspended": string,
							"suspendedCost": number,
							"suspendedDays": number,
							"total": number,
							"updatedDts": string
						}
					],
					"target": number
				}
			],
			"company": number,
			"currency": string,
			"endDate": string,
			"error": string,
			"id": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"profile": number,
			"startDate": string,
			"status": string,
			"summary": [
				{
					"hosting": [
						{
							"cost": number,
							"count": number,
							"sku": string,
							"total": number
						}
					],
					"name": string,
					"notes": string,
					"parent": number,
					"target": number
				}
			],
			"total": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportRestoreBaseResponseobject

Response description

Property	Type	Description
billingReport	RespDeleted	An object which contains the BillingReport's unique identifier and deleted status.
billingReport.company	uint64	Identifier of the Company to which this object belongs.
billingReport.deleted	boolean	Flag showing if the object is deleted.
billingReport.id	uint64?	Identifier given as input for the command.
billingReport.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingReport": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenses	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicenses": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingLicenseBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenses	Array.<RespIdBillingProfile>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicenses": [
		{
			"company": number,
			"id": number,
			"profile": number
		}
	],
	"message": string,
	"reqId": number
}

RespHostingLicenseDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicense	RespDeleted	An object which contains the BillableHostingLicense's unique identifier and deleted status.
hostingLicense.company	uint64	Identifier of the Company to which this object belongs.
hostingLicense.deleted	boolean	Flag showing if the object is deleted.
hostingLicense.id	uint64?	Identifier given as input for the command.
hostingLicense.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicense	BillableHostingLicense	The requested BillableHostingLicense.
hostingLicense.amount	double	Cost per cycle for this plan
hostingLicense.company	uint64 see: Company.id	Unique identifier of the Company that owns this hosting rule.
hostingLicense.end	datetime	Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
hostingLicense.id	uint64	Unique identifier of this hosting rule.
hostingLicense.kind	BillableLicenseType	The type of hardware license
hostingLicense.limit	uint32?	The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
hostingLicense.name	string maximum-length: 254	The name of this billing rule.
hostingLicense.notes	string	Notes about billing this rule.
hostingLicense.processedUtc	datetime	When the was change procesed.
hostingLicense.profile	uint64 see: BillingProfile.id	Unique identifier of this rule's billing profile.
hostingLicense.reference	string maximum-length: 100	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingLicense.sku	string maximum-length: 20	SKU or SOC code
hostingLicense.start	datetime	Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
hostingLicense.suspended	boolean	Does this hosting rule apply to suspended resources
hostingLicense.targets	expression	Which assets are targeted by this hosting rule
hostingLicense.updated		by: login, from: monster
hostingLicense.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"amount": number,
		"company": number,
		"end": string,
		"id": number,
		"kind": string,
		"limit": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"profile": number,
		"reference": string,
		"sku": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseListByBillingProfileBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespIdCompany	An object to contain the "id" of the BillingProfile to which the array of BillableHostingLicenses belong.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenses	Array.<BillableHostingLicense>	The list of BillableHostingLicenses.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicenses": [
		{
			"amount": number,
			"company": number,
			"end": string,
			"id": number,
			"kind": string,
			"limit": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"profile": number,
			"reference": string,
			"sku": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingLicenseMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicense	RespIdBillingProfile	An object which contains the "id", "company", and "profile" keys.
hostingLicense.company	uint64	Identifier of the Company to which this object belongs.
hostingLicense.id	uint64?	Identifier given as input for the command.
hostingLicense.profile	uint64	Identifier of the BillingProfile to which this object belongs
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"id": number,
		"profile": number
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicense	RespDeleted	An object which contains the BillableHostingLicense's unique identifier and deleted status.
hostingLicense.company	uint64	Identifier of the Company to which this object belongs.
hostingLicense.deleted	boolean	Flag showing if the object is deleted.
hostingLicense.id	uint64?	Identifier given as input for the command.
hostingLicense.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRules	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRules": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingRuleBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRules	Array.<RespIdBillingProfile>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRules": [
		{
			"company": number,
			"id": number,
			"profile": number
		}
	],
	"message": string,
	"reqId": number
}

RespHostingRuleDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRule	RespDeleted	An object which contains the BillableHostingRule's unique identifier and deleted status.
hostingRule.company	uint64	Identifier of the Company to which this object belongs.
hostingRule.deleted	boolean	Flag showing if the object is deleted.
hostingRule.id	uint64?	Identifier given as input for the command.
hostingRule.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRule	BillableHostingRule	The requested BillableHostingRule.
hostingRule.amount	double	Cost per cycle for this plan
hostingRule.company	uint64 see: Company.id	Unique identifier of the Company that owns this hosting rule.
hostingRule.end	datetime	Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
hostingRule.id	uint64	Unique identifier of this hosting rule.
hostingRule.limit	uint32?	The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
hostingRule.name	string maximum-length: 254	The name of this billing rule.
hostingRule.notes	string	Notes about billing this rule.
hostingRule.processedUtc	datetime	When the was change procesed.
hostingRule.profile	uint64 see: BillingProfile.id	Unique identifier of this rule's billing profile.
hostingRule.reference	string maximum-length: 100	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingRule.service	BillableHostingType	The type of service being billed.
hostingRule.sku	string maximum-length: 20	SKU or SOC code
hostingRule.start	datetime	Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
hostingRule.suspended	boolean	Does this hosting rule apply to suspended resources
hostingRule.targets	expression	Which assets are targeted by this hosting rule
hostingRule.updated		by: login, from: monster
hostingRule.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"amount": number,
		"company": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"profile": number,
		"reference": string,
		"service": string,
		"sku": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleListByBillingProfileBaseResponseobject

Response description

Property	Type	Description
billingProfile	RespIdCompany	An object to contain the "id" of the BillingProfile to which the array of BillableHostingRules belong.
billingProfile.company	uint64	Identifier of the Company to which this object belongs.
billingProfile.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRules	Array.<BillableHostingRule>	The list of requested BillableHostingRules.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRules": [
		{
			"amount": number,
			"company": number,
			"end": string,
			"id": number,
			"limit": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"profile": number,
			"reference": string,
			"service": string,
			"sku": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingRuleMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRule	RespIdBillingProfile	An object which contains the "id", "company", and "profile" keys.
hostingRule.company	uint64	Identifier of the Company to which this object belongs.
hostingRule.id	uint64?	Identifier given as input for the command.
hostingRule.profile	uint64	Identifier of the BillingProfile to which this object belongs
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"id": number,
		"profile": number
	},
	"message": string,
	"reqId": number
}

RespHostingRuleRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRule	RespDeleted	An object which contains the BillableHostingRule's unique identifier and deleted status.
hostingRule.company	uint64	Identifier of the Company to which this object belongs.
hostingRule.deleted	boolean	Flag showing if the object is deleted.
hostingRule.id	uint64?	Identifier given as input for the command.
hostingRule.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

Companies

Companyobject

The full company object which contains all fields.

JSON description

Property	Type	Description
directory	Object.<string, Array.<uint64>> for value-values see: Contact.id	The list of Contacts from this and other companies broken down by contact role.
id	uint64	Unique identifier of the Company.
labels	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for labels added to Assets, Places, and other things.
name	string maximum-length: 100	The organizational name.
notes	string	Notes.
parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
passwordPolicy	PasswordPolicy	The password complexity and expiry policy.
processedUtc	datetime	When the was change procesed.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
reseller	CompanyReseller	If this company is a reseller, then they have their own theme, support and billing information.
sessionPolicy	SessionPolicy	The session lifetime policy.
tags	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for status tags added to Assets.
updated		by: login, from: monster
userGroups	Array.<UserGroup>	A list of user groups that belong to this company. A user can only belong to groups from their own company.
v	Array.<int32> fixed count: 6	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the general properties
v[1]	int32	The second element is not used (yet)
v[2]	int32	The third element is not used (yet)
v[3]	int32	The fourth element is for the style properties
v[4]	int32	The fifth element is for the policy properties
v[5]	int32	The sixth element is for the reseller properties

JSON structure

{
	"directory": {
		string: [
			number
		]
	},
	"id": number,
	"labels": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"name": string,
	"notes": string,
	"parent": number,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"processedUtc": string,
	"references": {
		string: string
	},
	"reseller": {
		"contactInfo": {
			string: number
		},
		"domain": string,
		"favourite": string,
		"gamut": {
			string: {
				"fill": string,
				"stroke": string
			}
		},
		"graphics": {
			string: string
		},
		"icon": string,
		"id": number,
		"languages": [
			string
		],
		"logo": string,
		"notifyEmail": {
			"incomingAddress": string,
			"incomingLogin": string,
			"incomingMessageNumber": number,
			"incomingPort": number,
			"incomingSecure": boolean,
			"incomingType": string,
			"outgoingAddress": string,
			"outgoingLogin": string,
			"outgoingPort": number,
			"outgoingReplyTo": string,
			"outgoingSecure": boolean,
			"outgoingType": string
		},
		"notifySms": {
			"notifyLimit": number,
			"phoneNumbers": {
				string: [
					number
				]
			}
		},
		"parent": number,
		"processedUtc": string,
		"recoverBody": string,
		"recoverIsHtml": boolean,
		"recoverSubject": string,
		"serviceName": string,
		"termsPreamble": string,
		"termsUpdated": string,
		"updated": {
		},
		"v": [
			number
		],
		"website": {
			string: string
		}
	},
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string
		],
		"maxSessions": number,
		"multiUser": string
	},
	"tags": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"updated": {
	},
	"userGroups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"v": [
		number
	]
}

CompanyDeletedobject

The message format for when a deleted Company is retrieved

JSON description

Property	Type	Value	Description
deleted	boolean	`true`
id	uint64 see: Company.id		Unique identifier of the Company.
name	string maximum-length: 100		The organizational name.
notes	string		Notes.
parent	uint64 see: Company.id		The unique identifier of this company's parent organization.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"parent": number,
	"since": string,
	"v": [
		number
	]
}

CompanyGeneralobject

General details about a company.

JSON description

Property	Type	Description
id	uint64 see: Company.id	Unique identifier of the Company.
name	string maximum-length: 100	The organizational name.
notes	string	Notes.
parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
processedUtc	datetime	When the was change procesed.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"id": number,
	"name": string,
	"notes": string,
	"parent": number,
	"processedUtc": string,
	"references": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

CompanyPoliciesobject

The password and session lifetime policies for this Company.

JSON description

Property	Type	Description
id	uint64 see: Company.id	Unique identifier of the Company.
parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
passwordPolicy	PasswordPolicy	The password complexity and expiry policy.
processedUtc	datetime	When the was change procesed.
sessionPolicy	SessionPolicy	The session lifetime policy.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"id": number,
	"parent": number,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"processedUtc": string,
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string
		],
		"maxSessions": number,
		"multiUser": string
	},
	"updated": {
	},
	"v": [
		number
	]
}

CompanyStylesobject

The colours and styles used by this company to tag and label Assets, Places, and other things.

JSON description

Property	Type	Description
id	uint64 see: Company.id	Unique identifier of the Company.
labels	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for labels added to Assets, Places, and other things.
parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
processedUtc	datetime	When the was change procesed.
tags	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for status tags added to Assets.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"id": number,
	"labels": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"parent": number,
	"processedUtc": string,
	"tags": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"updated": {
	},
	"v": [
		number
	]
}

LabelStyleobject

Visual style identification helper.

JSON description

Property	Type	Description
code	codified	The codified name of this style
fill	colour maximum-length: 22	The background colour given to this style for easy visual identification.
graphic	codified maximum-length: 22	The codified graphic name given to this script for easy visual identification.
name	string maximum-length: 100	The name of this visual style.
notes	string	Notes!
stroke	colour maximum-length: 22	The text/graphic colour given to this style for easy visual identification.

JSON structure

{
	"code": string,
	"fill": string,
	"graphic": string,
	"name": string,
	"notes": string,
	"stroke": string
}

ParamCompanyBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
companies	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"companies": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamCompanyBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
companies	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"companies": [
		{
			"directory": {
				string: [
					number
				]
			},
			"id": number,
			"labels": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"name": string,
			"notes": string,
			"parent": number,
			"passwordPolicy": {
				"expireMode": string,
				"expireThreshold": number,
				"includeLetters": boolean,
				"includeNumbers": boolean,
				"includeSpecial": boolean,
				"includeUpperLower": boolean,
				"minimumLength": number
			},
			"references": {
				string: string
			},
			"sessionPolicy": {
				"applications": [
					string
				],
				"expireTimeout": number,
				"idleAllowed": boolean,
				"ipv4Ranges": [
					string
				],
				"maxSessions": number,
				"multiUser": string
			},
			"tags": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamCompanyDeleteBaseParametersobject

Request description

Property	Type	Required	Description
company	ParamId	always	An object to contain the "id" key.
company.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamCompanyDirectoryListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyDirectoryListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyGeneralListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyGeneralListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyLabelsListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyLabelsListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyMergeBaseParametersobject

Request description

Property	Type	Required	Description
company	Object.<string, ?>	always	A simple object to contain the company parameters.
company.directory	Object.<string, Array.<uint64>> for value-values see: Contact.id	optional	The list of Contacts from this and other companies broken down by contact role.
company.id	uint64?	update	Unique identifier of the Company.
company.labels	Object.<string, LabelStyle>	optional	The styles for labels added to Assets, Places, and other things.
company.name	string maximum-length: 100	create	The organizational name.
company.notes	string	optional	Notes.
company.parent	uint64?	create	The unique identifier of this company's parent organization.
company.passwordPolicy	Object.<string, ?>	always	The password complexity and expiry policy.
company.passwordPolicy.expireMode	PasswordExpiryMode?	optional	Defines how passwords expire.
company.passwordPolicy.expireThreshold	byte?	optional	The threshold for expiry (in days).
company.passwordPolicy.includeLetters	boolean	optional	Do passwords require alphabetical characters.
company.passwordPolicy.includeNumbers	boolean	optional	Do passwords require numeric characters.
company.passwordPolicy.includeSpecial	boolean	optional	Do passwords require non-alphanumeric characters.
company.passwordPolicy.includeUpperLower	boolean	optional	Do passwords require upper-case and lower-case letters.
company.passwordPolicy.minimumLength	byte?	optional	The minimum number of characters required.
company.references	Object.<string, string>	optional	Name/value collections of custom fields used to refer to external systems. If the value is null, the references are removed from the Company.
company.sessionPolicy	Object.<string, ?>	always	The session lifetime policy.
company.sessionPolicy.applications	Array.<string>	optional	The list of applications users are allowed to use to create sessions.
company.sessionPolicy.expireTimeout	uint16?	optional	The lifetime duration of a session in minutes.
company.sessionPolicy.idleAllowed	boolean	optional	Defines whether a session should be automatically killed when the connection breaks.
company.sessionPolicy.ipv4Ranges	Array.<ipv4> maximum-length of values: 19	optional	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
company.sessionPolicy.maxSessions	byte?	optional	The maximum number of sessions allowed per user.
company.sessionPolicy.multiUser	SessionMultiUser?	optional	Defines the behaviour of the system when a user creates multiple sessions.
company.tags	Object.<string, LabelStyle>	optional	The styles for status tags added to Assets.
company.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"directory": {
			string: [
				number
			]
		},
		"id": number,
		"labels": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"name": string,
		"notes": string,
		"parent": number,
		"passwordPolicy": {
			"expireMode": string,
			"expireThreshold": number,
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number
		},
		"references": {
			string: string
		},
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string
			],
			"maxSessions": number,
			"multiUser": string
		},
		"tags": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"v": [
			number
		]
	},
	"reqId": number
}

ParamCompanyPoliciesListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyPoliciesListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyRestoreBaseParametersobject

Request description

Property	Type	Required	Description
company	ParamId	always	An object to contain the "id" key.
company.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamPasswordPolicyobject

Parameter values for creating a new or updating an existing PasswordPolicy.

JSON description

Property	Type	Description
expireMode	PasswordExpiryMode?	Defines how passwords expire.
expireThreshold	byte?	The threshold for expiry (in days).
includeLetters	boolean	Do passwords require alphabetical characters.
includeNumbers	boolean	Do passwords require numeric characters.
includeSpecial	boolean	Do passwords require non-alphanumeric characters.
includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
minimumLength	byte?	The minimum number of characters required.

JSON structure

{
	"expireMode": string,
	"expireThreshold": number,
	"includeLetters": boolean,
	"includeNumbers": boolean,
	"includeSpecial": boolean,
	"includeUpperLower": boolean,
	"minimumLength": number
}

ParamSessionPolicyobject

Parameter values for creating a new or updating an existing SessionPolicy.

JSON description

Property	Type	Description
applications	Array.<string>	The list of applications users are allowed to use to create sessions.
expireTimeout	uint16?	The lifetime duration of a session in minutes.
idleAllowed	boolean	Defines whether a session should be automatically killed when the connection breaks.
ipv4Ranges	Array.<ipv4> maximum-length of values: 19	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
maxSessions	byte?	The maximum number of sessions allowed per user.
multiUser	SessionMultiUser?	Defines the behaviour of the system when a user creates multiple sessions.

JSON structure

{
	"applications": [
		string
	],
	"expireTimeout": number,
	"idleAllowed": boolean,
	"ipv4Ranges": [
		string
	],
	"maxSessions": number,
	"multiUser": string
}

PasswordExpiryModestring

Defines how User passwords expire.

Value	Description
days	Passwords expire after a defined number of days.
never	Passwords never expire.
sessions	Passwords expire after a defined number of successful logins.

PasswordPolicyobject

The password complexity and expiry policy.

JSON description

Property	Type	Description
expireMode	PasswordExpiryMode	Defines how passwords expire.
expireThreshold	byte	The threshold for expiry.
includeLetters	boolean	Do passwords require alphabetical characters.
includeNumbers	boolean	Do passwords require numeric characters.
includeSpecial	boolean	Do passwords require non-alphanumeric characters.
includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
minimumLength	byte	The minimum number of characters required.

JSON structure

{
	"expireMode": string,
	"expireThreshold": number,
	"includeLetters": boolean,
	"includeNumbers": boolean,
	"includeSpecial": boolean,
	"includeUpperLower": boolean,
	"minimumLength": number
}

RespCompanyBatchDeleteBaseResponseobject

Response description

Property	Type	Description
companies	Array.<RespParentDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companies": [
		{
			"deleted": boolean,
			"id": number,
			"parent": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyBatchMergeBaseResponseobject

Response description

Property	Type	Description
companies	Array.<RespIdParent>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companies": [
		{
			"id": number,
			"parent": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyDeleteBaseResponseobject

Response description

Property	Type	Description
company	RespParentDeleted	An object which contains the Company's unique identifier and deleted status.
company.deleted	boolean	Flag showing if the object is deleted.
company.id	uint64?	Identifier given as input for the command.
company.parent	uint64	Identifier of the parent to which the Company is a child.
company.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"deleted": boolean,
		"id": number,
		"parent": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyDirectoryListByParentBaseResponseobject

Response description

Property	Type	Description
companyDirectories	Array.<>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyDirectories": [
		{
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyDirectoryListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companyDirectories	Array.<>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyDirectories": [
		{
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyGeneralListByParentBaseResponseobject

Response description

Property	Type	Description
companyGenerals	Array.<CompanyGeneral>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyGenerals": [
		{
			"id": number,
			"name": string,
			"notes": string,
			"parent": number,
			"processedUtc": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyGeneralListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companyGenerals	Array.<CompanyGeneral>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyGenerals": [
		{
			"id": number,
			"name": string,
			"notes": string,
			"parent": number,
			"processedUtc": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyGetBaseResponseobject

Response description

Property	Type	Description
company	Company	The requested Company.
company.directory	Object.<string, Array.<uint64>> for value-values see: Contact.id	The list of Contacts from this and other companies broken down by contact role.
company.id	uint64	Unique identifier of the Company.
company.labels	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for labels added to Assets, Places, and other things.
company.name	string maximum-length: 100	The organizational name.
company.notes	string	Notes.
company.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
company.passwordPolicy	PasswordPolicy	The password complexity and expiry policy.
company.passwordPolicy.expireMode	PasswordExpiryMode	Defines how passwords expire.
company.passwordPolicy.expireThreshold	byte	The threshold for expiry.
company.passwordPolicy.includeLetters	boolean	Do passwords require alphabetical characters.
company.passwordPolicy.includeNumbers	boolean	Do passwords require numeric characters.
company.passwordPolicy.includeSpecial	boolean	Do passwords require non-alphanumeric characters.
company.passwordPolicy.includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
company.passwordPolicy.minimumLength	byte	The minimum number of characters required.
company.processedUtc	datetime	When the was change procesed.
company.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
company.reseller	CompanyReseller	If this company is a reseller, then they have their own theme, support and billing information.
company.reseller.contactInfo	Object.<string, uint64> see: Contact.id maximum-count of keys: 100 for values see: Contact.id	A list of Contacts for company specific things like Technical Support, Billing, etc...
company.reseller.domain	string maximum-length: 100	The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
company.reseller.favourite	string maximum-length: 200	The name of the icon file used for browser bookmarks.
company.reseller.gamut	Object.<string, ColourStyle> maximum-length of keys: 25	Colours used as templates for status tags, labels, and places.
company.reseller.graphics	Object.<string, codified> maximum-length of keys: 25 maximum-length of values: 30	A list of symbol names and their corresponding FontAwesome icon names.
company.reseller.icon	string maximum-length: 200	The name of the image uploaded as the logo (used for collapsed/mobile view).
company.reseller.id	uint64 see: Company.id	Unique identifier of the Company.
company.reseller.languages	Array.<codified> maximum-length of values: 5	A list of supported languages for your customers.
company.reseller.logo	string maximum-length: 200	The name of the image uploaded as the logo (used for regular view).
company.reseller.notifyEmail	NotificationServerEmail	The server used for notification and conversational email messages sent and received by the system.
company.reseller.notifyEmail.incomingAddress	string	The domain or IP address of the incoming email server.
company.reseller.notifyEmail.incomingLogin	string	The username used to login to the incoming email server.
company.reseller.notifyEmail.incomingMessageNumber	uint32	IMAP message sequence number so only recent messages are retrieved.
company.reseller.notifyEmail.incomingPort	uint16	The port number of the incoming email server.
company.reseller.notifyEmail.incomingSecure	boolean	Is the incoming email server using a secure SSL/TLS connection (it should).
company.reseller.notifyEmail.incomingType	string	The type of incoming protocol to use (IMAP or POP3).
company.reseller.notifyEmail.outgoingAddress	string	The domain or IP address of the outgoing email server.
company.reseller.notifyEmail.outgoingLogin	string	The username used to login to the outgoing email server.
company.reseller.notifyEmail.outgoingPort	uint16	The port number of the outgoing email server.
company.reseller.notifyEmail.outgoingReplyTo	email	An optional field which can be set as the "sent from" and/or "reply-to" address.
company.reseller.notifyEmail.outgoingSecure	boolean	Is the outgoing email server using a secure SSL/TLS connection (it should).
company.reseller.notifyEmail.outgoingType	string	The type of outgoing protocol to use (only SMTP).
company.reseller.notifySms	NotificationServerSms	Definition for load-balanced outbound SMS numbers for the reseller.
company.reseller.notifySms.notifyLimit	uint16	A per-number/per-day limit on the amount of Notifications sent.
company.reseller.notifySms.phoneNumbers	Object.<string, Array.<phone>> fixed length of keys: 2	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
company.reseller.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
company.reseller.processedUtc	datetime	When the was change procesed.
company.reseller.recoverBody	string	The body of the email sent to a user requesting a password reset.
company.reseller.recoverIsHtml	boolean
company.reseller.recoverSubject	string	The subject of the email sent to a user requesting a password reset.
company.reseller.serviceName	string maximum-length: 150	The name of the branded service being provided to the seller's customers.
company.reseller.termsPreamble	string	A preamble to the general terms and conditions offered by Fleet Freedom.
company.reseller.termsUpdated	datetime	The date and time when the terms were updated. This will promt users who are logging-in to re-agree to the new terms
company.reseller.updated		by: login, from: monster
company.reseller.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
company.reseller.website	Object.<string, colour> maximum-length of keys: 25 maximum-length of values: 22	Themed colours used in the web-based UI.
company.sessionPolicy	SessionPolicy	The session lifetime policy.
company.sessionPolicy.applications	Array.<string>	The list of applications users are allowed to use to create sessions.
company.sessionPolicy.expireTimeout	uint16	The lifetime duration of a session in minutes.
company.sessionPolicy.idleAllowed	boolean	Defines whether a session should be automatically killed when the connection breaks.
company.sessionPolicy.ipv4Ranges	Array.<ipv4> maximum-length of values: 19	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
company.sessionPolicy.maxSessions	byte	The maximum number of sessions allowed per user.
company.sessionPolicy.multiUser	SessionMultiUser	Defines the behaviour of the system when a user creates multiple sessions.
company.tags	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for status tags added to Assets.
company.updated		by: login, from: monster
company.userGroups	Array.<UserGroup>	A list of user groups that belong to this company. A user can only belong to groups from their own company.
company.v	Array.<int32> fixed count: 6	Object version keys used to validate synchronization for all object properties.
company.v[0]	int32	The first element is for the general properties
company.v[1]	int32	The second element is not used (yet)
company.v[2]	int32	The third element is not used (yet)
company.v[3]	int32	The fourth element is for the style properties
company.v[4]	int32	The fifth element is for the policy properties
company.v[5]	int32	The sixth element is for the reseller properties
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"directory": {
			string: [
				number
			]
		},
		"id": number,
		"labels": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"name": string,
		"notes": string,
		"parent": number,
		"passwordPolicy": {
			"expireMode": string,
			"expireThreshold": number,
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number
		},
		"processedUtc": string,
		"references": {
			string: string
		},
		"reseller": {
			"contactInfo": {
				string: number
			},
			"domain": string,
			"favourite": string,
			"gamut": {
				string: {
					"fill": string,
					"stroke": string
				}
			},
			"graphics": {
				string: string
			},
			"icon": string,
			"id": number,
			"languages": [
				string
			],
			"logo": string,
			"notifyEmail": {
				"incomingAddress": string,
				"incomingLogin": string,
				"incomingMessageNumber": number,
				"incomingPort": number,
				"incomingSecure": boolean,
				"incomingType": string,
				"outgoingAddress": string,
				"outgoingLogin": string,
				"outgoingPort": number,
				"outgoingReplyTo": string,
				"outgoingSecure": boolean,
				"outgoingType": string
			},
			"notifySms": {
				"notifyLimit": number,
				"phoneNumbers": {
					string: [
						number
					]
				}
			},
			"parent": number,
			"processedUtc": string,
			"recoverBody": string,
			"recoverIsHtml": boolean,
			"recoverSubject": string,
			"serviceName": string,
			"termsPreamble": string,
			"termsUpdated": string,
			"updated": {
			},
			"v": [
				number
			],
			"website": {
				string: string
			}
		},
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string
			],
			"maxSessions": number,
			"multiUser": string
		},
		"tags": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"updated": {
		},
		"userGroups": [
			{
				"company": number,
				"id": number,
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,
						"kind": string,
						"labels": [
							string
						],
						"level": string,
						"method": string,
						"type": string
					}
				],
				"processedUtc": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyLabelsListByParentBaseResponseobject

Response description

Property	Type	Description
companyLabels	Array.<CompanyStyles>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyLabels": [
		{
			"id": number,
			"labels": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"parent": number,
			"processedUtc": string,
			"tags": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyLabelsListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companyLabels	Array.<CompanyStyles>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyLabels": [
		{
			"id": number,
			"labels": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"parent": number,
			"processedUtc": string,
			"tags": {
				string: {
					"code": string,
					"fill": string,
					"graphic": string,
					"name": string,
					"notes": string,
					"stroke": string
				}
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyListByParentBaseResponseobject

Response description

Property	Type	Description
companies	Array.<CompanyGeneral>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companies": [
		{
			"id": number,
			"name": string,
			"notes": string,
			"parent": number,
			"processedUtc": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companies	Array.<CompanyGeneral>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companies": [
		{
			"id": number,
			"name": string,
			"notes": string,
			"parent": number,
			"processedUtc": string,
			"references": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyMergeBaseResponseobject

Response description

Property	Type	Description
company	RespIdParent	An object which contains the "id" and "parent" keys.
company.id	uint64?	Identifier given as input for the command.
company.parent	uint64?	Identifier of the parent to which this company belongs
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number,
		"parent": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyPoliciesListByParentBaseResponseobject

Response description

Property	Type	Description
companyPolicies	Array.<CompanyPolicies>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyPolicies": [
		{
			"id": number,
			"parent": number,
			"passwordPolicy": {
				"expireMode": string,
				"expireThreshold": number,
				"includeLetters": boolean,
				"includeNumbers": boolean,
				"includeSpecial": boolean,
				"includeUpperLower": boolean,
				"minimumLength": number
			},
			"processedUtc": string,
			"sessionPolicy": {
				"applications": [
					string
				],
				"expireTimeout": number,
				"idleAllowed": boolean,
				"ipv4Ranges": [
					string
				],
				"maxSessions": number,
				"multiUser": string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyPoliciesListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companyPolicies	Array.<CompanyPolicies>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyPolicies": [
		{
			"id": number,
			"parent": number,
			"passwordPolicy": {
				"expireMode": string,
				"expireThreshold": number,
				"includeLetters": boolean,
				"includeNumbers": boolean,
				"includeSpecial": boolean,
				"includeUpperLower": boolean,
				"minimumLength": number
			},
			"processedUtc": string,
			"sessionPolicy": {
				"applications": [
					string
				],
				"expireTimeout": number,
				"idleAllowed": boolean,
				"ipv4Ranges": [
					string
				],
				"maxSessions": number,
				"multiUser": string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyRestoreBaseResponseobject

Response description

Property	Type	Description
company	RespParentDeleted	An object which contains the Company's unique identifier and deleted status.
company.deleted	boolean	Flag showing if the object is deleted.
company.id	uint64?	Identifier given as input for the command.
company.parent	uint64	Identifier of the parent to which the Company is a child.
company.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"deleted": boolean,
		"id": number,
		"parent": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

SessionMultiUserstring

Defines the behaviour of the system when a user creates multiple sessions.

Value	Description
allow	Allow users to create multiple simultaneous sessions.
deny	Deny users from creating new sessions if they already have an active session.
replace	Allow users to create a new session, but automatically kill the previous session.

SessionPolicyobject

The session lifetime policy.

JSON description

Property	Type	Description
applications	Array.<string>	The list of applications users are allowed to use to create sessions.
expireTimeout	uint16	The lifetime duration of a session in minutes.
idleAllowed	boolean	Defines whether a session should be automatically killed when the connection breaks.
ipv4Ranges	Array.<ipv4> maximum-length of values: 19	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
maxSessions	byte	The maximum number of sessions allowed per user.
multiUser	SessionMultiUser	Defines the behaviour of the system when a user creates multiple sessions.

JSON structure

{
	"applications": [
		string
	],
	"expireTimeout": number,
	"idleAllowed": boolean,
	"ipv4Ranges": [
		string
	],
	"maxSessions": number,
	"multiUser": string
}

Dispatch

AssetDispatchobject

The current state of an asset's DispatchJob route progress.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this asset belongs.
directions	Array.<DispatchDirection>	Driving directions and route path details.
id	uint64 see: Asset.id	Unique identifier of this asset.
jobs	Array.<uint64> see: DispatchJob	The current list of DispatchJobs assigned to the asset.
lastDispatched	datetime	Timestamp from the last update to this AssetDispatch by a User, Machine, Asset, or an assigned DispatchJob.
processedUtc	datetime	When the was change procesed.
tasks Deprecated	Array.<DispatchTask>	The current list of tasks assigned to this asset.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"directions": [
		{
			"directions": [
				{ /* recursive DispatchDirection objects */ }
			],
			"distance": number,
			"duration": string,
			"instructions": string,
			"job": number,
			"path": string,
			"step": number
		}
	],
	"id": number,
	"jobs": [
		number
	],
	"lastDispatched": string,
	"processedUtc": string,
	"tasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"updated": {
	},
	"v": [
		number
	]
}

DispatchDirectionobject

Driving directions and details like duration and distance.

JSON description

Property	Type	Description
directions	Array.<DispatchDirection>	For complex routes, the sub-directions provide a breakdown or additional details.
distance	double?	The total distance of these directions (including sub-directions if applicable).
duration	timespan	The total duration of these directions (including sub-directions if applicable).
instructions	string	Text hint for the driver for the action to perform.
job	uint64?	Unique identifier of the DispatchJob or DispatchTask.
path	polyline	A route path to display on a map.
step	uint64?	The DispatchStep.id, if this direction is for DispatchJobs.

JSON structure

{
	"directions": [
		{ /* recursive DispatchDirection objects */ }
	],
	"distance": number,
	"duration": string,
	"instructions": string,
	"job": number,
	"path": string,
	"step": number
}

DispatchJobobject

Some work that needs to be done by performing one or more DispatchSteps.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The Asset to which this job belongs. This value is null when unassigned.
attachments	Array.<uint64> maximum-count: 10 for values see: Document.id	A list of hosted Document identifiers attached to this job.
company	uint64 see: Company.id	The company to which this job belongs.
created	datetime	When this job was originally created.
driver	string	Clocked-in driver name who made the update. Null if not clocked-in, or no changes have been made.
forms	Array.<uint64> maximum-count: 10 for values see: FormResult.id	A list of hosted FormResult identifiers attached to this job.
id	uint64	Unique identifier of this job.
instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them complete the job.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate (unassigned) jobs to Assets.
name	string maximum-length: 100	A name for the work needed to be performed.
priority	DispatchJobPriority	The importance of this job when scheduling for an asset.
processedUtc	datetime	When the was change procesed.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
steps	Array.<DispatchStep>	A list of coordinates to visit in order to carry out the work for this job.
tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names reflecting the conditions of this job.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"attachments": [
		number
	],
	"company": number,
	"created": string,
	"driver": string,
	"forms": [
		number
	],
	"id": number,
	"instructions": string,
	"labels": [
		string
	],
	"name": string,
	"priority": string,
	"processedUtc": string,
	"references": {
		string: string
	},
	"steps": [
		{
			"address": string,
			"duration": string,
			"eta": string,
			"id": number,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"signatory": string,
			"signature": boolean,
			"states": {
				string: {
					"latlng": {
						"lat": number,
						"lng": number
					},
					"updated": string
				}
			}
		}
	],
	"tags": [
		string
	],
	"updated": {
	},
	"v": [
		number
	]
}

DispatchJobDeletedobject

The message format for when a deleted DispatchJob is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this job belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this job.
instructions	string		Instructions (filled out by dispatcher) for the field-employee to help them complete the job.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names used to relate (unassigned) jobs to Assets.
name	string maximum-length: 100		A name for the work needed to be performed.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"instructions": string,
	"labels": [
		string
	],
	"name": string,
	"since": string,
	"v": [
		number
	]
}

DispatchJobPrioritystring

A value assigned to DispatchJobs in order to weigh them when optimizing a route.

Value	Description
high	More important job that will be routed to first unless the next high importance job is much farther away.
low	Low priority jobs are assigned towards the end of a dispatch, unless they are in very close proximity to another job.
medium	A normal job that will be done at the first opportunity.
standby	Will be done last, after all others, if at all.
urgent	Must be done first, before all others.

DispatchStepobject

A portion of work for a DispatchJob.

JSON description

Property	Type	Description
address	string maximum-length: 500	The street address of where the step must be completed.
duration	timespan	The optional expected duration of the work for this step.
eta	datetime	The optional estimated time of arrival for the asset.
id	uint64	Identifier for this DispatchStep. This value is unique per DispatchJob, but is not unique system-wide.
latlng	LatLng	The lat/long coordinates of where the step must be DispatchStepStatus.completed.
name	string maximum-length: 100	A name for the work needed to be performed.
notes	string	Notes about the status of the work filled in by field-employee.
place	uint64? see: Place.id	An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
signatory	string maximum-length: 100	The name of the person who signed the step's completion.
signature	boolean	Indicates whether this step requires a signature.
states	Object.<DispatchStepStatus, DispatchStepState>	The progress of this step.

JSON structure

{
	"address": string,
	"duration": string,
	"eta": string,
	"id": number,
	"latlng": {
		"lat": number,
		"lng": number
	},
	"name": string,
	"notes": string,
	"place": number,
	"signatory": string,
	"signature": boolean,
	"states": {
		string: {
			"latlng": {
				"lat": number,
				"lng": number
			},
			"updated": string
		}
	}
}

DispatchStepStateobject

Details about the lifetime of a DispatchStep.

JSON description

Property	Type	Description
latlng	LatLng	The coordinates from the Asset when the update happened.
updated	datetime	A timestamp from when the lifetime was updated.

JSON structure

{
	"latlng": {
		"lat": number,
		"lng": number
	},
	"updated": string
}

DispatchStepStatusstring

The lifetime of all DispatchSteps (in order).

Value	Description
arrived	The asset has arrived at the DispatchStep's location.
completed	The DispatchStep is done (or the asset has departed the location).
onRoute	The asset is on the way to the DispatchStep's location next.
pending	The DispatchStep has not yet been started.

DispatchTaskobject Deprecated: Use DispatchJob instead.

A task assigned to an asset which represents a coordinate on the map which must be visited.

JSON description

Property	Type	Description
address	string maximum-length: 500	The street address of where the task must be completed.
arrived	datetime	The date/time stamp of when the asset arrived at this task.
asset	uint64 see: Asset.id	The asset to which this task belongs.
attachments	Array.<uint64> maximum-count: 10 for values see: Document.id	A list of hosted Document identifiers attached to this task.
company	uint64 see: Company.id	The company to which this task belongs.
completed	datetime	The date/time stamp of when this task was completed.
created	datetime	When this task was created.
duration	timespan	The optional expected duration of the work for this task.
eta	datetime	The optional estimated time of arrival for the asset.
id	uint64	Unique identifier of this task.
instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them completed the task.
latlng	LatLng	The lat/long coordinates of where the task must be completed.
name	string maximum-length: 100	The name of this task or the work needed to be performed.
notes	string	Notes about the status of the work filled in by field-employee.
place	uint64? see: Place.id	An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
processedUtc	datetime	When the was change procesed.
reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Examples are a work order, pick-up, waybill, etc... Use dispatchTask.references[DispatchTask.REFERENCE] instead.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
signatory	string maximum-length: 100	The name of the person who signed the task's completion.
signature	boolean	Indicates whether the task has a signature.
status Deprecated	TaskStatus	The progress of this task. Use DispatchStepStatus instead.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"address": string,
	"arrived": string,
	"asset": number,
	"attachments": [
		number
	],
	"company": number,
	"completed": string,
	"created": string,
	"duration": string,
	"eta": string,
	"id": number,
	"instructions": string,
	"latlng": {
		"lat": number,
		"lng": number
	},
	"name": string,
	"notes": string,
	"place": number,
	"processedUtc": string,
	"reference": string,
	"references": {
		string: string
	},
	"signatory": string,
	"signature": boolean,
	"status": string,
	"updated": {
	},
	"v": [
		number
	]
}

DispatchTaskDeletedobject Deprecated: Use DispatchJob instead.

The message format for when a deleted DispatchTask is retrieved

JSON description

Property	Type	Value	Description
asset	uint64 see: Asset.id		The asset to which this task belongs.
company	uint64 see: Company.id		The company to which this task belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this task.
instructions	string		Instructions (filled out by dispatcher) for the field-employee to help them completed the task.
name	string maximum-length: 100		The name of this task or the work needed to be performed.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"instructions": string,
	"name": string,
	"since": string,
	"v": [
		number
	]
}

DispatchTemplateobject

A pre-built set of jobs and steps to quickly dispatch for an Asset.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The Asset to which the created DispatchJobs would be assigned.
company	uint64 see: Company.id	The company to which this template belongs.
directions	Array.<DispatchDirection>	Driving directions and route path details.
id	uint64	Unique identifier of this template.
jobs	Array.<DispatchTemplateJob>	The list of jobs to create when deploying this template.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to target applicable Assets for this dispatch.
name	string maximum-length: 100	The name of this template.
notes	string	Notes about this template.
processedUtc	datetime	When the was change procesed.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"directions": [
		{
			"directions": [
				{ /* recursive DispatchDirection objects */ }
			],
			"distance": number,
			"duration": string,
			"instructions": string,
			"job": number,
			"path": string,
			"step": number
		}
	],
	"id": number,
	"jobs": [
		{
			"attachments": [
				number
			],
			"forms": [
				number
			],
			"instructions": string,
			"name": string,
			"priority": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			]
		}
	],
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"processedUtc": string,
	"references": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

DispatchTemplateDeletedobject

The message format for when a deleted DispatchTemplate is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this template belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this template.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names used to target applicable Assets for this dispatch.
name	string maximum-length: 100		The name of this template.
notes	string		Notes about this template.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

DispatchTemplateJobobject

A reusable template of work that needs to be done by performing one or more DispatchSteps.

JSON description

Property	Type	Description
attachments	Array.<uint64> maximum-count: 10 for values see: Document.id	A list of hosted Document identifiers attached to this template.
forms	Array.<uint64> maximum-count: 10 for values see: FormResult.id	A list of hosted FormResult identifiers attached to this template.
instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them completed the job.
name	string maximum-length: 100	The name of this template or the work needed to be performed.
priority	DispatchJobPriority	The importance of this job when scheduling for an asset.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
steps	Array.<DispatchStep>	A list of coordinates to visit in order to carry out the work for the created DispatchJob.

JSON structure

{
	"attachments": [
		number
	],
	"forms": [
		number
	],
	"instructions": string,
	"name": string,
	"priority": string,
	"references": {
		string: string
	},
	"steps": [
		{
			"address": string,
			"duration": string,
			"eta": string,
			"id": number,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"signatory": string,
			"signature": boolean,
			"states": {
				string: {
					"latlng": {
						"lat": number,
						"lng": number
					},
					"updated": string
				}
			}
		}
	]
}

ParamAssetDispatchBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
assetDispatches	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetDispatches": [
		{
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"optimize": boolean,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamAssetDispatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
assetDispatch	Object.<string, ?>	always	A simple object to contain the AssetDispatch parameters.
assetDispatch.directions	Array.<DispatchDirection>	optional	Driving directions and route path details.
assetDispatch.id	uint64	always	The unique identifier of the asset you want to update.
assetDispatch.jobs	Array.<uint64> see: DispatchJob	optional	The list of DispatchJobs to be assigned to this asset.
assetDispatch.optimize	boolean	optional	Indicates whether the jobs should be optimized based on distance and priority.
assetDispatch.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetDispatch": {
		"directions": [
			{
				"directions": [
					{ /* recursive DispatchDirection objects */ }
				],
				"distance": number,
				"duration": string,
				"instructions": string,
				"job": number,
				"path": string,
				"step": number
			}
		],
		"id": number,
		"jobs": [
			number
		],
		"optimize": boolean,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamDispatchJobBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
dispatchJobs	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJobs": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamDispatchJobBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
dispatchJobs	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"place": number,
					"signature": boolean
				}
			],
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamDispatchJobDeleteBaseParametersobject

Request description

Property	Type	Required	Description
dispatchJob	ParamId	always	Identifier object to contain the DispatchJob's identifier.
dispatchJob.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJob": {
		"id": number
	},
	"reqId": number
}

ParamDispatchJobGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
dispatchJob	ParamId	always		Identifier object to contain the DispatchJob's identifier.
dispatchJob.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted DispatchTask.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJob": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamDispatchJobListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamDispatchJobListByAssetAndRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: DispatchJob.references	optional		Case-insensitive reference pairs used to match jobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDispatchJobListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamDispatchJobListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: DispatchJob.labels	optional		A list of label codes used to match DispatchJobs. All labels must match to include a DispatchJob in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ParamDispatchJobListByCompanyAndRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: DispatchJob.references	optional		Case-insensitive reference pairs used to match jobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDispatchJobListByCompanyNoAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamDispatchJobListByCompanyNoAssetAndRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: DispatchJob.references	optional		Case-insensitive reference pairs used to match jobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDispatchJobMergeBaseParametersobject

Request description

Property	Type	Required	Description
dispatchJob	Object.<string, ?>	always	The details of a DispatchJob either for creation or update.
dispatchJob.asset	uint64?	optional	The identifier of the Asset assigned to this DispatchJob.
dispatchJob.attachments	Array.<uint64> for values see: Document.id	optional	A list of Document identifiers to attach to this DispatchJob for both driver and dispatcher review.
dispatchJob.company	uint64?	create	The identifier of the Company to which this DispatchJob belongs. After creation, this value is read-only.
dispatchJob.forms	Array.<uint64> for values see: FormResult.id	optional	A list of FormResult identifiers to attach to this DispatchJob.
dispatchJob.id	uint64?	update	The unique identifier of the DispatchJob you want to update.
dispatchJob.instructions	string	optional	Instructions for the driver to help them complete the DispatchJob. Such as which door to use, a buzz code to enter the facility, etc...
dispatchJob.labels	Array.<codified> for values see: LabelStyle.code	optional	A list of codified label names used to relate (unassigned) DispatchJobs to Assets.
dispatchJob.name	string maximum-length: 100	create	Name for the DispatchJob.
dispatchJob.priority	DispatchJobPriority?	optional	The importance of this job when scheduling for an asset.
dispatchJob.references	Object.<string, string>	optional	A custom field used to refer this DispatchJob an external system. Examples are a work order, pick-up, waybill, etc... If value is null, the field is removed from the DispatchJob. If a new value or null is not provided for a current attribute, no change is made.
dispatchJob.steps	Array.<ParamDispatchStep>	create	A list of coordinates to visit in order to carry out the work for this job.
dispatchJob.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJob": {
		"asset": number,
		"attachments": [
			number
		],
		"company": number,
		"forms": [
			number
		],
		"id": number,
		"instructions": string,
		"labels": [
			string
		],
		"name": string,
		"priority": string,
		"references": {
			string: string
		},
		"steps": [
			{
				"address": string,
				"duration": string,
				"eta": string,
				"id": number,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"place": number,
				"signature": boolean
			}
		],
		"v": [
			number
		]
	},
	"reqId": number
}

ParamDispatchJobRestoreBaseParametersobject

Request description

Property	Type	Required	Description
dispatchJob	ParamId	always	Identifier object to contain the DispatchJob's identifier.
dispatchJob.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchJob": {
		"id": number
	},
	"reqId": number
}

ParamDispatchStepobject

Parameter values for updating the DispatchStep for a DispatchJob.

JSON description

Property	Type	Description
address	string	The street address of where the step must be completed.
duration	timespan	The optional expected duration of the work for this step.
eta	datetime	The optional estimated time of arrival for the asset.
id	uint64?	The identifier of the step. Identifiers are unique to a DispatchJob, but are not unique system-wide.
latlng	LatLng	The lat/long coordinates of where the step must be DispatchStepStatus.completed.
latlng.lat	double	Latitude
latlng.lng	double	Longitude
name	string	A name for the work needed to be performed.
place	uint64? see: Place.id	An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
signature	boolean	When true, will mean a signature is required to complete this DispatchStep.

JSON structure

{
	"address": string,
	"duration": string,
	"eta": string,
	"id": number,
	"latlng": {
		"lat": number,
		"lng": number
	},
	"name": string,
	"place": number,
	"signature": boolean
}

ParamDispatchTaskBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
dispatchTasks	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTasks": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamDispatchTaskBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
dispatchTasks	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTasks": [
		{
			"address": string,
			"asset": number,
			"attachments": [
				number
			],
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"references": {
				string: string
			},
			"status": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamDispatchTaskDeleteBaseParametersobject

Request description

Property	Type	Required	Description
dispatchTask	ParamId	always	Identifier object to contain the DispatchTask's identifier.
dispatchTask.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTask": {
		"id": number
	},
	"reqId": number
}

ParamDispatchTaskGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
dispatchTask	ParamId	always		Identifier object to contain the DispatchTask's identifier.
dispatchTask.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted DispatchTask.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTask": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamDispatchTaskListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamDispatchTaskListByAssetAndRefBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reference	string	optional		The "Reference" field value to match.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reference": string,
	"reqId": number
}

ParamDispatchTaskListByAssetAndRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: DispatchTask.references	optional		Case-insensitive reference pairs used to match tasks.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDispatchTaskListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamDispatchTaskListByCompanyAndRefBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reference	string	optional		The "Reference" field value to match.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reference": string,
	"reqId": number
}

ParamDispatchTaskListByCompanyAndRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
references	Object.<string, string> see: DispatchTask.references	optional		Case-insensitive reference pairs used to match tasks.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDispatchTaskMergeBaseParametersobject

Request description

Property	Type	Required	Description
dispatchTask	Object.<string, ?>	always	The details of a DispatchTask either for creation or update.
dispatchTask.address	string	create (conditional)	The street address of this DispatchTask. Condition: You must provide a `place`, a `latlng`, or an `address`. Note: If you ommit the `address`, the geocoder attempts to populate the field, but will not return an error if it fails.
dispatchTask.asset	uint64?	create	The identifier of the Asset assigned to this DispatchTask.
dispatchTask.attachments	Array.<uint64> for values see: Document.id	optional	A list of Document identifiers to attach to this DispatchTask for both driver and dispatcher review.
dispatchTask.duration	timespan	optional	The duration on site, or how much time is expected to complete the DispatchTask. Used to help calculate other DispatchTask ETAs when routing is performed.
dispatchTask.eta	datetime	optional	Estimated time of arrival.
dispatchTask.id	uint64?	update	The unique identifier of the DispatchTask you want to update.
dispatchTask.instructions	string	optional	Instructions for the driver to help them complete the DispatchTask. Such as which door to use, a buzz code to enter the facility, etc...
dispatchTask.latlng	LatLng	create (conditional)	The lat/long coordinates of the street address. Condition: You must provide a `place`, a `latlng`, or an `address`. Note: If you invoke the geocoder, the `address` is also replaced with the geocoded value.
dispatchTask.latlng.lat	double	optional	Latitude
dispatchTask.latlng.lng	double	optional	Longitude
dispatchTask.name	string maximum-length: 100	create	Name for the DispatchTask.
dispatchTask.notes	string	optional	Notes completed by the driver about the DispatchTask. Such as service notes, damaged goods upon pick-up, etc...
dispatchTask.place	uint64?	create (conditional)	An optional identifier of a Place for this DispatchTask. Using a Place makes detecting the "arrived" status more reliable. Condition: You must provide a `place`, a `latlng`, or an `address`. Note: If you invoke the geocoder, the `address` is also replaced with the geocoded value.
dispatchTask.references	Object.<string, string>	optional	A custom field used to refer this DispatchTask an external system. Examples are a work order, pick-up, waybill, etc... If value is null, the field is removed from the DispatchTask. If a new value or null is not provided for a current attribute, no change is made.
dispatchTask.status	TaskStatus?	optional	DispatchTasks have a lifetime and each status represents a DispatchTask's progress through it's life.
dispatchTask.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTask": {
		"address": string,
		"asset": number,
		"attachments": [
			number
		],
		"duration": string,
		"eta": string,
		"id": number,
		"instructions": string,
		"latlng": {
			"lat": number,
			"lng": number
		},
		"name": string,
		"notes": string,
		"place": number,
		"references": {
			string: string
		},
		"status": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamDispatchTaskRestoreBaseParametersobject

Request description

Property	Type	Required	Description
dispatchTask	ParamId	always	Identifier object to contain the DispatchTask's identifier.
dispatchTask.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dispatchTask": {
		"id": number
	},
	"reqId": number
}

RespAssetDispatchBatchMergeBaseResponseobject

Response description

Property	Type	Description
assetDispatches	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatches": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetDispatchMergeBaseResponseobject

Response description

Property	Type	Description
assetDispatch	RespIdCompany	An object which contains the "id" and "company" keys.
assetDispatch.company	uint64	Identifier of the Company to which this object belongs.
assetDispatch.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetDispatch": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobBatchDeleteBaseResponseobject

Response description

Property	Type	Description
dispatchJobs	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJobs": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobBatchMergeBaseResponseobject

Response description

Property	Type	Description
dispatchJobs	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJobs": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobDeleteBaseResponseobject

Response description

Property	Type	Description
dispatchJob	RespDeleted	The id, owning Asset id, owning Company id, and deleted state.
dispatchJob.company	uint64	Identifier of the Company to which this object belongs.
dispatchJob.deleted	boolean	Flag showing if the object is deleted.
dispatchJob.id	uint64?	Identifier given as input for the command.
dispatchJob.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJob": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobGetBaseResponseobject

Response description

Property	Type	Description
dispatchJob	DispatchJob	The requested DispatchJob.
dispatchJob.asset	uint64? see: Asset.id	The Asset to which this job belongs. This value is null when unassigned.
dispatchJob.attachments	Array.<uint64> maximum-count: 10 for values see: Document.id	A list of hosted Document identifiers attached to this job.
dispatchJob.company	uint64 see: Company.id	The company to which this job belongs.
dispatchJob.created	datetime	When this job was originally created.
dispatchJob.driver	string	Clocked-in driver name who made the update. Null if not clocked-in, or no changes have been made.
dispatchJob.forms	Array.<uint64> maximum-count: 10 for values see: FormResult.id	A list of hosted FormResult identifiers attached to this job.
dispatchJob.id	uint64	Unique identifier of this job.
dispatchJob.instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them complete the job.
dispatchJob.labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate (unassigned) jobs to Assets.
dispatchJob.name	string maximum-length: 100	A name for the work needed to be performed.
dispatchJob.priority	DispatchJobPriority	The importance of this job when scheduling for an asset.
dispatchJob.processedUtc	datetime	When the was change procesed.
dispatchJob.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
dispatchJob.steps	Array.<DispatchStep>	A list of coordinates to visit in order to carry out the work for this job.
dispatchJob.tags	Array.<codified> for values see: LabelStyle.code	The codified status tag names reflecting the conditions of this job.
dispatchJob.updated		by: login, from: monster
dispatchJob.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJob": {
		"asset": number,
		"attachments": [
			number
		],
		"company": number,
		"created": string,
		"driver": string,
		"forms": [
			number
		],
		"id": number,
		"instructions": string,
		"labels": [
			string
		],
		"name": string,
		"priority": string,
		"processedUtc": string,
		"references": {
			string: string
		},
		"steps": [
			{
				"address": string,
				"duration": string,
				"eta": string,
				"id": number,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"signatory": string,
				"signature": boolean,
				"states": {
					string: {
						"latlng": {
							"lat": number,
							"lng": number
						},
						"updated": string
					}
				}
			}
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of DispatchJobs belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobListByAssetAndRefPairsBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of DispatchJobs belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDispatchJobListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchJobs belong.
company.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchJobs belong.
company.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespDispatchJobListByCompanyAndRefPairsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchJobs belong.
company.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDispatchJobListByCompanyNoAssetBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchJobs belong.
company.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobListByCompanyNoAssetAndRefPairsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchJobs belong.
company.id	uint64?	Identifier given as input for the command.
dispatchJobs	Array.<DispatchJob>	The list of requested DispatchJobs.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchJobs": [
		{
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"created": string,
			"driver": string,
			"forms": [
				number
			],
			"id": number,
			"instructions": string,
			"labels": [
				string
			],
			"name": string,
			"priority": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"steps": [
				{
					"address": string,
					"duration": string,
					"eta": string,
					"id": number,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"signatory": string,
					"signature": boolean,
					"states": {
						string: {
							"latlng": {
								"lat": number,
								"lng": number
							},
							"updated": string
						}
					}
				}
			],
			"tags": [
				string
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDispatchJobMergeBaseResponseobject

Response description

Property	Type	Description
dispatchJob	RespIdCompany	The id, owning Company id and owning Asset id of the object requested/created.
dispatchJob.company	uint64	Identifier of the Company to which this object belongs.
dispatchJob.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJob": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchJobRestoreBaseResponseobject

Response description

Property	Type	Description
dispatchJob	RespDeleted	The id, owning Asset id, owning Company id, and deleted state.
dispatchJob.company	uint64	Identifier of the Company to which this object belongs.
dispatchJob.deleted	boolean	Flag showing if the object is deleted.
dispatchJob.id	uint64?	Identifier given as input for the command.
dispatchJob.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchJob": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskBatchDeleteBaseResponseobject

Response description

Property	Type	Description
dispatchTasks	Array.<RespAssetDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTasks": [
		{
			"asset": number,
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskBatchMergeBaseResponseobject

Response description

Property	Type	Description
dispatchTasks	Array.<RespIdAsset>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTasks": [
		{
			"asset": number,
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskDeleteBaseResponseobject

Response description

Property	Type	Description
dispatchTask	RespAssetDeleted	The id, owning Asset id, owning Company id, and deleted state.
dispatchTask.asset	uint64	Identifier of the Asset to which this object belongs.
dispatchTask.company	uint64	Identifier of the Company to which this object belongs.
dispatchTask.deleted	boolean	Flag showing if the object is deleted.
dispatchTask.id	uint64?	Identifier given as input for the command.
dispatchTask.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTask": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskGetBaseResponseobject

Response description

Property	Type	Description
dispatchTask Deprecated	DispatchTask	The requested DispatchTask. Use DispatchJob instead.
dispatchTask.address	string maximum-length: 500	The street address of where the task must be completed.
dispatchTask.arrived	datetime	The date/time stamp of when the asset arrived at this task.
dispatchTask.asset	uint64 see: Asset.id	The asset to which this task belongs.
dispatchTask.attachments	Array.<uint64> maximum-count: 10 for values see: Document.id	A list of hosted Document identifiers attached to this task.
dispatchTask.company	uint64 see: Company.id	The company to which this task belongs.
dispatchTask.completed	datetime	The date/time stamp of when this task was completed.
dispatchTask.created	datetime	When this task was created.
dispatchTask.duration	timespan	The optional expected duration of the work for this task.
dispatchTask.eta	datetime	The optional estimated time of arrival for the asset.
dispatchTask.id	uint64	Unique identifier of this task.
dispatchTask.instructions	string	Instructions (filled out by dispatcher) for the field-employee to help them completed the task.
dispatchTask.latlng	LatLng	The lat/long coordinates of where the task must be completed.
dispatchTask.latlng.lat	double	Latitude
dispatchTask.latlng.lng	double	Longitude
dispatchTask.name	string maximum-length: 100	The name of this task or the work needed to be performed.
dispatchTask.notes	string	Notes about the status of the work filled in by field-employee.
dispatchTask.place	uint64? see: Place.id	An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
dispatchTask.processedUtc	datetime	When the was change procesed.
dispatchTask.reference Deprecated	string maximum-length: 100	A custom field used to refer to an external system. Examples are a work order, pick-up, waybill, etc... Use dispatchTask.references[DispatchTask.REFERENCE] instead.
dispatchTask.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
dispatchTask.signatory	string maximum-length: 100	The name of the person who signed the task's completion.
dispatchTask.signature	boolean	Indicates whether the task has a signature.
dispatchTask.status Deprecated	TaskStatus	The progress of this task. Use DispatchStepStatus instead.
dispatchTask.updated		by: login, from: monster
dispatchTask.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTask": {
		"address": string,
		"arrived": string,
		"asset": number,
		"attachments": [
			number
		],
		"company": number,
		"completed": string,
		"created": string,
		"duration": string,
		"eta": string,
		"id": number,
		"instructions": string,
		"latlng": {
			"lat": number,
			"lng": number
		},
		"name": string,
		"notes": string,
		"place": number,
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"signatory": string,
		"signature": boolean,
		"status": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of DispatchTasks belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskListByAssetAndRefBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of DispatchTasks belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reference	string	The "Reference" value given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reference": string,
	"reqId": number
}

RespDispatchTaskListByAssetAndRefPairsBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of DispatchTasks belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDispatchTaskListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchTasks belong.
company.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskListByCompanyAndRefBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchTasks belong.
company.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reference	string	The "Reference" value given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reference": string,
	"reqId": number
}

RespDispatchTaskListByCompanyAndRefPairsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of DispatchTasks belong.
company.id	uint64?	Identifier given as input for the command.
dispatchTasks	Array.<DispatchTask>	The list of requested DispatchTasks.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dispatchTasks": [
		{
			"address": string,
			"arrived": string,
			"asset": number,
			"attachments": [
				number
			],
			"company": number,
			"completed": string,
			"created": string,
			"duration": string,
			"eta": string,
			"id": number,
			"instructions": string,
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"place": number,
			"processedUtc": string,
			"reference": string,
			"references": {
				string: string
			},
			"signatory": string,
			"signature": boolean,
			"status": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDispatchTaskMergeBaseResponseobject

Response description

Property	Type	Description
dispatchTask	RespIdAsset	The id, owning Asset id, and owning Company id of the object requested/created.
dispatchTask.asset	uint64	Identifier of the Asset to which this object belongs
dispatchTask.company	uint64	Identifier of the Company to which this object belongs.
dispatchTask.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTask": {
		"asset": number,
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDispatchTaskRestoreBaseResponseobject

Response description

Property	Type	Description
dispatchTask	RespAssetDeleted	The id, owning Asset id, owning Company id, and deleted state.
dispatchTask.asset	uint64	Identifier of the Asset to which this object belongs.
dispatchTask.company	uint64	Identifier of the Company to which this object belongs.
dispatchTask.deleted	boolean	Flag showing if the object is deleted.
dispatchTask.id	uint64?	Identifier given as input for the command.
dispatchTask.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dispatchTask": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

TaskStatusstring Deprecated: Use DispatchStepStatus instead.

Tasks have a lifetime and each status represents a task's progress through it's life.

Value	Description
arrived Deprecated	The asset has arrived at the task's location. Use DispatchStepStatus instead.
cancelled Deprecated	The task was cancelled by either the asset or a user. Use DispatchStepStatus instead.
completed Deprecated	The task is done. Use DispatchStepStatus instead.
created Deprecated	The task has been created, but not yet assigned to an asset. Use DispatchStepStatus instead.
damaged Deprecated	An item associated with this task is damaged. Use DispatchStepStatus instead.
droppedOff Deprecated	An item was dropped-off for this task. Use DispatchStepStatus instead.
onRoute Deprecated	The asset is on the way to the task's location next. Use DispatchStepStatus instead.
pickedUp Deprecated	An item was picked-up for this task. Use DispatchStepStatus instead.
queued Deprecated	The task has been given to an asset (and delivered to the asset's primary device). Use DispatchStepStatus instead.
unsuccessful Deprecated	The task couldn't be completed by the asset. Use DispatchStepStatus instead.
waiting Deprecated	The asset is waiting and can't complete the task. Use DispatchStepStatus instead.

File Hosting

DashcamDataobject

An image or video received from a dashcam-enabled provider or asset.

JSON description

Property	Type	Description
altitude	double	Altitude of the start of the resource.
asset	uint64? see: Asset.id	Unique identifier of the asset tied to the provider at the time.
bytes	uint64	Number bytes in the dashcam media file.
camera	byte	Number assigned to the camera that took the image/video.
company	uint64 see: Company.id	Unique identifier of the company of the provider.
end	datetime	Timestamp of when this resource ended. For DashcamDataType.image media files, the start and end are the same.
eventName	string	The reason why we're saving this image/video. Or the event name that triggered it.
fps	single?	For DashcamDataType.video media files, this indicates the frames-per-second.
guid	guid	Unique identifier of this resource.
heading	double	Heading of the start of the resource.
kind	DashcamDataType	The type of data being stored.
latitude	double	Latitude of the start of the resource.
longitude	double	Longitude of the start of the resource.
provider	string see: Provider.id	Unique identifier of the provider that sent the data.
size	Size	Resolution defined in pixels.
speed	double	Speed of the start of the resource.
start	datetime	Timestamp of when this resource started. For DashcamDataType.image media files, the start and end are the same.

JSON structure

{
	"altitude": number,
	"asset": number,
	"bytes": number,
	"camera": number,
	"company": number,
	"end": string,
	"eventName": string,
	"fps": number,
	"guid": string,
	"heading": number,
	"kind": string,
	"latitude": number,
	"longitude": number,
	"provider": string,
	"size": {
		"height": number,
		"width": number
	},
	"speed": number,
	"start": string
}

DashcamDataLiveobject

An live snapshot a dashcam-enabled provider or asset.

JSON description

Property	Type	Value	Description
altitude	double		Altitude of the start of the resource.
asset	uint64? see: Asset.id		Unique identifier of the asset tied to the provider at the time.
bytes	uint64		Number bytes in the dashcam media file.
camera	byte		Number assigned to the camera that took the image/video.
company	uint64 see: Company.id		Unique identifier of the company of the provider.
dts	datetime		Timestamp of this live camera image.
heading	double		Heading of the start of the resource.
kind	DashcamDataType	`DashcamDataType.image`	The type of data being stored.
latitude	double		Latitude of the start of the resource.
longitude	double		Longitude of the start of the resource.
provider	string see: Provider.id		Unique identifier of the provider that sent the data.
size	Size		Resolution defined in pixels.
speed	double		Speed of the start of the resource.

JSON structure

{
	"altitude": number,
	"asset": number,
	"bytes": number,
	"camera": number,
	"company": number,
	"dts": string,
	"heading": number,
	"kind": string,
	"latitude": number,
	"longitude": number,
	"provider": string,
	"size": {
		"height": number,
		"width": number
	},
	"speed": number
}

DashcamDataTypestring

The type of dashcam data being stored.

Value	Description
image	Image
unknown	Unknown or other.
video	Video

Documentobject

A file stored temporarily by the system.

JSON description

Property	Type	Description
bytes	uint64	The file-size on the disk.
company	uint64 see: Company.id	The company to which this file belongs.
expiry	datetime	The date and time this fill will be automatically purged from our system.
id	uint64	Unique identifier of this file.
mime	string maximum-length: 50	The MIME type of the file.
name	string maximum-length: 100	The file name of this file.
notes	string	Notes about this file.
processedUtc	datetime	When the was change procesed.
references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
src	string maximum-length: 200	The URL/path to find this file.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"bytes": number,
	"company": number,
	"expiry": string,
	"id": number,
	"mime": string,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"references": {
		string: string
	},
	"src": string,
	"updated": {
	},
	"v": [
		number
	]
}

DocumentDeletedobject

The message format for when a deleted Document is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this file belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this file.
name	string maximum-length: 100		The file name of this file.
notes	string		Notes about this file.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

FormFieldAttachmentsFormFieldBaseobject

A control to allow the user to attach Pictures or Documents.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	byte?	Maximum number of Documents and/or Pictures that must be attached.
minimum	byte?	Minimum number of Documents and/or Pictures that must be attached.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": number,
	"minimum": number,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldBaseobject Abstract

A base class for the common form field UI members.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldBooleanFormFieldBaseobject

A true/false (or either-or) input control.

JSON description

Property	Type	Description
choices	Array.<string>	These three values are the values of the choices presented. The first value is the "checked" value, second is the "unchecked" value, and third is "indeterminate" value.
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"choices": [
		string
	],
	"editable": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldChoiceFormFieldBaseobject

A single- or multiple-choice input control.

JSON description

Property	Type	Description
choices	Object.<string, string>	The list of choices available and their values.
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	byte?	Maximum number of choices that must be selected.
minimum	byte?	Minimum number of choices that must be selected.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"choices": {
		string: string
	},
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": number,
	"minimum": number,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldDateFormFieldBaseobject

A control to choose a date and (optionally) a time.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	datetime	The latest date or date/time.
minimum	datetime	The earliest date or date/time.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": string,
	"minimum": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldNumericFormFieldBaseobject

A numeric value input control with multiple contexts available.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	double?	The (optional) maximum value.
minimum	double?	The (optional) minimum value.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
precision	byte	Number of decimal places of accuracy are required.
required	boolean	When true, a valid value must be given for this field.
size	FormFieldNumericSize	A context hint for the kind of numeric size for this field. Used only for FormFieldType.distance, FormFieldType.weight, FormFieldType.volume, and FormFieldType.speed.
step	double	The numeric value increments by this amount.
units	string	An optional suffix for this numeric value, like "%" or "ppm". This value is ignored for FormFieldType.distance, FormFieldType.weight, FormFieldType.volume, FormFieldType.speed, and FormFieldType.area field types. And for FormFieldType.currency fields it acts as a prefix, like "$" or "USD".
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": number,
	"minimum": number,
	"name": string,
	"notes": string,
	"precision": number,
	"required": boolean,
	"size": string,
	"step": number,
	"units": string,
	"value": string
}

FormFieldNumericSizestring

A context hint for the size of a measurements.

Value	Description
large	A large measurement. For FormFieldType.distance: ProviderDataUnit.km/ProviderDataUnit.mi For FormFieldType.weight: ProviderDataUnit.t/ProviderDataUnit.ton For FormFieldType.volume: ProviderDataUnit.l/ProviderDataUnit.gal For FormFieldType.speed: ProviderDataUnit.kph/ProviderDataUnit.mph For FormFieldType.area: ProviderDataUnit.ha/ProviderDataUnit.ac
medium	A medium measurement. For FormFieldType.distance: ProviderDataUnit.m/ProviderDataUnit.ft For FormFieldType.weight: ProviderDataUnit.kg/ProviderDataUnit.lbs For FormFieldType.volume: same as FormFieldNumericSize.small For FormFieldType.speed: ProviderDataUnit.mps/ProviderDataUnit.ftps For FormFieldType.area: ProviderDataUnit.sqkm/ProviderDataUnit.sqmi
small	A small measurement. For FormFieldType.distance: ProviderDataUnit.cm/ProviderDataUnit.in For FormFieldType.weight: ProviderDataUnit.g/ProviderDataUnit.oz For FormFieldType.volume: ProviderDataUnit.ml/ProviderDataUnit.oz For FormFieldType.speed: ProviderDataUnit.cmps/ProviderDataUnit.inps For FormFieldType.area: ProviderDataUnit.sqm/ProviderDataUnit.sqft

FormFieldSignatureFormFieldBaseobject

A control to capture a signature from the user.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldTextFormFieldBaseobject

A text input control.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	uint16?	Maximum length of entered text to make it a valid entry.
minimum	uint16?	Minimum length of entered text to make it a valid entry.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
rows	byte	The number of rows of text to display.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": number,
	"minimum": number,
	"name": string,
	"notes": string,
	"required": boolean,
	"rows": number,
	"value": string
}

FormFieldTimeFormFieldBaseobject

A control to choose a time or duration longer than 24 hours.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
maximum	timespan	The maximum duration or latest time-of-day.
minimum	timespan	The minimum duration or earliest time-of-day.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": string,
	"minimum": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldTimezoneFormFieldBaseobject

A Timezone selection control.

JSON description

Property	Type	Description
editable	boolean	When false, this field's value is treated as read-only.
id	uint64	Identifier for this field. This value is unique per FormTemplate, but is not unique system-wide.
kind	FormFieldType	The type of interface control that should be presented to the user.
name	string	Name of the field.
notes	string	Notes or special instructions for this control.
required	boolean	When true, a valid value must be given for this field.
value	string	The default value for the field in the template.

JSON structure

{
	"editable": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"required": boolean,
	"value": string
}

FormFieldTypestring

The supported types of user interface modules for a FormTemplate.

Value	Description
area	A numeric value of area (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
checkbox	A check mark to represent a boolean value. see: FormFieldBoolean
choice	A choice of one (or more) values defined. see: FormFieldChoice
currency	A numeric value representing an amount of money. see: FormFieldNumeric
date	A calendar/date picker. see: FormFieldDate
datetime	A date and time picker. see: FormFieldDate
distance	A numeric value of distance (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
dropdown	A drop-down or fly-out UI for choosing a single value. Works better than FormFieldType.choice when there are a lot of values. ie; country or province list. see: FormFieldChoice
duration	A duration picker. Different than FormFieldType.time because a duration can be negative, or longer than 24 hours. see: FormFieldTime
files	A browser of Documents that can be attached. see: FormFieldAttachments
fuelEconomy	A numeric value of fuel economy (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
numeric	Numeric (optionally decimal) input. see: FormFieldNumeric
pictures	A browser of Pictures that can be attached. see: FormFieldAttachments
pressure	A numeric value of pressure (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
range	A slider bar to choose a numeric value between a given high and low value. see: FormFieldNumeric
signature	Area to capture a signature bitmap. see: FormFieldSignature
speed	A numeric value of speed (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
temperature	A numeric value of temperature (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
text	Any text input. see: FormFieldText
time	A clock/time picker. see: FormFieldTime
timezone	A list of Timezones. see: FormFieldTimezone
toggle	A toggle box to represent one of two possible values (optionally defined). see: FormFieldBoolean
volume	A numeric value of volume (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric
weight	A numeric value of weight (for easy conversion between SystemsOfUnits.metric and SystemsOfUnits.standard). see: FormFieldNumeric

FormResultobject

A completed form submitted by a User or Asset.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The Asset to which this form belongs.
company	uint64 see: Company.id	The Company to which this form belongs.
completed	datetime	A timestamp from when this form was completed by a User or Asset.
driver	string	Clocked-in driver name who made the update. Null if not clocked-in, or no changes have been made.
fields	Object.<uint64, string>	All the values for fillable fields by index.
id	uint64	Unique identifier of this form.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate forms to Assets.
latlng	LatLng	The coordinates of the User or Asset from when the form was completed.
name	string maximum-length: 100	Name of this form.
notes	string	Notes about this form.
processedUtc	datetime	When the was change procesed.
template	uint64	The FormTemplate to which this form belongs.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"completed": string,
	"driver": string,
	"fields": {
		string: string
	},
	"id": number,
	"labels": [
		string
	],
	"latlng": {
		"lat": number,
		"lng": number
	},
	"name": string,
	"notes": string,
	"processedUtc": string,
	"template": number,
	"updated": {
	},
	"v": [
		number
	]
}

FormResultDeletedobject

The message format for when a deleted FormResult is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The Company to which this form belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this form.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names used to relate forms to Assets.
name	string maximum-length: 100		Name of this form.
notes	string		Notes about this form.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

FormTemplateobject

The full definition of a form that needs to be filled out.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The Company to which this form belongs.
fields	Array.<FormFieldBase>	All the user fillable fields by name.
fill	colour maximum-length: 22	The fill/background colour of the icon.
graphic	codified maximum-length: 22	The name of the symbol for this template.
id	uint64	Unique identifier of this form.
labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate forms to Assets.
name	string maximum-length: 100	Name of this form.
notes	string	Notes about this form.
processedUtc	datetime	When the was change procesed.
stroke	colour maximum-length: 22	Outline and graphic colour.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"fields": [
		{
			"editable": boolean,
			"id": number,
			"kind": string,
			"name": string,
			"notes": string,
			"required": boolean,
			"value": string
		}
	],
	"fill": string,
	"graphic": string,
	"id": number,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"processedUtc": string,
	"stroke": string,
	"updated": {
	},
	"v": [
		number
	]
}

FormTemplateDeletedobject

The message format for when a deleted FormTemplate is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The Company to which this form belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this form.
labels	Array.<codified> for values see: LabelStyle.code		Codified label names used to relate forms to Assets.
name	string maximum-length: 100		Name of this form.
notes	string		Notes about this form.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

Iconobject

A visual representation of a thing on a map or in a list.

JSON description

Property	Type	Description
badge	IconLabel	Where the notification will appear for a mapped icon. Such as the number of dispatches an asset is working on, or the number of dispatches at a place.
category	string maximum-length: 100	A noun to describe the type of thing represented. Like Truck, Car, Trailer, Hot-Air Balloon, etc...
company	uint64 see: Company.id	The company to which this icon belongs.
global	boolean	Indicates whether this icon is available to child companies.
glyphs	Array.<IconGlyph>	The images used to show the detail of this icon.
id	uint64	Unique identifier of this icon.
label	IconLabel	Definition for the name bubble above the icon on a map.
name	string maximum-length: 100	A specific adjective to describe the thing. Like Blue, Red, Empty, Full, etc...
notes	string	Notes.
processedUtc	datetime	When the was change procesed.
updated		by: login, from: monster
usage	Array.<string>	A list of things that this icon can be used to represent. Like asset, place, user, etc...
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"badge": {
		"align": string,
		"anchor": {
			"x": number,
			"y": number
		},
		"colour": string
	},
	"category": string,
	"company": number,
	"global": boolean,
	"glyphs": [
		{
			"anchor": {
				"x": number,
				"y": number
			},
			"layer": string,
			"rotates": boolean,
			"size": {
				"height": number,
				"width": number
			},
			"src": string,
			"tags": [
				string
			],
			"zIndex": number
		}
	],
	"id": number,
	"label": {
		"align": string,
		"anchor": {
			"x": number,
			"y": number
		},
		"colour": string
	},
	"name": string,
	"notes": string,
	"processedUtc": string,
	"updated": {
	},
	"usage": [
		string
	],
	"v": [
		number
	]
}

IconDeletedobject

The message format for when a deleted Icon is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this icon belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this icon.
name	string maximum-length: 100		A specific adjective to describe the thing. Like Blue, Red, Empty, Full, etc...
notes	string		Notes.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

IconGlyphobject

The image source and defined status tags which need to be applied to an asset in order to show the image.

JSON description

Property	Type	Description
anchor	Point	The offset from the lat/long in pixels.
layer	IconLayer	The layer on which this glyph is displayed.
rotates	boolean	Indicates that this glyph rotate based on GPS bearing.
size	Size	Size of the glyph in pixels.
src	string	Path to the image.
tags	Array.<codified> for values see: LabelStyle.code	A list of codified status tag names. Any of the tags must be applied to the asset for the image to appear.
zIndex	uint16	The z-order of this glyph compared to other glyphs on the same layer.

JSON structure

{
	"anchor": {
		"x": number,
		"y": number
	},
	"layer": string,
	"rotates": boolean,
	"size": {
		"height": number,
		"width": number
	},
	"src": string,
	"tags": [
		string
	],
	"zIndex": number
}

IconLabelobject

Definition for the name bubble above the icon on a map.

JSON description

Property	Type	Description
align	string	Determines which corner of the label is attached to the anchor.
anchor	Point	The offset from the lat/long in pixels.
colour	string	Background colour of the label.

JSON structure

{
	"align": string,
	"anchor": {
		"x": number,
		"y": number
	},
	"colour": string
}

IconLayerstring

The layers of the map used to visualize the icon.

Value	Description
drawings	An SVG only layer for special drawing controls. Icons should not use this layer.
edits	An HTML only layer for special drawing controls. Icons should not use this layer.
fills	An SVG only layer just above the roads used for solid Places and accuracy radius fill.
labels	An HTML only layer intended for use by an icon's label.
markers	An HTML only layer intended for use by an icon's main images.
outlines	An SVG only layer intended for use by shape and accuracy radius outlines.
shadows	An HTML only layer intended for use by an icon's drop-shadow.

ParamDashcamGetBaseParametersobject

Request description

Property	Type	Required	Description
dashcam	ParamGuid	always	An object to contain the "guid" of the dashcam image or video metadata.
dashcam.guid	guid	always	The global unique identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"dashcam": {
		"guid": string
	},
	"reqId": number
}

ParamDashcamListByAssetBaseParametersobject

Request description

Property	Type	Required	Description
after	datetime	always	A timestamp for the earliest dashcam image or video metadata to retrieve.
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
before	datetime	always	A timestamp for the latest dashcam image or video metadata to retrieve.
kind	DashcamDataType?	optional	An optional filter available so that only a certain kind of DashcamData is returned.
limit	uint16	optional	Maximum number of dashcam media file details in this response.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"kind": string,
	"limit": number,
	"reqId": number
}

ParamDashcamListByCompanyBaseParametersobject

Request description

Property	Type	Required	Description
after	datetime	always	A timestamp for the earliest dashcam image or video metadata to retrieve.
before	datetime	always	A timestamp for the latest dashcam image or video metadata to retrieve.
company	ParamId	always	An object to contain the "id" of the Company.
company.id	uint64	always	Identifier given as input for the command.
kind	DashcamDataType?	optional	An optional filter available so that only a certain kind of DashcamData is returned.
limit	uint16	optional	Maximum number of dashcam media file details in this response.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"kind": string,
	"limit": number,
	"reqId": number
}

ParamDashcamListByProviderBaseParametersobject

Request description

Property	Type	Required	Description
after	datetime	always	A timestamp for the earliest dashcam image or video metadata to retrieve.
before	datetime	always	A timestamp for the latest dashcam image or video metadata to retrieve.
kind	DashcamDataType?	optional	An optional filter available so that only a certain kind of DashcamData is returned.
limit	uint16	optional	Maximum number of dashcam media file details in this response.
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"kind": string,
	"limit": number,
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamDashcamLiveListByAssetBaseParametersobject

Request description

Property	Type	Required	Description
asset	ParamId	always	An object to contain the "id" of the Asset.
asset.id	uint64	always	Identifier given as input for the command.
camera	byte?	optional	Number assigned to the camera that took the image/video.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"asset": {
		"id": number
	},
	"camera": number,
	"reqId": number
}

ParamDashcamLiveListByCompanyBaseParametersobject

Request description

Property	Type	Required	Description
camera	byte?	optional	Number assigned to the camera that took the image/video.
company	ParamId	always	An object to contain the "id" of the Company.
company.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"camera": number,
	"company": {
		"id": number
	},
	"reqId": number
}

ParamDashcamLiveListByProviderBaseParametersobject

Request description

Property	Type	Required	Description
camera	byte?	optional	Number assigned to the camera that took the image/video.
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"camera": number,
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamDocumentBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
documents	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"documents": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamDocumentBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
documents	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"documents": [
		{
			"company": number,
			"expiry": string,
			"id": number,
			"name": string,
			"notes": string,
			"references": {
				string: string
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamDocumentDeleteBaseParametersobject

Request description

Property	Type	Required	Description
document	ParamId	always	An object to contain the identifier of the Document.
document.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"document": {
		"id": number
	},
	"reqId": number
}

ParamDocumentGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
document	ParamId	always		An object to contain the identifier of the Document.
document.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Document.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"document": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamDocumentListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamDocumentListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: Document.references	optional		Case-insensitive reference pairs used to match Documents.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number
}

ParamDocumentMergeBaseParametersobject

Request description

Property	Type	Required	Description
document	Object.<string, ?>	always	A simple object to contain the Document parameters.
document.company	uint64?	create	The Company to which this Document belongs. After creation, this value is read-only.
document.expiry	datetime	optional	The time at which the Document will automatically be purged from the system.
document.id	uint64?	update	The unique identifier of the Document you want to update.
document.name	string maximum-length: 100	create	The file name of this Document.
document.notes	string	optional	Notes about this Document.
document.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	optional	Name/value collections of custom fields used to refer to external systems. If the value is null, the references are removed from the Document.
document.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"document": {
		"company": number,
		"expiry": string,
		"id": number,
		"name": string,
		"notes": string,
		"references": {
			string: string
		},
		"v": [
			number
		]
	},
	"reqId": number
}

ParamDocumentRestoreBaseParametersobject

Request description

Property	Type	Required	Description
document	ParamId	always	An object to contain the identifier of the Document.
document.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"document": {
		"id": number
	},
	"reqId": number
}

ParamFormFieldobject

Parameters used to create various FormFieldTypes.

JSON description

Property	Type	Required	Description
choices	Object	optional	Will be a dictionary of strings for choice/drop-down fields, or will be a array of strings for checkbox/toggle-switch fields.
editable	boolean	optional	When false, this field's value is treated as read-only.
id	uint64?	optional	The identifier of the field. Identifiers are unique to a FormTemplate, but are not unique system-wide.
kind	FormFieldType?	create	The type of interface control that should be presented to the user.
maximum	Object	optional	Will be a int64 or double representing the maximum number or attachments, choices, or longest text length, or will be a datetime representing the latest possible date and/or time, or will be a datetime representing thee latest possible time or largest duration.
minimum	Object	optional	Will be a int64 or double representing the minimum number or attachments, choices, or shortest text length, or will be a datetime representing the earliest possible date and/or time, or will be a datetime representing the earliest possible time or smallest duration.
name	string	optional	The name for the field.
notes	string	optional	Notes or special instructions for this control.
precision	int64?	optional	The FormFieldNumeric.precision used for FormFieldNumeric fields.
required	boolean	optional	When true, a valid value must be given for this field.
rows	int64?	optional	The FormFieldText.rows used for FormFieldText fields.
size	FormFieldNumericSize?	optional	A FormFieldNumeric.size context hint for FormFieldNumeric fields.
step	double?	optional	The FormFieldNumeric.step used for FormFieldNumeric fields.
units	string	optional	The FormFieldNumeric.units used for FormFieldNumeric fields.
value	string	optional	The default value for the field in the template.

JSON structure

{
	"choices": Object,
	"editable": boolean,
	"id": number,
	"kind": string,
	"maximum": Object,
	"minimum": Object,
	"name": string,
	"notes": string,
	"precision": number,
	"required": boolean,
	"rows": number,
	"size": string,
	"step": number,
	"units": string,
	"value": string
}

ParamFormResultBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
formResults	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResults": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamFormResultBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
formResults	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResults": [
		{
			"asset": number,
			"completed": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"template": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamFormResultDeleteBaseParametersobject

Request description

Property	Type	Required	Description
formResult	ParamId	always	An object to contain the "id" of the FormResult.
formResult.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResult": {
		"id": number
	},
	"reqId": number
}

ParamFormResultGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
formResult	ParamId	always		An object to contain the "id" of the FormResult.
formResult.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted FormResult.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResult": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamFormResultListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamFormResultListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: FormResult.labels	optional		A list of label codes used to match FormResults. All labels must match to include a FormResult in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ParamFormResultMergeBaseParametersobject

Request description

Property	Type	Required	Description
formResult	Object.<string, ?>	always	A simple object to contain the FormResult parameters.
formResult.asset	uint64?	create	The unique identifier of the Asset filling out this form.
formResult.completed	datetime	optional	A timestamp from when the FormResult was completed.
formResult.fields	Object.<uint64, string> maximum-length of values: 254	optional	A collection of values for the FormResult.fields. You can update parts of the collection, the FormResult must have a value for all fields in order to complete it.
formResult.id	uint64?	update	The unique identifier of the FormResult you want to update.
formResult.labels	Array.<codified> for values see: LabelStyle.code	optional	Codified label names used to relate forms to Assets.
formResult.latlng	LatLng	optional	Coordinates from when the FormResult was completed.
formResult.latlng.lat	double	optional	Latitude
formResult.latlng.lng	double	optional	Longitude
formResult.name	string maximum-length: 100	optional	Name for the FormResult.
formResult.notes	string	optional	Notes for the FormResult.
formResult.template	uint64?	create	The unique identifier of the FormTemplate for this form.
formResult.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResult": {
		"asset": number,
		"completed": string,
		"fields": {
			string: string
		},
		"id": number,
		"labels": [
			string
		],
		"latlng": {
			"lat": number,
			"lng": number
		},
		"name": string,
		"notes": string,
		"template": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamFormResultRestoreBaseParametersobject

Request description

Property	Type	Required	Description
formResult	ParamId	always	An object to contain the "id" of the FormResult.
formResult.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formResult": {
		"id": number
	},
	"reqId": number
}

ParamFormTemplateBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
formTemplates	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplates": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamFormTemplateBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
formTemplates	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplates": [
		{
			"company": number,
			"fields": [
				{
					"choices": Object,
					"editable": boolean,
					"id": number,
					"kind": string,
					"maximum": Object,
					"minimum": Object,
					"name": string,
					"notes": string,
					"precision": number,
					"required": boolean,
					"rows": number,
					"size": string,
					"step": number,
					"units": string,
					"value": string
				}
			],
			"fill": string,
			"graphic": string,
			"id": number,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"stroke": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamFormTemplateDeleteBaseParametersobject

Request description

Property	Type	Required	Description
formTemplate	ParamId	always	An object to contain the "id" of the FormTemplate.
formTemplate.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplate": {
		"id": number
	},
	"reqId": number
}

ParamFormTemplateGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
formTemplate	ParamId	always		An object to contain the "id" of the FormTemplate.
formTemplate.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted FormTemplate.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplate": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamFormTemplateListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamFormTemplateListByCompanyAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: FormTemplate.labels	optional		A list of label codes used to match FormTemplates. All labels must match to include a FormTemplate in the result.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamFormTemplateMergeBaseParametersobject

Request description

Property	Type	Required	Description
formTemplate	Object.<string, ?>	always	A simple object to contain the FormTemplate parameters.
formTemplate.company	uint64?	create	The Company to which this FormTemplate belongs. After creation, this value is read-only.
formTemplate.fields	Array.<ParamFormField>	optional	A collection of all the FormTemplate.fields. Any field not given in the collection will be removed.
formTemplate.fill	colour maximum-length: 22	optional	Background and fill colour in the UI.
formTemplate.graphic	colour maximum-length: 22	optional	The name of the symbol shown in the UI.
formTemplate.id	uint64?	update	The unique identifier of the FormTemplate you want to update.
formTemplate.labels	Array.<codified> for values see: LabelStyle.code	optional	Codified label names used to relate forms to Assets.
formTemplate.name	string maximum-length: 100	optional	Name for the FormTemplate.
formTemplate.notes	string	optional	Notes for the FormTemplate.
formTemplate.stroke	colour maximum-length: 22	optional	Text and outline colour in the UI.
formTemplate.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplate": {
		"company": number,
		"fields": [
			{
				"choices": Object,
				"editable": boolean,
				"id": number,
				"kind": string,
				"maximum": Object,
				"minimum": Object,
				"name": string,
				"notes": string,
				"precision": number,
				"required": boolean,
				"rows": number,
				"size": string,
				"step": number,
				"units": string,
				"value": string
			}
		],
		"fill": string,
		"graphic": string,
		"id": number,
		"labels": [
			string
		],
		"name": string,
		"notes": string,
		"stroke": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamFormTemplateRestoreBaseParametersobject

Request description

Property	Type	Required	Description
formTemplate	ParamId	always	An object to contain the "id" of the FormTemplate.
formTemplate.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"formTemplate": {
		"id": number
	},
	"reqId": number
}

ParamIconBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
icons	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"icons": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamIconBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
icons	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"icons": [
		{
			"badge": {
				"align": string,
				"anchor": {
					"x": number,
					"y": number
				},
				"colour": string
			},
			"category": string,
			"company": number,
			"global": boolean,
			"glyphs": [
				{
					"anchor": {
						"x": number,
						"y": number
					},
					"layer": string,
					"rotates": boolean,
					"size": {
						"height": number,
						"width": number
					},
					"src": string,
					"tags": [
						string
					],
					"zIndex": number
				}
			],
			"id": number,
			"label": {
				"align": string,
				"anchor": {
					"x": number,
					"y": number
				},
				"colour": string
			},
			"name": string,
			"notes": string,
			"usage": [
				string
			],
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamIconDeleteBaseParametersobject

Request description

Property	Type	Required	Description
icon	ParamId	always	An object to contain the "id" of the Icon.
icon.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"icon": {
		"id": number
	},
	"reqId": number
}

ParamIconGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
icon	ParamId	always		An object to contain the "id" of the Icon.
icon.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Icon.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"icon": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamIconListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
branch	boolean	optional	`false`	When true the list of Icons from the given Company and all child-companies are returned. Otherwise, only Icons from the given Company are included.
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
trunk	boolean	optional	`true`	When true (default) the list of Icons will include any publicly available Icons from the given Company's parent(s).

Request structure

{
	"branch": boolean,
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number,
	"trunk": boolean
}

ParamIconMergeBaseParametersobject

Request description

Property	Type	Required	Description
icon	Object.<string, ?>	always	A simple object to contain the Icon parameters.
icon.badge	IconLabel	optional	Definition for the name badge beside the Icon on a map.
icon.badge.align	string	optional	Determines which corner of the label is attached to the anchor.
icon.badge.anchor	Point	optional	The offset from the lat/long in pixels.
icon.badge.anchor.x	double	optional	Horizontal coordinate
icon.badge.anchor.y	double	optional	Vertical coordinate
icon.badge.colour	string	optional	Background colour of the label.
icon.category	string maximum-length: 100	optional	A noun to describe the type of thing represented. Like Truck, Car, Trailer, Hot-Air Balloon, etc...
icon.company	uint64?	create	The Company to which these Icons belongs.
icon.global	boolean	optional	Indicates whether this Icon is available to child companies.
icon.glyphs	Array.<IconGlyph>	optional	The images used to show the detail of this Icon.
icon.id	uint64?	update	The unique identifier of the Icon you want to update.
icon.label	IconLabel	optional	Definition for the name bubble above the Icon on a map.
icon.label.align	string	optional	Determines which corner of the label is attached to the anchor.
icon.label.anchor	Point	optional	The offset from the lat/long in pixels.
icon.label.anchor.x	double	optional	Horizontal coordinate
icon.label.anchor.y	double	optional	Vertical coordinate
icon.label.colour	string	optional	Background colour of the label.
icon.name	string maximum-length: 100	create	A specific adjective to describe the thing. Like Blue, Red, Empty, Full, etc...
icon.notes	string	optional	Notes.
icon.usage	Array.<string>	optional	A list of things that this Icon can be used to represent. Like `asset`, `place`, `user`, etc...
icon.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"icon": {
		"badge": {
			"align": string,
			"anchor": {
				"x": number,
				"y": number
			},
			"colour": string
		},
		"category": string,
		"company": number,
		"global": boolean,
		"glyphs": [
			{
				"anchor": {
					"x": number,
					"y": number
				},
				"layer": string,
				"rotates": boolean,
				"size": {
					"height": number,
					"width": number
				},
				"src": string,
				"tags": [
					string
				],
				"zIndex": number
			}
		],
		"id": number,
		"label": {
			"align": string,
			"anchor": {
				"x": number,
				"y": number
			},
			"colour": string
		},
		"name": string,
		"notes": string,
		"usage": [
			string
		],
		"v": [
			number
		]
	},
	"reqId": number
}

ParamIconRestoreBaseParametersobject

Request description

Property	Type	Required	Description
icon	ParamId	always	An object to contain the "id" of the Icon.
icon.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"icon": {
		"id": number
	},
	"reqId": number
}

ParamPictureBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
pictures	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"pictures": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamPictureBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
pictures	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"pictures": [
		{
			"company": number,
			"focals": [
				{
					"bottom": number,
					"left": number,
					"right": number,
					"top": number
				}
			],
			"id": number,
			"name": string,
			"notes": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamPictureDeleteBaseParametersobject

Request description

Property	Type	Required	Description
picture	ParamId	always	An object to contain the "id" of the Picture.
picture.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"picture": {
		"id": number
	},
	"reqId": number
}

ParamPictureGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Picture.
picture	ParamId	always		An object to contain the "id" of the Picture.
picture.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"picture": {
		"id": number
	},
	"reqId": number
}

ParamPictureListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
branch	boolean	optional	`false`	When true the list of Pictures from the given Company and all child-companies are returned. Otherwise, only Pictures from the given Company are included.
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"branch": boolean,
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamPictureMergeBaseParametersobject

Request description

Property	Type	Required	Description
picture	Object.<string, ?>	always	A simple object to contain the Picture parameters.
picture.company	uint64?	create	The Company to which this Picture belongs. After creation, this value is read-only.
picture.focals	Array.<Square>	optional	A list of focal points in the Picture like faces.
picture.id	uint64?	update	The unique identifier of the Picture you want to update.
picture.name	string maximum-length: 100	create	The file name of this Picture.
picture.notes	string	optional	Notes about this Picture.
picture.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"picture": {
		"company": number,
		"focals": [
			{
				"bottom": number,
				"left": number,
				"right": number,
				"top": number
			}
		],
		"id": number,
		"name": string,
		"notes": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamPictureRestoreBaseParametersobject

Request description

Property	Type	Required	Description
picture	ParamId	always	An object to contain the "id" of the Picture.
picture.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"picture": {
		"id": number
	},
	"reqId": number
}

Pictureobject

An image stored by the system.

JSON description

Property	Type	Description
bytes	uint64	The file-size on the disk.
company	uint64 see: Company.id	The company to which this image belongs.
focals	Array.<Square>	A list of focal points in the images like faces.
id	uint64	Unique identifier of this image.
name	string maximum-length: 100	The file name of this image.
notes	string	Notes about this image.
processedUtc	datetime	When the was change procesed.
size	Size	Resolution defined in pixels.
src	string maximum-length: 200	The URL/path to find this image.
updated		by: login, from: monster
uses	uint32	A count of the times this image was used for something (asset, contact, task, etc).
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"bytes": number,
	"company": number,
	"focals": [
		{
			"bottom": number,
			"left": number,
			"right": number,
			"top": number
		}
	],
	"id": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"size": {
		"height": number,
		"width": number
	},
	"src": string,
	"updated": {
	},
	"uses": number,
	"v": [
		number
	]
}

PictureDeletedobject

The message format for when a deleted Picture is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this image belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this image.
name	string maximum-length: 100		The file name of this image.
notes	string		Notes about this image.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

RespDashcamGetBaseResponseobject

Response description

Property	Type	Description
dashcam	DashcamData	The requested dashcam image or video metadata.
dashcam.altitude	double	Altitude of the start of the resource.
dashcam.asset	uint64? see: Asset.id	Unique identifier of the asset tied to the provider at the time.
dashcam.bytes	uint64	Number bytes in the dashcam media file.
dashcam.camera	byte	Number assigned to the camera that took the image/video.
dashcam.company	uint64 see: Company.id	Unique identifier of the company of the provider.
dashcam.end	datetime	Timestamp of when this resource ended. For DashcamDataType.image media files, the start and end are the same.
dashcam.eventName	string	The reason why we're saving this image/video. Or the event name that triggered it.
dashcam.fps	single?	For DashcamDataType.video media files, this indicates the frames-per-second.
dashcam.guid	guid	Unique identifier of this resource.
dashcam.heading	double	Heading of the start of the resource.
dashcam.kind	DashcamDataType	The type of data being stored.
dashcam.latitude	double	Latitude of the start of the resource.
dashcam.longitude	double	Longitude of the start of the resource.
dashcam.provider	string see: Provider.id	Unique identifier of the provider that sent the data.
dashcam.size	Size	Resolution defined in pixels.
dashcam.size.height	double	Height
dashcam.size.width	double	Width
dashcam.speed	double	Speed of the start of the resource.
dashcam.start	datetime	Timestamp of when this resource started. For DashcamDataType.image media files, the start and end are the same.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dashcam": {
		"altitude": number,
		"asset": number,
		"bytes": number,
		"camera": number,
		"company": number,
		"end": string,
		"eventName": string,
		"fps": number,
		"guid": string,
		"heading": number,
		"kind": string,
		"latitude": number,
		"longitude": number,
		"provider": string,
		"size": {
			"height": number,
			"width": number
		},
		"speed": number,
		"start": string
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDashcamListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespId	An object to contain the "id" of the Asset to which the array of dashcam image or video metadata belong.
asset.id	uint64?	Identifier given as input for the command.
dashcams	Array.<DashcamData>	The list of requested dashcam image or video metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
totals	Object.<DashcamDataType, HostedTotal>	Totals of hosted dashcam media as calculated at midnight.

Response structure

{
	"asset": {
		"id": number
	},
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"end": string,
			"eventName": string,
			"fps": number,
			"guid": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number,
			"start": string
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"totals": {
		string: {
			"bytes": number,
			"count": number,
			"newest": string,
			"oldest": string
		}
	}
}

RespDashcamListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of dashcam image or video metadata belong.
company.id	uint64?	Identifier given as input for the command.
dashcams	Array.<DashcamData>	The list of requested dashcam image or video metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
totals	Object.<DashcamDataType, HostedTotal>	Totals of hosted dashcam media as calculated at midnight.

Response structure

{
	"company": {
		"id": number
	},
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"end": string,
			"eventName": string,
			"fps": number,
			"guid": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number,
			"start": string
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"totals": {
		string: {
			"bytes": number,
			"count": number,
			"newest": string,
			"oldest": string
		}
	}
}

RespDashcamListByProviderBaseResponseobject

Response description

Property	Type	Description
dashcams	Array.<DashcamData>	The list of requested dashcam image or video metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifier	An object to contain the "id" of the Provider to which the array of dashcam image or video metadata belong.
provider.id	string	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.
totals	Object.<DashcamDataType, HostedTotal>	Totals of hosted dashcam media as calculated at midnight.

Response structure

{
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"end": string,
			"eventName": string,
			"fps": number,
			"guid": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number,
			"start": string
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"id": string
	},
	"reqId": number,
	"totals": {
		string: {
			"bytes": number,
			"count": number,
			"newest": string,
			"oldest": string
		}
	}
}

RespDashcamLiveListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespId	An object to contain the "id" of the Asset to which the array of dashcam live image metadata belongs.
asset.id	uint64?	Identifier given as input for the command.
dashcams	Array.<DashcamDataLive>	The list of requested dashcam live image metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"id": number
	},
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"dts": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDashcamLiveListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of dashcam live image metadata belongs.
company.id	uint64?	Identifier given as input for the command.
dashcams	Array.<DashcamDataLive>	The list of requested dashcam live image metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"dts": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDashcamLiveListByProviderBaseResponseobject

Response description

Property	Type	Description
dashcams	Array.<DashcamDataLive>	The list of requested dashcam live image metadata.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifier	An object to contain the "id" of the Provider to which the array of dashcam live image metadata belong.
provider.id	string	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"dashcams": [
		{
			"altitude": number,
			"asset": number,
			"bytes": number,
			"camera": number,
			"company": number,
			"dts": string,
			"heading": number,
			"kind": string,
			"latitude": number,
			"longitude": number,
			"provider": string,
			"size": {
				"height": number,
				"width": number
			},
			"speed": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"id": string
	},
	"reqId": number
}

RespDocumentBatchDeleteBaseResponseobject

Response description

Property	Type	Description
documents	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"documents": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentBatchMergeBaseResponseobject

Response description

Property	Type	Description
documents	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"documents": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentDeleteBaseResponseobject

Response description

Property	Type	Description
document	RespDeleted	An object which contains the Document's id, owning Company id, and deleted status.
document.company	uint64	Identifier of the Company to which this object belongs.
document.deleted	boolean	Flag showing if the object is deleted.
document.id	uint64?	Identifier given as input for the command.
document.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"document": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentGetBaseResponseobject

Response description

Property	Type	Description
document	Document	The requested Document.
document.bytes	uint64	The file-size on the disk.
document.company	uint64 see: Company.id	The company to which this file belongs.
document.expiry	datetime	The date and time this fill will be automatically purged from our system.
document.id	uint64	Unique identifier of this file.
document.mime	string maximum-length: 50	The MIME type of the file.
document.name	string maximum-length: 100	The file name of this file.
document.notes	string	Notes about this file.
document.processedUtc	datetime	When the was change procesed.
document.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
document.src	string maximum-length: 200	The URL/path to find this file.
document.updated		by: login, from: monster
document.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"document": {
		"bytes": number,
		"company": number,
		"expiry": string,
		"id": number,
		"mime": string,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"references": {
			string: string
		},
		"src": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Documents belong.
company.id	uint64?	Identifier given as input for the command.
documents	Array.<Document>	The list of requested Documents.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"documents": [
		{
			"bytes": number,
			"company": number,
			"expiry": string,
			"id": number,
			"mime": string,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"src": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentListByRefPairsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Documents belong.
company.id	uint64?	Identifier given as input for the command.
documents	Array.<Document>	The list of requested Documents.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"documents": [
		{
			"bytes": number,
			"company": number,
			"expiry": string,
			"id": number,
			"mime": string,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"references": {
				string: string
			},
			"src": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespDocumentMergeBaseResponseobject

Response description

Property	Type	Description
document	RespIdCompany	An object which contains the "id" and "company" keys.
document.company	uint64	Identifier of the Company to which this object belongs.
document.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"document": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespDocumentRestoreBaseResponseobject

Response description

Property	Type	Description
document	RespDeleted	An object which contains the Document's id, owning Company id, and deleted status.
document.company	uint64	Identifier of the Company to which this object belongs.
document.deleted	boolean	Flag showing if the object is deleted.
document.id	uint64?	Identifier given as input for the command.
document.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"document": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespFormResultBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespFormResultBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"company": number,
			"id": number
		}
	],
	"message": string,
	"reqId": number
}

RespFormResultDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResult	RespDeleted	An object which contains the FormResult's id, owning Company id, and deleted status.
formResult.company	uint64	Identifier of the Company to which this object belongs.
formResult.deleted	boolean	Flag showing if the object is deleted.
formResult.id	uint64?	Identifier given as input for the command.
formResult.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResult": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespFormResultGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResult	FormResult	The requested FormResult.
formResult.asset	uint64? see: Asset.id	The Asset to which this form belongs.
formResult.company	uint64 see: Company.id	The Company to which this form belongs.
formResult.completed	datetime	A timestamp from when this form was completed by a User or Asset.
formResult.driver	string	Clocked-in driver name who made the update. Null if not clocked-in, or no changes have been made.
formResult.fields	Object.<uint64, string>	All the values for fillable fields by index.
formResult.id	uint64	Unique identifier of this form.
formResult.labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate forms to Assets.
formResult.latlng	LatLng	The coordinates of the User or Asset from when the form was completed.
formResult.latlng.lat	double	Latitude
formResult.latlng.lng	double	Longitude
formResult.name	string maximum-length: 100	Name of this form.
formResult.notes	string	Notes about this form.
formResult.processedUtc	datetime	When the was change procesed.
formResult.template	uint64	The FormTemplate to which this form belongs.
formResult.updated		by: login, from: monster
formResult.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResult": {
		"asset": number,
		"company": number,
		"completed": string,
		"driver": string,
		"fields": {
			string: string
		},
		"id": number,
		"labels": [
			string
		],
		"latlng": {
			"lat": number,
			"lng": number
		},
		"name": string,
		"notes": string,
		"processedUtc": string,
		"template": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespFormResultListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of FormResults belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespFormResultListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of FormResults belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespFormResultMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResult	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
formResult.company	uint64	Identifier of the Company to which this object belongs.
formResult.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResult": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespFormResultRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResult	RespDeleted	An object which contains the FormResult's id, owning Company id, and deleted status.
formResult.company	uint64	Identifier of the Company to which this object belongs.
formResult.deleted	boolean	Flag showing if the object is deleted.
formResult.id	uint64?	Identifier given as input for the command.
formResult.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResult": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespFormTemplateBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplates	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplates": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespFormTemplateBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplates	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplates": [
		{
			"company": number,
			"id": number
		}
	],
	"message": string,
	"reqId": number
}

RespFormTemplateDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplate	RespDeleted	An object which contains the FormTemplate's id, owning Company id, and deleted status.
formTemplate.company	uint64	Identifier of the Company to which this object belongs.
formTemplate.deleted	boolean	Flag showing if the object is deleted.
formTemplate.id	uint64?	Identifier given as input for the command.
formTemplate.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplate": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespFormTemplateGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplate	FormTemplate	The requested FormTemplate.
formTemplate.company	uint64 see: Company.id	The Company to which this form belongs.
formTemplate.fields	Array.<FormFieldBase>	All the user fillable fields by name.
formTemplate.fill	colour maximum-length: 22	The fill/background colour of the icon.
formTemplate.graphic	codified maximum-length: 22	The name of the symbol for this template.
formTemplate.id	uint64	Unique identifier of this form.
formTemplate.labels	Array.<codified> for values see: LabelStyle.code	Codified label names used to relate forms to Assets.
formTemplate.name	string maximum-length: 100	Name of this form.
formTemplate.notes	string	Notes about this form.
formTemplate.processedUtc	datetime	When the was change procesed.
formTemplate.stroke	colour maximum-length: 22	Outline and graphic colour.
formTemplate.updated		by: login, from: monster
formTemplate.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplate": {
		"company": number,
		"fields": [
			{
				"editable": boolean,
				"id": number,
				"kind": string,
				"name": string,
				"notes": string,
				"required": boolean,
				"value": string
			}
		],
		"fill": string,
		"graphic": string,
		"id": number,
		"labels": [
			string
		],
		"name": string,
		"notes": string,
		"processedUtc": string,
		"stroke": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespFormTemplateListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of FormTemplates belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplates	Array.<FormTemplate>	The list of requested FormTemplates.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplates": [
		{
			"company": number,
			"fields": [
				{
					"editable": boolean,
					"id": number,
					"kind": string,
					"name": string,
					"notes": string,
					"required": boolean,
					"value": string
				}
			],
			"fill": string,
			"graphic": string,
			"id": number,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"processedUtc": string,
			"stroke": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespFormTemplateListByCompanyAndLabelsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of FormTemplates belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplates	Array.<FormTemplate>	The list of requested FormTemplates.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplates": [
		{
			"company": number,
			"fields": [
				{
					"editable": boolean,
					"id": number,
					"kind": string,
					"name": string,
					"notes": string,
					"required": boolean,
					"value": string
				}
			],
			"fill": string,
			"graphic": string,
			"id": number,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"processedUtc": string,
			"stroke": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespFormTemplateMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplate	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
formTemplate.company	uint64	Identifier of the Company to which this object belongs.
formTemplate.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplate": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespFormTemplateRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formTemplate	RespDeleted	An object which contains the FormTemplate's id, owning Company id, and deleted status.
formTemplate.company	uint64	Identifier of the Company to which this object belongs.
formTemplate.deleted	boolean	Flag showing if the object is deleted.
formTemplate.id	uint64?	Identifier given as input for the command.
formTemplate.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formTemplate": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespIconBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icons	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icons": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespIconBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icons	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icons": [
		{
			"company": number,
			"id": number
		}
	],
	"message": string,
	"reqId": number
}

RespIconDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icon	RespDeleted	An object which contains the Icon's id, owning Company id, and deleted status.
icon.company	uint64	Identifier of the Company to which this object belongs.
icon.deleted	boolean	Flag showing if the object is deleted.
icon.id	uint64?	Identifier given as input for the command.
icon.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icon": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespIconGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icon	Icon	The requested Icon.
icon.badge	IconLabel	Where the notification will appear for a mapped icon. Such as the number of dispatches an asset is working on, or the number of dispatches at a place.
icon.badge.align	string	Determines which corner of the label is attached to the anchor.
icon.badge.anchor	Point	The offset from the lat/long in pixels.
icon.badge.anchor.x	double	Horizontal coordinate
icon.badge.anchor.y	double	Vertical coordinate
icon.badge.colour	string	Background colour of the label.
icon.category	string maximum-length: 100	A noun to describe the type of thing represented. Like Truck, Car, Trailer, Hot-Air Balloon, etc...
icon.company	uint64 see: Company.id	The company to which this icon belongs.
icon.global	boolean	Indicates whether this icon is available to child companies.
icon.glyphs	Array.<IconGlyph>	The images used to show the detail of this icon.
icon.id	uint64	Unique identifier of this icon.
icon.label	IconLabel	Definition for the name bubble above the icon on a map.
icon.label.align	string	Determines which corner of the label is attached to the anchor.
icon.label.anchor	Point	The offset from the lat/long in pixels.
icon.label.anchor.x	double	Horizontal coordinate
icon.label.anchor.y	double	Vertical coordinate
icon.label.colour	string	Background colour of the label.
icon.name	string maximum-length: 100	A specific adjective to describe the thing. Like Blue, Red, Empty, Full, etc...
icon.notes	string	Notes.
icon.processedUtc	datetime	When the was change procesed.
icon.updated		by: login, from: monster
icon.usage	Array.<string>	A list of things that this icon can be used to represent. Like asset, place, user, etc...
icon.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icon": {
		"badge": {
			"align": string,
			"anchor": {
				"x": number,
				"y": number
			},
			"colour": string
		},
		"category": string,
		"company": number,
		"global": boolean,
		"glyphs": [
			{
				"anchor": {
					"x": number,
					"y": number
				},
				"layer": string,
				"rotates": boolean,
				"size": {
					"height": number,
					"width": number
				},
				"src": string,
				"tags": [
					string
				],
				"zIndex": number
			}
		],
		"id": number,
		"label": {
			"align": string,
			"anchor": {
				"x": number,
				"y": number
			},
			"colour": string
		},
		"name": string,
		"notes": string,
		"processedUtc": string,
		"updated": {
		},
		"usage": [
			string
		],
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespIconListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Icons belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icons	Array.<Icon>	The list of requested Icons.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icons": [
		{
			"badge": {
				"align": string,
				"anchor": {
					"x": number,
					"y": number
				},
				"colour": string
			},
			"category": string,
			"company": number,
			"global": boolean,
			"glyphs": [
				{
					"anchor": {
						"x": number,
						"y": number
					},
					"layer": string,
					"rotates": boolean,
					"size": {
						"height": number,
						"width": number
					},
					"src": string,
					"tags": [
						string
					],
					"zIndex": number
				}
			],
			"id": number,
			"label": {
				"align": string,
				"anchor": {
					"x": number,
					"y": number
				},
				"colour": string
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"updated": {
			},
			"usage": [
				string
			],
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespIconMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icon	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
icon.company	uint64	Identifier of the Company to which this object belongs.
icon.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icon": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespIconRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
icon	RespDeleted	An object which contains the Icon's id, owning Company id, and deleted status.
icon.company	uint64	Identifier of the Company to which this object belongs.
icon.deleted	boolean	Flag showing if the object is deleted.
icon.id	uint64?	Identifier given as input for the command.
icon.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"icon": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespPictureBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
pictures	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"pictures": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespPictureBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
pictures	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"pictures": [
		{
			"company": number,
			"id": number
		}
	],
	"reqId": number
}

RespPictureDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
picture	RespDeleted	An object which contains the Picture's id, owning Company id, and deleted status.
picture.company	uint64	Identifier of the Company to which this object belongs.
picture.deleted	boolean	Flag showing if the object is deleted.
picture.id	uint64?	Identifier given as input for the command.
picture.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"picture": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespPictureGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
picture	Picture	The requested Picture.
picture.bytes	uint64	The file-size on the disk.
picture.company	uint64 see: Company.id	The company to which this image belongs.
picture.focals	Array.<Square>	A list of focal points in the images like faces.
picture.id	uint64	Unique identifier of this image.
picture.name	string maximum-length: 100	The file name of this image.
picture.notes	string	Notes about this image.
picture.processedUtc	datetime	When the was change procesed.
picture.size	Size	Resolution defined in pixels.
picture.size.height	double	Height
picture.size.width	double	Width
picture.src	string maximum-length: 200	The URL/path to find this image.
picture.updated		by: login, from: monster
picture.uses	uint32	A count of the times this image was used for something (asset, contact, task, etc).
picture.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"picture": {
		"bytes": number,
		"company": number,
		"focals": [
			{
				"bottom": number,
				"left": number,
				"right": number,
				"top": number
			}
		],
		"id": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"size": {
			"height": number,
			"width": number
		},
		"src": string,
		"updated": {
		},
		"uses": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespPictureListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Pictures belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
pictures	Array.<Picture>	The list of requested Pictures.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"pictures": [
		{
			"bytes": number,
			"company": number,
			"focals": [
				{
					"bottom": number,
					"left": number,
					"right": number,
					"top": number
				}
			],
			"id": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"size": {
				"height": number,
				"width": number
			},
			"src": string,
			"updated": {
			},
			"uses": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespPictureMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
picture	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
picture.company	uint64	Identifier of the Company to which this object belongs.
picture.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"picture": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespPictureRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
picture	RespDeleted	An object which contains the Picture's id, owning Company id, and deleted status.
picture.company	uint64	Identifier of the Company to which this object belongs.
picture.deleted	boolean	Flag showing if the object is deleted.
picture.id	uint64?	Identifier given as input for the command.
picture.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"picture": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

Hours of Service

HosCarrierobject Deprecated: Feature retired.

An operator registered to transport goods or people.

JSON description

Property	Type	Description
address	StreetAddress	The carrier's physical or incorporated address.
codes	Object.<string, string>	Identity code supplied by a regulatory/government body (DOT ID).
company	uint64 see: Company.id	The company to which this carrier information belongs.
contact	uint64? see: Contact.id	Contact information for the carrier.
id	uint64	Unique identifier of the Carrier.
logo	uint64? see: Picture.id	A Picture of the carrier's logo.
name	string maximum-length: 100	The carrier's registered name.
notes	string	Notes.
processedUtc	datetime	When the was change procesed.
shiftCycle Deprecated	HosCycle	Default shift cycle used by the drivers Feature retired.
timezone	codified see: Timezone.code	The local timezone of the carrier's address.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"address": {
		"city": string,
		"country": string,
		"isToll": boolean,
		"number": string,
		"postal": string,
		"province": string,
		"region": string,
		"street": string
	},
	"codes": {
		string: string
	},
	"company": number,
	"contact": number,
	"id": number,
	"logo": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"shiftCycle": string,
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

HosCarrierDeletedobject Deprecated: Feature retired.

The message format for when a deleted HosCarrier is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this carrier information belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of the Carrier.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

HosCyclestring Deprecated: Feature retired.

Driving cycle behaviour

Value	Description
canada120h14d Deprecated	Canada South 120 hour / 14 days (Cycle 2) Feature retired.
canada120h14dN Deprecated	Canada North 120 hour / 14 days (Cycle 2) Feature retired.
canada70h7d Deprecated	Canada South 70 hour / 7 days (Cycle 1) Feature retired.
canada80h7d Deprecated	Canada North 80 hour / 7 days (Cycle 1) Feature retired.
canadaOilGas Deprecated	Canada Oil and Gas Feature retired.
unknown Deprecated	Some other cycle Feature retired.
usa60h7d Deprecated	USA Federal 60 hour / 7 days Feature retired.
usa60h7d_p Deprecated	USA Federal 60 hour / 7 days (passenger) Feature retired.
usa70h8d Deprecated	USA Federal 70 hour / 8 days Feature retired.
usa70h8d_p Deprecated	USA Federal 70 hour / 8 days (passenger) Feature retired.
usaAlaska70h7d Deprecated	USA Alaska 70 hour / 7 days Feature retired.
usaAlaska70h7d_p Deprecated	USA Alaska 70 hour / 7 days (passenger) Feature retired.
usaAlaska80h8d Deprecated	USA Alaska 80 hour / 8 days Feature retired.
usaAlaska80h8d_p Deprecated	USA Alaska 80 hour / 8 days (passenger) Feature retired.
usaCalifornia112h8d Deprecated	USA California 112 hours / 8 days (farm products) Feature retired.
usaCalifornia112h8d_p Deprecated	USA California 112 hours / 8 days (passenger) Feature retired.
usaCalifornia80h8d Deprecated	USA California 80 hour / 8 days Feature retired.
usaCalifornia80h8d_p Deprecated	USA California 80 hour / 8 days (passenger) Feature retired.
usaTexas70h7d Deprecated	USA Texas 70 hour / 7 days Feature retired.

HosDataTransferTypestring Deprecated: Feature retired.

Method of transferring HoS E-logs to the authorities

Value	Description
canadaEmail Deprecated	MTO via Email Feature retired.
usaEmail Deprecated	FMCSA via Email Feature retired.
usaWebservice Deprecated	FMCSA via Webservice portal Feature retired.

HosDefectAreastring Deprecated: Feature retired.

Shows where a defect was located on the rig.

Value	Description
tractor Deprecated	Defect on the vehicle. Feature retired.
trailer Deprecated	Defect on one of the trailers. Feature retired.

HosDefectStatusstring Deprecated: Feature retired.

Resolution status for trip inspection defects

Value	Description
corrected Deprecated	Issue fixed or resolved Feature retired.
harmless Deprecated	Issue does not affect operation Feature retired.
satisfactory Deprecated	Does not need to be corrected Feature retired.

HosDiagnosticCodebytenumber Deprecated: Feature retired.

Data diagnostic events

Value	Description
1 Deprecated	Power data diagnostic event Feature retired.
2 Deprecated	Engine synchronization data diagnostic event Feature retired.
3 Deprecated	Missing required data elements data diagnostic event Feature retired.
4 Deprecated	Data transfer data diagnostic event Feature retired.
5 Deprecated	Unidentified driving records data diagnostic event Feature retired.
6 Deprecated	Other ELD identified diagnostic event Feature retired.

HosEventobject Deprecated: Feature retired.

An ELD event record

JSON description

Property	Type	Description
address	StreetAddress	Geolocation/Written address by driver of where the event took place
carrier	uint64 see: HosCarrier.id	The carrier information to which this event belongs.
certificationDate	datetime	Date of the records being certified or re-certified by the driver
code	sbyte	Event code
company	uint64 see: Company.id	The company to which this event belongs.
diagnosticCode	HosDiagnosticCode?	Data Diagnostic Event Code
diagnosticStatus	boolean	Data Diagnostic Event Indicator Status
distanceSinceGPSFix	single?	Distance since last valid coordinates. An integer value between 0 and 6
dts	datetime	When the event took place
engineHours	double?	Odometer reading of the tractor at the time of the event
id	uint64	Unique identifier of the event.
isCoDriver	boolean	Driver status - Primary/Co-driver
latitude	string	Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -90.00 and 90.00
longitude	string	Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -179.99 and 180.00
malfunctionCode	string	Malfunction Indicator Code
malfunctionStatus	boolean	Malfunction Indicator Status
notes	string	Comments/Annotations entered by the driver/user
odometer	double?	Odometer reading of the tractor at the time of the event
origin	HosEventOrigin?	Event Record origin
person	uint64? see: Person.id	Driver associated with this event
processedUtc	datetime	When the was change procesed.
seqNo	uint16	Event Sequence Id Number
shiftCycle	HosCycle?	Driver's shift cycle
status Deprecated	HosEventStatus	Event Record status Feature retired.
type Deprecated	HosEventType	Event type Feature retired.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
vehicle	uint64? see: Vehicle.id	Vehicle associated with this event
violationStatus	boolean	Violation Status
violationType	HosViolationType?	Violation Type

JSON structure

{
	"address": {
		"city": string,
		"country": string,
		"isToll": boolean,
		"number": string,
		"postal": string,
		"province": string,
		"region": string,
		"street": string
	},
	"carrier": number,
	"certificationDate": string,
	"code": number,
	"company": number,
	"diagnosticCode": number,
	"diagnosticStatus": boolean,
	"distanceSinceGPSFix": number,
	"dts": string,
	"engineHours": number,
	"id": number,
	"isCoDriver": boolean,
	"latitude": string,
	"longitude": string,
	"malfunctionCode": string,
	"malfunctionStatus": boolean,
	"notes": string,
	"odometer": number,
	"origin": number,
	"person": number,
	"processedUtc": string,
	"seqNo": number,
	"shiftCycle": string,
	"status": number,
	"type": number,
	"updated": {
	},
	"v": [
		number
	],
	"vehicle": number,
	"violationStatus": boolean,
	"violationType": string
}

HosEventCodeCycleChangedbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated for "Canadian cycle changed" event type

Value	Description
1 Deprecated	Cycle set to "Cycle 1" Feature retired.
2 Deprecated	Cycle set to "Cycle 2" Feature retired.

HosEventCodeDeferredHoursbytenumber Deprecated: Feature retired.

Deferred hours status for events while running Canadian cycles.

Value	Description
0 Deprecated	Hours have not been defefred. Feature retired.
1 Deprecated	Hours deferred from Day 1. Feature retired.
2 Deprecated	Hours deferred from Day 2. Feature retired.

HosEventCodeDiagnosticsbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Diagnostic" event type

Value	Description
-1 Deprecated	Unknown duty status Feature retired.
1 Deprecated	An ELD malfunction logged Feature retired.
2 Deprecated	An ELD malfunction cleared Feature retired.
3 Deprecated	A data diagnostic event logged Feature retired.
4 Deprecated	An data diagnostic event cleared Feature retired.

HosEventCodeDutyStatussbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Duty Status" event type

Value	Description
-1 Deprecated	Unknown duty status Feature retired.
1 Deprecated	Driver's duty status changed to "Off-duty" Feature retired.
2 Deprecated	Driver's duty status changed to "Sleeper Berth" Feature retired.
3 Deprecated	Driver's duty status changed to "Driving" Feature retired.
4 Deprecated	Driver's duty status changed to "On-duty not driving" Feature retired.
5 Deprecated	Waiting status is an Off-duty for some cases in Oil and Gas cycle. Feature retired.

HosEventCodeEnginePowersbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Engine Power" event type

Value	Description
-1 Deprecated	Unknown duty status Feature retired.
1 Deprecated	Engine power-up with conventional location precision Feature retired.
2 Deprecated	Engine power-up with reduced location precision Feature retired.
3 Deprecated	Engine shut-down with conventional location precision Feature retired.
4 Deprecated	Engine shut-down with reduced location precision Feature retired.

HosEventCodeIntermediatesbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Intermediate" event type

Value	Description
-1 Deprecated	Unknown Feature retired.
1 Deprecated	Intermediate log with conventional location precision Feature retired.
2 Deprecated	Intermediate log with reduced location precision Feature retired.

HosEventCodeLoginsbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Login" event type

Value	Description
-1 Deprecated	Unknown Feature retired.
1 Deprecated	Authenticated driver's ELD login activity Feature retired.
2 Deprecated	Authenticated driver's ELD logout activity Feature retired.

HosEventCodeOthersbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated in "Other" event type

Value	Description
-1 Deprecated	Unknown Feature retired.
0 Deprecated	Driver indication for PC, YM and WT cleared Feature retired.
1 Deprecated	Driver indicates "Authorized Personal use of CMV" Feature retired.
2 Deprecated	Driver indicates Yard moves" Feature retired.

HosEventCodeZoneChangedbytenumber Deprecated: Feature retired.

Specifies the nature of the change indicated for "Canadian zone changed" event type

Value	Description
1 Deprecated	Operating zone set to "south of latitude 60Â°N in Canada" Feature retired.
2 Deprecated	Operating zone set to "north of latitude 60Â°N in Canada" Feature retired.
3 Deprecated	Operating zone set to "United States" Feature retired.

HosEventOriginbytenumber Deprecated: Feature retired.

Indicates where the event was generated.

Value	Description
1 Deprecated	Automatically recorded by ELD Feature retired.
2 Deprecated	Entered or edited by driver Feature retired.
3 Deprecated	Edit requested by an authenticated user other than driver Feature retired.
4 Deprecated	Assumed from unidentified driver profile Feature retired.

HosEventStatusbytenumber Deprecated: Feature retired.

Event record status

Value	Description
1 Deprecated	Active Feature retired.
2 Deprecated	Inactive - changed Feature retired.
3 Deprecated	Inactive - change requested Feature retired.
4 Deprecated	Inactive - change rejected Feature retired.

HosEventTypebytenumber Deprecated: Feature retired.

Event record type

Value	Description
1 Deprecated	A change in driver's duty-status. Feature retired.
2 Deprecated	An intermediate log Feature retired.
3 Deprecated	A change in driver's indication of authorized personal use of CMV or yard moves. Feature retired.
4 Deprecated	A driver's certification/re-certification of records. Feature retired.
5 Deprecated	A driver's login/logout activity. Feature retired.
6 Deprecated	CMV's engine power up/shutdown activity. Feature retired.
7 Deprecated	A malfunction or data diagnostic detection occurence. Feature retired.
20 Deprecated	Canadian cycle off-duty hours deferred. Feature retired.
21 Deprecated	Canadian cycle changed. Feature retired.
22 Deprecated	Canadian cycle operating zone changed. Feature retired.
23 Deprecated	Canadian cycle additional hours not recorded. Feature retired.

HosInspectionobject Deprecated: Feature retired.

A pre- or post-Trip inspection report.

JSON description

Property	Type	Description
address	StreetAddress	Written address by driver of where the inspection took place
asset	uint64	Always returns a value for the HosInspection.person.
carrier	uint64 see: HosCarrier.id	The carrier information to which this inspection report belongs.
company	uint64 see: Company.id	The company to which this inspection report belongs.
defects	Array.<HosInspectionDefect>	List of all defects
id	uint64	Unique identifier of the inspection reports.
inspectedOn	datetime	When the inspection took place
latlng	LatLng	Coordinates where the inspection took place
odometer	double	Odometer reading of the tractor at the time of the inspection
person	uint64 see: Person.id	Driver who conducted the inspection
processedUtc	datetime	When the was change procesed.
status Deprecated	HosDefectStatus	Status of all defects Feature retired.
technician	string maximum-length: 100	Name of the (optional) technician/mechanic doing work or inspection.
techSigned	datetime	If the defects needed to be addressed by a technician/mechanic, his signature will happen at a different time.
trailers	Array.<string>	Between 0 and 2 trailers being inspected
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
vehicle	uint64 see: Vehicle.id	Tractor being inspected

JSON structure

{
	"address": {
		"city": string,
		"country": string,
		"isToll": boolean,
		"number": string,
		"postal": string,
		"province": string,
		"region": string,
		"street": string
	},
	"asset": number,
	"carrier": number,
	"company": number,
	"defects": [
		{
			"area": string,
			"category": string,
			"description": string,
			"major": [
				string
			],
			"minor": [
				string
			]
		}
	],
	"id": number,
	"inspectedOn": string,
	"latlng": {
		"lat": number,
		"lng": number
	},
	"odometer": number,
	"person": number,
	"processedUtc": string,
	"status": string,
	"technician": string,
	"techSigned": string,
	"trailers": [
		string
	],
	"updated": {
	},
	"v": [
		number
	],
	"vehicle": number
}

HosInspectionDefectobject Deprecated: Feature retired.

Details of a defect found during a trip inspection

JSON description

Property	Type	Description
area Deprecated	HosDefectArea	Shows where a defect was located on the rig. Feature retired.
category	string	The kind of defect
description	string	A text description of the defect.
major	Array.<string>	A list of major flaws as noted for Canadian standards.
minor	Array.<string>	A list of minor flaws as noted for Canadian standards.

JSON structure

{
	"area": string,
	"category": string,
	"description": string,
	"major": [
		string
	],
	"minor": [
		string
	]
}

HosInspectionDeletedobject Deprecated: Feature retired.

The message format for when a deleted HosInspection is retrieved

JSON description

Property	Type	Value	Description
asset	uint64		Always returns a value for the HosInspection.person.
company	uint64 see: Company.id		The company to which this inspection report belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of the inspection reports.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

HosMalfunctionCodestring Deprecated: Feature retired.

Compliance Malfunction events

Value	Description
E	Engine synchronization compliance malfunction
L	Positioning compliance malfunction
O	Other ELD detected malfunction
P	Power compliance malfunction
R	Data recording compliance malfunction
S	Data transfer compliance malfunction
T	Timing compliance malfunction

HosViolationTypestring Deprecated: Feature retired.

Violations

Value	Description
break_24 Deprecated	24 Hour Break Required Feature retired.
break_30 Deprecated	30 Minute Break Required Feature retired.
consecutive_off_8 Deprecated	Daily 8 Consecutive Hours Off Duty Required Feature retired.
cycle_112 Deprecated	112 Hour Cycle Limit Feature retired.
cycle_120 Deprecated	120 Hour Cycle Limit Feature retired.
cycle_60 Deprecated	60 Hour Cycle Limit Feature retired.
cycle_70 Deprecated	70 Hour Cycle Limit Feature retired.
cycle_80 Deprecated	80 Hour Cycle Limit Feature retired.
cycle_switching_36 Deprecated	36 Hours Break Required for Cycle Switching Feature retired.
cycle_switching_72 Deprecated	72 Hours Break Required for Cycle Switching Feature retired.
daily_break_10 Deprecated	Daily 10 Hour Off-Duty Required Feature retired.
daily_break_8 Deprecated	Daily 8 Hour Off-Duty Required Feature retired.
daily_driving_13 Deprecated	Daily 13 Hour Driving Limit Feature retired.
daily_duty_14 Deprecated	Daily 14 Hour On-Duty Limit Feature retired.
deferred_break_10 Deprecated	10 Consecutive Hours Off Duty Required on Day 2 Feature retired.
deferred_break_12 Deprecated	Off Duty Time Insufficient on Day 2 Feature retired.
driving_10 Deprecated	10 Hour Driving Limit Feature retired.
driving_11 Deprecated	11 Hour Driving Limit Feature retired.
driving_13 Deprecated	13 Hour Driving Limit Feature retired.
driving_15 Deprecated	15 Hour Driving Limit Feature retired.
duty_14 Deprecated	14 Hour Shift Limit Feature retired.
duty_15 Deprecated	15 Hour On-Duty Limit Feature retired.
duty_16 Deprecated	16 Hour Shift Limit Feature retired.
duty_18 Deprecated	18 Hour Shift Limit Feature retired.
duty_20 Deprecated	20 Hour Shift Limit Feature retired.
none Deprecated	No violation Feature retired.
oil_break_24 Deprecated	3 periods of 24 Hour Break Required Feature retired.

Maintenance

MaintenanceIntervalobject

The detail for calculating Maintenance Schedule recurrence.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The Vehicle or Trailer to which this recurrence detail belongs.
date	datetime	The date of the last calculation.
engineHours	double	The operating time at the time of the last calculation.
lastJob	uint64	The last "completed" job related to this schedule interval.
odometer	double	The odometer at the time of the last calculation.

JSON structure

{
	"asset": number,
	"date": string,
	"engineHours": number,
	"lastJob": number,
	"odometer": number
}

MaintenanceJobobject

Historical service work performed on a Vehicle or Trailer

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The Vehicle or Trailer to which this job belongs
company	uint64 see: Company.id	The company to which this Vehicle or Trailer belongs
completed	datetime	When was this job created.
cost	double	How much the job cost in dollars.
created	datetime	When was this job created.
duration	timespan	Time it took to complete the job.
engineHours	double?	The operating time at the time of the service.
garage	string maximum-length: 100	The name of the garage or service facility where the work is done.
id	uint64	Unique identifier
name	string maximum-length: 100	The work being done. Like "oil change".
notes	string	Notes about the job. Like "changed the oil and filter".
odometer	double?	The odometer at the time of the service.
pictures	Array.<uint64> see: Picture.id for values see: Picture.id	Images taken while performing the work for reference.
processedUtc	datetime	When the was change procesed.
reference	string maximum-length: 100	A reference code used to track this job
schedule	uint64? see: MaintenanceSchedule.id	The Maintenance Schedule from which this job was created
status	MaintenanceJobStatus	The status of this job.
technician	string maximum-length: 100	The mechanic who performed the work.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"completed": string,
	"cost": number,
	"created": string,
	"duration": string,
	"engineHours": number,
	"garage": string,
	"id": number,
	"name": string,
	"notes": string,
	"odometer": number,
	"pictures": [
		number
	],
	"processedUtc": string,
	"reference": string,
	"schedule": number,
	"status": string,
	"technician": string,
	"updated": {
	},
	"v": [
		number
	]
}

MaintenanceJobDeletedobject

The message format for when a deleted MaintenanceJob is retrieved

JSON description

Property	Type	Value	Description
asset	uint64 see: Asset.id		The Vehicle or Trailer to which this job belongs
company	uint64 see: Company.id		The company to which this Vehicle or Trailer belongs
deleted	boolean	`true`
id	uint64		Unique identifier
name	string maximum-length: 100		The work being done. Like "oil change".
notes	string		Notes about the job. Like "changed the oil and filter".
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

MaintenanceJobStatusstring

The lifetime of a Maintenance Job

Value	Description
cancelled	The job was cancelled or was not necessary.
completed	Work is completed.
pastdue	The work was scheduled, but not yet done.
pending	The work will need to be performed soon.

MaintenanceScheduleobject

Recurring service work

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this schedule belongs
cost	double	The estimated cost for the job cost in dollars.
duration	timespan	The estimated time for the job.
fill	colour maximum-length: 22	The fill/background colour of the icon.
garage	string maximum-length: 100	The name of the garage or service facility where the work is done.
graphic	codified maximum-length: 22	The name of the symbol for this schedule.
id	uint64	Unique identifier
intervals	Object.<uint64, MaintenanceInterval> for keys see: Asset.id	The per-asset details calculated by the system to help predict the creation of Maintenance Jobs.
name	string maximum-length: 100	The name of the work to be done. Like "oil change".
notes	string	Notes about the work to be done. Like "change the oil and oil filter".
notify	Array.<email> for values see: User.login	List of Users to send notifications.
predictionDays	uint32	The number of days in advance to predict a job will become pending.
processedUtc	datetime	When the was change procesed.
recurDays	uint32?	The number of days between service visits.
recurDistance	double?	The amount of mileage between service visits.
recurEngineHours	double?	The number of operating hours between service visits.
reference	string maximum-length: 100	A reference code used to track this job
stroke	colour maximum-length: 22	Outline and graphic colour.
targets	expression	The targeting expression to select which Vehicles and Trailers require this maintenance work.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"cost": number,
	"duration": string,
	"fill": string,
	"garage": string,
	"graphic": string,
	"id": number,
	"intervals": {
		string: {
			"asset": number,
			"date": string,
			"engineHours": number,
			"lastJob": number,
			"odometer": number
		}
	},
	"name": string,
	"notes": string,
	"notify": [
		string
	],
	"predictionDays": number,
	"processedUtc": string,
	"recurDays": number,
	"recurDistance": number,
	"recurEngineHours": number,
	"reference": string,
	"stroke": string,
	"targets": string,
	"updated": {
	},
	"v": [
		number
	]
}

MaintenanceScheduleDeletedobject

The message format for when a deleted MaintenanceSchedule is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this schedule belongs
deleted	boolean	`true`
id	uint64		Unique identifier
name	string maximum-length: 100		The name of the work to be done. Like "oil change".
notes	string		Notes about the work to be done. Like "change the oil and oil filter".
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ParamMaintenanceJobBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceJobs	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceJobs": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamMaintenanceJobBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceJobs	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceJobs": [
		{
			"asset": number,
			"completed": string,
			"cost": number,
			"created": string,
			"duration": string,
			"engineHours": number,
			"garage": string,
			"id": number,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"reference": string,
			"schedule": number,
			"status": string,
			"technician": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamMaintenanceJobDeleteBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceJob	ParamId	always	An object to contain the "id" of the MaintenanceJob.
maintenanceJob.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceJob": {
		"id": number
	},
	"reqId": number
}

ParamMaintenanceJobGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted MaintenanceJob.
maintenanceJob	ParamId	always		An object to contain the "id" of the MaintenanceJob.
maintenanceJob.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"maintenanceJob": {
		"id": number
	},
	"reqId": number
}

ParamMaintenanceJobListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
pending	boolean	optional		Optional parameter to including pending/past-due MaintenanceJobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"pending": boolean,
	"reqId": number
}

ParamMaintenanceJobListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
pending	boolean	optional		Optional parameter to including pending/past-due MaintenanceJobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"pending": boolean,
	"reqId": number
}

ParamMaintenanceJobListByScheduleBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
maintenanceSchedule	ParamId	always		An object to contain the "id" of the MaintenanceSchedule.
maintenanceSchedule.id	uint64	always		Identifier given as input for the command.
pending	boolean	optional		Optional parameter to including pending/past-due MaintenanceJobs.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"maintenanceSchedule": {
		"id": number
	},
	"pending": boolean,
	"reqId": number
}

ParamMaintenanceJobMergeBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceJob	Object.<string, ?>	always	A simple object to contain the MaintenanceJob parameters.
maintenanceJob.asset	uint64?	create	The identifier of the Asset to which this MaintenanceJob is assigned.
maintenanceJob.completed	datetime	optional	When was this MaintenanceJob created.
maintenanceJob.cost	double?	optional	How much the MaintenanceJob cost in dollars.
maintenanceJob.created	datetime	optional	When was this MaintenanceJob created.
maintenanceJob.duration	timespan	optional	Time it took to complete the MaintenanceJob.
maintenanceJob.engineHours	double?	optional	The operating time at the time of the service.
maintenanceJob.garage	string maximum-length: 100	optional	The name of the garage or service facility where the work is done.
maintenanceJob.id	uint64?	update	The unique identifier of the MaintenanceJob you want to update.
maintenanceJob.name	string maximum-length: 100	create	The work being done. Like "oil change".
maintenanceJob.notes	string	optional	Notes about the MaintenanceJob. Like "changed the oil and filter".
maintenanceJob.odometer	double?	optional	The odometer at the time of the service.
maintenanceJob.pictures	Array.<uint64> for values see: Picture.id	optional	Pictures taken while performing the work for reference.
maintenanceJob.reference	string maximum-length: 100	optional	A reference code used to track this MaintenanceJob.
maintenanceJob.schedule	uint64? see: MaintenanceSchedule.id	optional	The MaintenanceSchedule from which this job was created
maintenanceJob.status	MaintenanceJobStatus?	optional	The status of this MaintenanceJob.
maintenanceJob.technician	string maximum-length: 100	optional	The mechanic who performed the work.
maintenanceJob.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceJob": {
		"asset": number,
		"completed": string,
		"cost": number,
		"created": string,
		"duration": string,
		"engineHours": number,
		"garage": string,
		"id": number,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"reference": string,
		"schedule": number,
		"status": string,
		"technician": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamMaintenanceJobRestoreBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceJob	ParamId	always	An object to contain the "id" of the MaintenanceJob.
maintenanceJob.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceJob": {
		"id": number
	},
	"reqId": number
}

ParamMaintenanceScheduleBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceSchedules	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceSchedules": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamMaintenanceScheduleBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceSchedules	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceSchedules": [
		{
			"company": number,
			"cost": number,
			"duration": string,
			"fill": string,
			"garage": string,
			"graphic": string,
			"id": number,
			"intervals": {
				string: {
					"asset": number,
					"date": string,
					"engineHours": number,
					"lastJob": number,
					"odometer": number
				}
			},
			"name": string,
			"notes": string,
			"notify": [
				string
			],
			"predictionDays": number,
			"recurDays": number,
			"recurDistance": number,
			"recurEngineHours": number,
			"reference": string,
			"stroke": string,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamMaintenanceScheduleDeleteBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceSchedule	ParamId	always	An object to contain the "id" of the MaintenanceSchedule.
maintenanceSchedule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceSchedule": {
		"id": number
	},
	"reqId": number
}

ParamMaintenanceScheduleGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted MaintenanceSchedule.
maintenanceSchedule	ParamId	always		An object to contain the "id" of the MaintenanceSchedule.
maintenanceSchedule.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"maintenanceSchedule": {
		"id": number
	},
	"reqId": number
}

ParamMaintenanceScheduleListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamMaintenanceScheduleMergeBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceSchedule	Object.<string, ?>	always	A simple object to contain the MaintenanceSchedule parameters.
maintenanceSchedule.company	uint64?	optional	The company to which this MaintenanceSchedule. After creation, this value is read-only.
maintenanceSchedule.cost	double?	optional	The estimated cost for the created MaintenanceJob cost in dollars.
maintenanceSchedule.duration	timespan	optional	The estimated time for the created MaintenanceJob.
maintenanceSchedule.fill	string maximum-length: 22	optional	The fill/background colour of the icon. Should be a hex colour in the format #RRGGBB.
maintenanceSchedule.garage	string maximum-length: 100	optional	The name of the garage or service facility where the work is done.
maintenanceSchedule.graphic	codified maximum-length: 22	optional	The name of the symbol for this report.
maintenanceSchedule.id	uint64?	update	The unique identifier of the MaintenanceSchedule you want to update.
maintenanceSchedule.intervals	Object.<uint64, MaintenanceInterval>	optional	The per-Asset details calculated by the system to help predict the creation of MaintenanceJobs.
maintenanceSchedule.name	string maximum-length: 100	create	The name of the MaintenanceSchedule.
maintenanceSchedule.notes	string	optional	Notes about the MaintenanceSchedule.
maintenanceSchedule.notify	Array.<email>	optional	List of Users to send notifications.
maintenanceSchedule.predictionDays	uint32?	optional	The number of days in advance to predict a MaintenanceJob will become pending.
maintenanceSchedule.recurDays	uint32?	optional	The number of days between service visits.
maintenanceSchedule.recurDistance	double?	optional	The amount of mileage between service visits.
maintenanceSchedule.recurEngineHours	double?	optional	The number of operating hours between service visits.
maintenanceSchedule.reference	string maximum-length: 100	optional	A reference code used to track this created MaintenanceJob.
maintenanceSchedule.stroke	string maximum-length: 22	optional	Outline and graphic colour. Should be a hex colour in the format #RRGGBB.
maintenanceSchedule.targets	expression	optional	Which Assets are targetted by this MaintenanceSchedule.
maintenanceSchedule.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceSchedule": {
		"company": number,
		"cost": number,
		"duration": string,
		"fill": string,
		"garage": string,
		"graphic": string,
		"id": number,
		"intervals": {
			string: {
				"asset": number,
				"date": string,
				"engineHours": number,
				"lastJob": number,
				"odometer": number
			}
		},
		"name": string,
		"notes": string,
		"notify": [
			string
		],
		"predictionDays": number,
		"recurDays": number,
		"recurDistance": number,
		"recurEngineHours": number,
		"reference": string,
		"stroke": string,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamMaintenanceScheduleRestoreBaseParametersobject

Request description

Property	Type	Required	Description
maintenanceSchedule	ParamId	always	An object to contain the "id" of the MaintenanceSchedule.
maintenanceSchedule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"maintenanceSchedule": {
		"id": number
	},
	"reqId": number
}

RespMaintenanceJobBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJobs	Array.<RespAssetDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJobs": [
		{
			"asset": number,
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceJobBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJobs	Array.<RespIdAsset>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJobs": [
		{
			"asset": number,
			"company": number,
			"id": number
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceJobDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJob	RespAssetDeleted	An object which contains the MaintenanceJob's id, owning Company id, related Asset id, and deleted status.
maintenanceJob.asset	uint64	Identifier of the Asset to which this object belongs.
maintenanceJob.company	uint64	Identifier of the Company to which this object belongs.
maintenanceJob.deleted	boolean	Flag showing if the object is deleted.
maintenanceJob.id	uint64?	Identifier given as input for the command.
maintenanceJob.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJob": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMaintenanceJobGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJob	MaintenanceJob	The requested MaintenanceJob.
maintenanceJob.asset	uint64 see: Asset.id	The Vehicle or Trailer to which this job belongs
maintenanceJob.company	uint64 see: Company.id	The company to which this Vehicle or Trailer belongs
maintenanceJob.completed	datetime	When was this job created.
maintenanceJob.cost	double	How much the job cost in dollars.
maintenanceJob.created	datetime	When was this job created.
maintenanceJob.duration	timespan	Time it took to complete the job.
maintenanceJob.engineHours	double?	The operating time at the time of the service.
maintenanceJob.garage	string maximum-length: 100	The name of the garage or service facility where the work is done.
maintenanceJob.id	uint64	Unique identifier
maintenanceJob.name	string maximum-length: 100	The work being done. Like "oil change".
maintenanceJob.notes	string	Notes about the job. Like "changed the oil and filter".
maintenanceJob.odometer	double?	The odometer at the time of the service.
maintenanceJob.pictures	Array.<uint64> see: Picture.id for values see: Picture.id	Images taken while performing the work for reference.
maintenanceJob.processedUtc	datetime	When the was change procesed.
maintenanceJob.reference	string maximum-length: 100	A reference code used to track this job
maintenanceJob.schedule	uint64? see: MaintenanceSchedule.id	The Maintenance Schedule from which this job was created
maintenanceJob.status	MaintenanceJobStatus	The status of this job.
maintenanceJob.technician	string maximum-length: 100	The mechanic who performed the work.
maintenanceJob.updated		by: login, from: monster
maintenanceJob.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJob": {
		"asset": number,
		"company": number,
		"completed": string,
		"cost": number,
		"created": string,
		"duration": string,
		"engineHours": number,
		"garage": string,
		"id": number,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"schedule": number,
		"status": string,
		"technician": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMaintenanceJobListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of MaintenanceJobs belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJobs	Array.<MaintenanceJob>	The list of requested MaintenanceJobs.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJobs": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"cost": number,
			"created": string,
			"duration": string,
			"engineHours": number,
			"garage": string,
			"id": number,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"schedule": number,
			"status": string,
			"technician": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceJobListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of MaintenanceJobs belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJobs	Array.<MaintenanceJob>	The list of requested MaintenanceJobs.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJobs": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"cost": number,
			"created": string,
			"duration": string,
			"engineHours": number,
			"garage": string,
			"id": number,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"schedule": number,
			"status": string,
			"technician": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceJobListByScheduleBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJobs	Array.<MaintenanceJob>	The list of requested MaintenanceJobs.
maintenanceSchedule	RespIdCompany	An object to contain the "id" of the MaintenanceSchedule to which the array of MaintenanceJobs belong.
maintenanceSchedule.company	uint64	Identifier of the Company to which this object belongs.
maintenanceSchedule.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJobs": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"cost": number,
			"created": string,
			"duration": string,
			"engineHours": number,
			"garage": string,
			"id": number,
			"name": string,
			"notes": string,
			"odometer": number,
			"pictures": [
				number
			],
			"processedUtc": string,
			"reference": string,
			"schedule": number,
			"status": string,
			"technician": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"maintenanceSchedule": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespMaintenanceJobMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJob	RespIdAsset	An object which contains the "id", "asset", and "company" keys.
maintenanceJob.asset	uint64	Identifier of the Asset to which this object belongs
maintenanceJob.company	uint64	Identifier of the Company to which this object belongs.
maintenanceJob.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJob": {
		"asset": number,
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespMaintenanceJobRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceJob	RespAssetDeleted	An object which contains the MaintenanceJob's id, owning Company id, related Asset id, and deleted status.
maintenanceJob.asset	uint64	Identifier of the Asset to which this object belongs.
maintenanceJob.company	uint64	Identifier of the Company to which this object belongs.
maintenanceJob.deleted	boolean	Flag showing if the object is deleted.
maintenanceJob.id	uint64?	Identifier given as input for the command.
maintenanceJob.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceJob": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedules	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedules": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedules	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedules": [
		{
			"company": number,
			"id": number
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedule	RespDeleted	An object which contains the MaintenanceSchedule's unique identifier and deleted status.
maintenanceSchedule.company	uint64	Identifier of the Company to which this object belongs.
maintenanceSchedule.deleted	boolean	Flag showing if the object is deleted.
maintenanceSchedule.id	uint64?	Identifier given as input for the command.
maintenanceSchedule.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedule	MaintenanceSchedule	The requested MaintenanceSchedule.
maintenanceSchedule.company	uint64 see: Company.id	The company to which this schedule belongs
maintenanceSchedule.cost	double	The estimated cost for the job cost in dollars.
maintenanceSchedule.duration	timespan	The estimated time for the job.
maintenanceSchedule.fill	colour maximum-length: 22	The fill/background colour of the icon.
maintenanceSchedule.garage	string maximum-length: 100	The name of the garage or service facility where the work is done.
maintenanceSchedule.graphic	codified maximum-length: 22	The name of the symbol for this schedule.
maintenanceSchedule.id	uint64	Unique identifier
maintenanceSchedule.intervals	Object.<uint64, MaintenanceInterval> for keys see: Asset.id	The per-asset details calculated by the system to help predict the creation of Maintenance Jobs.
maintenanceSchedule.name	string maximum-length: 100	The name of the work to be done. Like "oil change".
maintenanceSchedule.notes	string	Notes about the work to be done. Like "change the oil and oil filter".
maintenanceSchedule.notify	Array.<email> for values see: User.login	List of Users to send notifications.
maintenanceSchedule.predictionDays	uint32	The number of days in advance to predict a job will become pending.
maintenanceSchedule.processedUtc	datetime	When the was change procesed.
maintenanceSchedule.recurDays	uint32?	The number of days between service visits.
maintenanceSchedule.recurDistance	double?	The amount of mileage between service visits.
maintenanceSchedule.recurEngineHours	double?	The number of operating hours between service visits.
maintenanceSchedule.reference	string maximum-length: 100	A reference code used to track this job
maintenanceSchedule.stroke	colour maximum-length: 22	Outline and graphic colour.
maintenanceSchedule.targets	expression	The targeting expression to select which Vehicles and Trailers require this maintenance work.
maintenanceSchedule.updated		by: login, from: monster
maintenanceSchedule.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedule": {
		"company": number,
		"cost": number,
		"duration": string,
		"fill": string,
		"garage": string,
		"graphic": string,
		"id": number,
		"intervals": {
			string: {
				"asset": number,
				"date": string,
				"engineHours": number,
				"lastJob": number,
				"odometer": number
			}
		},
		"name": string,
		"notes": string,
		"notify": [
			string
		],
		"predictionDays": number,
		"processedUtc": string,
		"recurDays": number,
		"recurDistance": number,
		"recurEngineHours": number,
		"reference": string,
		"stroke": string,
		"targets": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of MaintenanceSchedules belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedules	Array.<MaintenanceSchedule>	The list of requested MaintenanceSchedules.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedules": [
		{
			"company": number,
			"cost": number,
			"duration": string,
			"fill": string,
			"garage": string,
			"graphic": string,
			"id": number,
			"intervals": {
				string: {
					"asset": number,
					"date": string,
					"engineHours": number,
					"lastJob": number,
					"odometer": number
				}
			},
			"name": string,
			"notes": string,
			"notify": [
				string
			],
			"predictionDays": number,
			"processedUtc": string,
			"recurDays": number,
			"recurDistance": number,
			"recurEngineHours": number,
			"reference": string,
			"stroke": string,
			"targets": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedule	RespIdCompany	An object which contains the "id" and "company" keys.
maintenanceSchedule.company	uint64	Identifier of the Company to which this object belongs.
maintenanceSchedule.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedule": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespMaintenanceScheduleRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
maintenanceSchedule	RespDeleted	An object which contains the MaintenanceSchedule's unique identifier and deleted status.
maintenanceSchedule.company	uint64	Identifier of the Company to which this object belongs.
maintenanceSchedule.deleted	boolean	Flag showing if the object is deleted.
maintenanceSchedule.id	uint64?	Identifier given as input for the command.
maintenanceSchedule.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"maintenanceSchedule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

Messaging

AlertPrioritystring

The priority of the alert.

Value	Description
high	Sends before low and normal priority alerts.
low	Sends when no other alerts are pending in the queue.
normal	Sends in when there are no high priority alerts in the queue.

AssetAlertobject

An automatically generated notification sent to a user by the system.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this message relates.
body	string	The main contents of the memo.
company	uint64 see: Company.id	The company to which this memo belongs.
delivered	datetime	Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
from	string maximum-length: 254 minimum-length: 6	Sender address
id	uint64	Unique identifier of this memo.
kind	MessageType	Protocol type
priority	AlertPriority	The priority for which this message must send.
processed	datetime	Date/time stamp of when the memo was processed.
processedUtc	datetime	When the was change procesed.
status	MessageStatus	Lifetime status
subject	string maximum-length: 100	The subject of this message.
to	string maximum-length: 254 minimum-length: 6	Recipient address
updated		by: login, from: monster
user	email see: User.login maximum-length: 254	The user who sent/received this message.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"body": string,
	"company": number,
	"delivered": string,
	"from": string,
	"id": number,
	"kind": string,
	"priority": string,
	"processed": string,
	"processedUtc": string,
	"status": string,
	"subject": string,
	"to": string,
	"updated": {
	},
	"user": string,
	"v": [
		number
	]
}

AssetAlertDeletedobject

The message format for when a deleted AssetAlert is retrieved

JSON description

Property	Type	Value	Description
asset	uint64 see: Asset.id		The asset to which this message relates.
company	uint64 see: Company.id		The company to which this memo belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this memo.
kind	MessageType		Protocol type
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"since": string,
	"v": [
		number
	]
}

AssetMessageobject

A conversational message between users and assets.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this message relates.
body	string	The main contents of the memo.
company	uint64 see: Company.id	The company to which this memo belongs.
delivered	datetime	Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
folder	MessageFolder	The folder under which this message is stored.
from	string maximum-length: 254 minimum-length: 6	Sender address
id	uint64	Unique identifier of this memo.
incoming	boolean	Indicates that this is a received message instead of a sent message.
kind	MessageType	Protocol type
processed	datetime	Date/time stamp of when the memo was processed.
processedUtc	datetime	When the was change procesed.
readBy	email see: User.login maximum-length: 254	The user that read this message. This field is blank/null when unread.
status	MessageStatus	Lifetime status
subject	string maximum-length: 100	The subject of this message.
to	string maximum-length: 254 minimum-length: 6	Recipient address
updated		by: login, from: monster
user	email see: User.login maximum-length: 254	The user who sent/received this message.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"body": string,
	"company": number,
	"delivered": string,
	"folder": string,
	"from": string,
	"id": number,
	"incoming": boolean,
	"kind": string,
	"processed": string,
	"processedUtc": string,
	"readBy": string,
	"status": string,
	"subject": string,
	"to": string,
	"updated": {
	},
	"user": string,
	"v": [
		number
	]
}

AssetMessageDeletedobject

The message format for when a deleted AssetMessage is retrieved

JSON description

Property	Type	Value	Description
asset	uint64 see: Asset.id		The asset to which this message relates.
company	uint64 see: Company.id		The company to which this memo belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this memo.
kind	MessageType		Protocol type
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"since": string,
	"v": [
		number
	]
}

MessageFolderstring

The name of folder where the message is stored.

Value	Description
archive	The archive contains all previous messages, but must be queried from disk for retrieval.
inbox	The inbox is loaded quickly from memory, but messages regularly move to the archive.

MessageStatusstring

Memos have a lifetime and each status represents a memos's progress through it's life.

Value	Description
acknowledged	Memo has been responded to or acknowledged by the recipient.
bounceback	Memo sent, but returned with error from receiving server.
created	Waiting to be sent.
failed	Failed to send.
processed	Sent or received.
throttled	Failed to send because too many memos were sent.

MessageTypestring

The kind of protocol used for this memo.

Value	Description
apn	Apple Push Notification Service
email	Email
gcm	Google Cloud Message
pnd	Garmin/Magellan/etc (Personal Navigation Device)
sms	Short Message Service (text message)
socket	WebSocket alert message
unknown	If the type of memo has not yet been determined, or there was an error determining its type.

ParamAssetMessageBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
assetMessages	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessages": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamAssetMessageBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
assetMessages	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessages": [
		{
			"asset": number,
			"body": string,
			"folder": string,
			"id": number,
			"kind": string,
			"read": boolean,
			"subject": string,
			"to": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamAssetMessageDeleteBaseParametersobject

Request description

Property	Type	Required	Description
assetMessage	ParamId	always	An object to contain the "id" key.
assetMessage.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessage": {
		"id": number
	},
	"reqId": number
}

ParamAssetMessageGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
assetMessage	ParamId	always		An object to contain the "id" key.
assetMessage.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted AssetMessage.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessage": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamAssetMessageListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
folder	MessageFolder	optional		The folder from which to retrieve AssetMessages. Default is MessageFolder.inbox.
includeArchive	boolean	optional
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"folder": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamAssetMessageListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
folder	MessageFolder	optional		The folder from which to retrieve AssetMessages. Default is MessageFolder.inbox.
includeArchive	boolean	optional
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"folder": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamAssetMessageMergeBaseParametersobject

Request description

Property	Type	Required	Description
assetMessage	Object.<string, ?>	always	A simple object to contain the AssetMessage parameters.
assetMessage.asset	uint64?	create	The Asset that this AssetMessage was sent from or to. After creation, this value is read-only.
assetMessage.body	string	create	The body of the AssetMessage. After creation, this value is read-only.
assetMessage.folder	MessageFolder?	optional	The folder where this AssetMessage is stored.
assetMessage.id	uint64?	update	The unique identifier of the AssetMessage you want to update.
assetMessage.kind	MessageType?	create	The kind of protocol used for this AssetMessage. After creation, this value is read-only.
assetMessage.read	boolean	optional	Set to true to log that the AssetMessage was received and read by yourself. Once set, the AssetMessage.readBy value will be your login, and cannot be set by anyone else.
assetMessage.subject	string	optional	The AssetMessage subject field. After creation, this value is read-only. This is used exclusively with MessageType.email type AssetMessages.
assetMessage.to	string	create	Optional to address used when creating the AssetMessage if no messaging address is available. After creation, this value is read-only.
assetMessage.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessage": {
		"asset": number,
		"body": string,
		"folder": string,
		"id": number,
		"kind": string,
		"read": boolean,
		"subject": string,
		"to": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamAssetMessageRestoreBaseParametersobject

Request description

Property	Type	Required	Description
assetMessage	ParamId	always	An object to contain the "id" key.
assetMessage.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"assetMessage": {
		"id": number
	},
	"reqId": number
}

ParamFormResultListByAssetBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamFormResultListByAssetAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
asset	ParamId	always		An object to contain the "id" of the Asset.
asset.id	uint64	always		Identifier given as input for the command.
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: FormResult.labels	optional		A list of label codes used to match FormResults. All labels must match to include a FormResult in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"asset": {
		"id": number
	},
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ParamFormResultListByTemplateBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
formTemplate	ParamId	always		An object to contain the "id" of the FormTemplate.
formTemplate.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"formTemplate": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamFormResultListByTemplateAndLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
formTemplate	ParamId	always		An object to contain the "id" of the FormTemplate.
formTemplate.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: FormResult.labels	optional		A list of label codes used to match FormResults. All labels must match to include a FormResult in the result.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"formTemplate": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"reqId": number
}

ProviderCommandobject

A command sent to a device or GPS modem.

JSON description

Property	Type	Description
body	string	The main contents of the memo.
company	uint64 see: Company.id	The company to which this memo belongs.
delivered	datetime	Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
from	string maximum-length: 254 minimum-length: 6	Sender address
id	uint64	Unique identifier of this memo.
kind	MessageType	Protocol type
processed	datetime	Date/time stamp of when the memo was processed.
processedUtc	datetime	When the was change procesed.
provider	string see: Provider.id maximum-length: 50	The device to which this command was sent.
status	MessageStatus	Lifetime status
to	string maximum-length: 254 minimum-length: 6	Recipient address
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"body": string,
	"company": number,
	"delivered": string,
	"from": string,
	"id": number,
	"kind": string,
	"processed": string,
	"processedUtc": string,
	"provider": string,
	"status": string,
	"to": string,
	"updated": {
	},
	"v": [
		number
	]
}

ProviderCommandDeletedobject

The message format for when a deleted ProviderCommand is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this memo belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this memo.
kind	MessageType		Protocol type
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"since": string,
	"v": [
		number
	]
}

RespAssetMessageBatchDeleteBaseResponseobject

Response description

Property	Type	Description
assetMessages	Array.<RespAssetDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessages": [
		{
			"asset": number,
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageBatchMergeBaseResponseobject

Response description

Property	Type	Description
assetMessages	Array.<RespIdAsset>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessages": [
		{
			"asset": number,
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageDeleteBaseResponseobject

Response description

Property	Type	Description
assetMessage	RespAssetDeleted	An object which contains the AssetMessage's id, owning Company id, and deleted status.
assetMessage.asset	uint64	Identifier of the Asset to which this object belongs.
assetMessage.company	uint64	Identifier of the Company to which this object belongs.
assetMessage.deleted	boolean	Flag showing if the object is deleted.
assetMessage.id	uint64?	Identifier given as input for the command.
assetMessage.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessage": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageGetBaseResponseobject

Response description

Property	Type	Description
assetMessage	AssetMessage	The requested AssetMessage.
assetMessage.asset	uint64 see: Asset.id	The asset to which this message relates.
assetMessage.body	string	The main contents of the memo.
assetMessage.company	uint64 see: Company.id	The company to which this memo belongs.
assetMessage.delivered	datetime	Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
assetMessage.folder	MessageFolder	The folder under which this message is stored.
assetMessage.from	string maximum-length: 254 minimum-length: 6	Sender address
assetMessage.id	uint64	Unique identifier of this memo.
assetMessage.incoming	boolean	Indicates that this is a received message instead of a sent message.
assetMessage.kind	MessageType	Protocol type
assetMessage.processed	datetime	Date/time stamp of when the memo was processed.
assetMessage.processedUtc	datetime	When the was change procesed.
assetMessage.readBy	email see: User.login maximum-length: 254	The user that read this message. This field is blank/null when unread.
assetMessage.status	MessageStatus	Lifetime status
assetMessage.subject	string maximum-length: 100	The subject of this message.
assetMessage.to	string maximum-length: 254 minimum-length: 6	Recipient address
assetMessage.updated		by: login, from: monster
assetMessage.user	email see: User.login maximum-length: 254	The user who sent/received this message.
assetMessage.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessage": {
		"asset": number,
		"body": string,
		"company": number,
		"delivered": string,
		"folder": string,
		"from": string,
		"id": number,
		"incoming": boolean,
		"kind": string,
		"processed": string,
		"processedUtc": string,
		"readBy": string,
		"status": string,
		"subject": string,
		"to": string,
		"updated": {
		},
		"user": string,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of AssetMessages belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
assetMessages	Array.<AssetMessage>	The list of requested AssetMessages.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"assetMessages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageListByCompanyBaseResponseobject

Response description

Property	Type	Description
assetMessages	Array.<AssetMessage>	The list of requested AssetMessages.
company	RespId	An object to contain the "id" of the Company to which the array of AssetMessages belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessages": [
		{
			"asset": number,
			"body": string,
			"company": number,
			"delivered": string,
			"folder": string,
			"from": string,
			"id": number,
			"incoming": boolean,
			"kind": string,
			"processed": string,
			"processedUtc": string,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"updated": {
			},
			"user": string,
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageMergeBaseResponseobject

Response description

Property	Type	Description
assetMessage	RespIdAsset	An object which contains the "id", "company", and "asset" keys when there is no error.
assetMessage.asset	uint64	Identifier of the Asset to which this object belongs
assetMessage.company	uint64	Identifier of the Company to which this object belongs.
assetMessage.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessage": {
		"asset": number,
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetMessageRestoreBaseResponseobject

Response description

Property	Type	Description
assetMessage	RespAssetDeleted	An object which contains the AssetMessage's id, owning Company id, and deleted status.
assetMessage.asset	uint64	Identifier of the Asset to which this object belongs.
assetMessage.company	uint64	Identifier of the Company to which this object belongs.
assetMessage.deleted	boolean	Flag showing if the object is deleted.
assetMessage.id	uint64?	Identifier given as input for the command.
assetMessage.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"assetMessage": {
		"asset": number,
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespFormResultListByAssetBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of FormResults belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespFormResultListByAssetAndLabelsBaseResponseobject

Response description

Property	Type	Description
asset	RespIdCompany	An object to contain the "id" of the Asset to which the array of FormResults belong.
asset.company	uint64	Identifier of the Company to which this object belongs.
asset.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"asset": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespFormResultListByTemplateBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
formTemplate	RespIdCompany	An object to contain the "id" of the FormTemplate to which the array of FormResults belong.
formTemplate.company	uint64	Identifier of the Company to which this object belongs.
formTemplate.id	uint64?	Identifier given as input for the command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"formTemplate": {
		"company": number,
		"id": number
	},
	"message": string,
	"reqId": number
}

RespFormResultListByTemplateAndLabelsBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
formResults	Array.<FormResult>	The list of requested FormResults.
formTemplate	RespIdCompany	An object to contain the "id" of the FormTemplate to which the array of FormResults belong.
formTemplate.company	uint64	Identifier of the Company to which this object belongs.
formTemplate.id	uint64?	Identifier given as input for the command.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"formResults": [
		{
			"asset": number,
			"company": number,
			"completed": string,
			"driver": string,
			"fields": {
				string: string
			},
			"id": number,
			"labels": [
				string
			],
			"latlng": {
				"lat": number,
				"lng": number
			},
			"name": string,
			"notes": string,
			"processedUtc": string,
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"formTemplate": {
		"company": number,
		"id": number
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

Places

ParamPlaceBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
places	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"places": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamPlaceBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
places	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"places": [
		{
			"address": string,
			"anchor": {
				"lat": number,
				"lng": number
			},
			"colour": string,
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"radius": number,
			"reference": string,
			"shape": [
				{
					"lat": number,
					"lng": number
				}
			],
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamPlaceDeleteBaseParametersobject

Request description

Property	Type	Required	Description
place	ParamId	always	An object to contain the "id" of the Place.
place.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"place": {
		"id": number
	},
	"reqId": number
}

ParamPlaceGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Place.
place	ParamId	always		An object to contain the "id" of the Place.
place.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"place": {
		"id": number
	},
	"reqId": number
}

ParamPlaceListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamPlaceListByLabelsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
labels	Array.<string> see: PlaceGeneral.labels	optional		A list of label codes used to match Places. All labels must match to include a Place in the result.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"labels": [
		string
	],
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamPlaceListByRefBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reference	string see: PlaceGeneral.reference	optional		Case-insensitive reference used to match Places.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reference": string,
	"reqId": number
}

ParamPlaceMergeBaseParametersobject

Request description

Property	Type	Required	Description
place	Object.<string, ?>	always	A simple object to contain the Place parameters.
place.address	string	optional	Full street address including province/state, country, and postal/zip code.
place.anchor	LatLng	optional	Central lat/long coordinates. When not present, the shape centre is used for routing.
place.anchor.lat	double	optional	Latitude
place.anchor.lng	double	optional	Longitude
place.colour	colour maximum-length: 22	optional	The fill colour given to this Place for easy visual identification on the map.
place.company	uint64?	create	The Company to which this Place belongs. After creation, this value is read-only.
place.icon	uint64? see: Icon.id	create	The Icon used to display this POI in lists and on the map.
place.id	uint64?	update	The unique identifier of the Place you want to update.
place.kind	PlaceType?	create	The kind of shape being created.
place.labels	Array.<codified> for values see: LabelStyle.code	optional	The codified names of labels
place.name	string maximum-length: 100	create	Name for the Place.
place.notes	string	optional	Notes for the Place.
place.pictures	Array.<uint64> for values see: Picture.id	optional	The identifiers of Pictures of this Place.
place.radius	double?	create (radial)	Boundary threshold (in meters)
place.reference	string maximum-length: 100	optional	A custom field used to refer to an external system.
place.shape	Array.<LatLng>	create (rectangle or polygon)	For a PlaceType.rectangle, the input contains the north east and south west corner coordinates. For a PlaceType.polygon, the input lists all coordinates (oriented as counter-clockwise) needed to draw the geofence.
place.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"place": {
		"address": string,
		"anchor": {
			"lat": number,
			"lng": number
		},
		"colour": string,
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"radius": number,
		"reference": string,
		"shape": [
			{
				"lat": number,
				"lng": number
			}
		],
		"v": [
			number
		]
	},
	"reqId": number
}

ParamPlaceRestoreBaseParametersobject

Request description

Property	Type	Required	Description
place	ParamId	always	An object to contain the "id" of the Place.
place.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"place": {
		"id": number
	},
	"reqId": number
}

Placeobject

A POI (point-of-interest) saved to the system to help determine an asset's real-world position.

JSON description

Property	Type	Description
address	string maximum-length: 200	Full street address including province/state, country, and postal/zip code.
anchor	LatLng	A central point of the shape. This is the exact centre of a PlaceType.radial and PlaceType.point shaped places, and the location of the pin on the map for all types. When routing, PlaceType.polygon and PlaceType.rectangle shapes use the anchor as the location within the place for deliveries.
colour	colour maximum-length: 22	The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this POI belongs.
icon	uint64 see: Icon.id	The icon used to display this POI in lists and on the map.
id	uint64	Unique identifier of this place.
kind	PlaceType	The kind of geography represented by this POI.
labels	Array.<codified> for values see: LabelStyle.code	The codified names of labels
name	string maximum-length: 100	POI's common name instead of street address.
notes	string	Notes!
pictures	Array.<uint64> for values see: Picture.id	Images of this POI.
processedUtc	datetime	When the was change procesed.
radius	double?	This member is only present for PlaceType.radial shapes, and is the radius in meters from the centre anchor.
reference	string maximum-length: 100	A custom field used to refer to an external system.
shape	Array.<LatLng>	The geography representing this POI for rectangle and polygon shape types. For PlaceType.radial and PlaceType.point shape types, the shape key is not present. For a PlaceType.rectangle, the array contains the north east and south west corner coordinates. For a PlaceType.polygon, the array lists all coordinates (oriented as counter-clockwise) needed to draw the geofence.
updated		by: login, from: monster
v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the general properties
v[1]	int32	The second element is not used

JSON structure

{
	"address": string,
	"anchor": {
		"lat": number,
		"lng": number
	},
	"colour": string,
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"processedUtc": string,
	"radius": number,
	"reference": string,
	"shape": [
		{
			"lat": number,
			"lng": number
		}
	],
	"updated": {
	},
	"v": [
		number
	]
}

PlaceDeletedobject

The message format for when a deleted Place is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this POI belongs.
deleted	boolean	`true`
icon	uint64 see: Icon.id		The icon used to display this POI in lists and on the map.
id	uint64		Unique identifier of this POI.
kind	PlaceType		The kind of geography represented by this POI.
labels	Array.<codified> for values see: LabelStyle.code		The codified names of labels
name	string maximum-length: 100		POI's common name instead of street address.
notes	string		Notes!
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

PlaceGeneralobject

A POI (point-of-interest) saved to the system to help determine an asset's real-world position.

JSON description

Property	Type	Description
address	string maximum-length: 200	Full street address including province/state, country, and postal/zip code.
anchor	LatLng	A central point of the shape. This is the exact centre of a PlaceType.radial and PlaceType.point shaped places, and the location of the pin on the map for all types. When routing, PlaceType.polygon and PlaceType.rectangle shapes use the anchor as the location within the place for deliveries.
colour	colour maximum-length: 22	The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB)
company	uint64 see: Company.id	The company to which this POI belongs.
icon	uint64 see: Icon.id	The icon used to display this POI in lists and on the map.
id	uint64	Unique identifier of this POI.
kind	PlaceType	The kind of geography represented by this POI.
labels	Array.<codified> for values see: LabelStyle.code	The codified names of labels
name	string maximum-length: 100	POI's common name instead of street address.
notes	string	Notes!
pictures	Array.<uint64> for values see: Picture.id	Images of this POI.
processedUtc	datetime	When the was change procesed.
radius	double?	This member is only present for PlaceType.radial shapes, and is the radius in meters from the centre anchor.
reference	string maximum-length: 100	A custom field used to refer to an external system.
shape	Array.<LatLng>	The geography representing this POI for rectangle and polygon shape types. For PlaceType.radial and PlaceType.point shape types, the shape key is not present. For a PlaceType.rectangle, the array contains the north east and south west corner coordinates. For a PlaceType.polygon, the array lists all coordinates (oriented as counter-clockwise) needed to draw the geofence.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"address": string,
	"anchor": {
		"lat": number,
		"lng": number
	},
	"colour": string,
	"company": number,
	"icon": number,
	"id": number,
	"kind": string,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"pictures": [
		number
	],
	"processedUtc": string,
	"radius": number,
	"reference": string,
	"shape": [
		{
			"lat": number,
			"lng": number
		}
	],
	"updated": {
	},
	"v": [
		number
	]
}

PlaceTypestring

The types of geography the system supports

Value	Description
point	A lat/long coordinate pair. Places of this type do not contain the Place.radius or Place.shape keys.
polygon	The Place.shape is an array of lat/long coordinates used to create a boundary. Places of this type do not contain the Place.radius key.
radial	Defined as a radius around a lat/long pair used to create a circular boundary. Places of this type do not contain the Place.shape key.
rectangle	The Place.shape is an array of two lat/long coordinates defined as north-east and south-west corners. Places of this type do not contain the Place.radius key.

RespPlaceBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
places	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"places": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespPlaceBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
places	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"places": [
		{
			"company": number,
			"id": number
		}
	],
	"reqId": number
}

RespPlaceDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
place	RespDeleted	An object which contains the place's id, owning company id, and deleted status.
place.company	uint64	Identifier of the Company to which this object belongs.
place.deleted	boolean	Flag showing if the object is deleted.
place.id	uint64?	Identifier given as input for the command.
place.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"place": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespPlaceGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
place	Place	The requested Place.
place.address	string maximum-length: 200	Full street address including province/state, country, and postal/zip code.
place.anchor	LatLng	A central point of the shape. This is the exact centre of a PlaceType.radial and PlaceType.point shaped places, and the location of the pin on the map for all types. When routing, PlaceType.polygon and PlaceType.rectangle shapes use the anchor as the location within the place for deliveries.
place.anchor.lat	double	Latitude
place.anchor.lng	double	Longitude
place.colour	colour maximum-length: 22	The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB)
place.company	uint64 see: Company.id	The company to which this POI belongs.
place.icon	uint64 see: Icon.id	The icon used to display this POI in lists and on the map.
place.id	uint64	Unique identifier of this place.
place.kind	PlaceType	The kind of geography represented by this POI.
place.labels	Array.<codified> for values see: LabelStyle.code	The codified names of labels
place.name	string maximum-length: 100	POI's common name instead of street address.
place.notes	string	Notes!
place.pictures	Array.<uint64> for values see: Picture.id	Images of this POI.
place.processedUtc	datetime	When the was change procesed.
place.radius	double?	This member is only present for PlaceType.radial shapes, and is the radius in meters from the centre anchor.
place.reference	string maximum-length: 100	A custom field used to refer to an external system.
place.shape	Array.<LatLng>	The geography representing this POI for rectangle and polygon shape types. For PlaceType.radial and PlaceType.point shape types, the shape key is not present. For a PlaceType.rectangle, the array contains the north east and south west corner coordinates. For a PlaceType.polygon, the array lists all coordinates (oriented as counter-clockwise) needed to draw the geofence.
place.updated		by: login, from: monster
place.v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
place.v[0]	int32	The first element is for the general properties
place.v[1]	int32	The second element is not used
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"place": {
		"address": string,
		"anchor": {
			"lat": number,
			"lng": number
		},
		"colour": string,
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"radius": number,
		"reference": string,
		"shape": [
			{
				"lat": number,
				"lng": number
			}
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespPlaceListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Places belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
places	Array.<Place>	The list of requested Places.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"places": [
		{
			"address": string,
			"anchor": {
				"lat": number,
				"lng": number
			},
			"colour": string,
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"radius": number,
			"reference": string,
			"shape": [
				{
					"lat": number,
					"lng": number
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespPlaceListByLabelsBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Places belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labels	Array.<string>	The labels given as input.
message	string	An English description of the error.
places	Array.<Place>	The list of requested Places.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"places": [
		{
			"address": string,
			"anchor": {
				"lat": number,
				"lng": number
			},
			"colour": string,
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"radius": number,
			"reference": string,
			"shape": [
				{
					"lat": number,
					"lng": number
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespPlaceListByRefBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Places belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
places	Array.<Place>	The list of requested Places.
reference	string	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"places": [
		{
			"address": string,
			"anchor": {
				"lat": number,
				"lng": number
			},
			"colour": string,
			"company": number,
			"icon": number,
			"id": number,
			"kind": string,
			"labels": [
				string
			],
			"name": string,
			"notes": string,
			"pictures": [
				number
			],
			"processedUtc": string,
			"radius": number,
			"reference": string,
			"shape": [
				{
					"lat": number,
					"lng": number
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reference": string,
	"reqId": number
}

RespPlaceMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
place	RespIdCompany	An object which contains the "id" and "company" keys.
place.company	uint64	Identifier of the Company to which this object belongs.
place.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"place": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespPlaceRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
place	RespDeleted	An object which contains the place's id, owning company id, and deleted status.
place.company	uint64	Identifier of the Company to which this object belongs.
place.deleted	boolean	Flag showing if the object is deleted.
place.id	uint64?	Identifier given as input for the command.
place.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"place": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

Providers and Configurations

ParamProviderAdvancedGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Provider.
provider	ParamIdentifier	always		An object to contain the "id" of the Provider.
provider.id	string	always		The Provider's identifier.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderAdvancedListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended ProviderAdvanceds.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"reqId": number
}

ParamProviderAdvancedListByConfigBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended ProviderAdvanceds.
limit	uint16?	optional		Maximum number of objects in this response.
providerConfig	ParamId	always		An object to contain the "id" of the ProviderConfig/ProviderConfiguration.
providerConfig.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"limit": number,
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providers	Array.<ParamIdentifier>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providers": [
		{
			"id": string
		}
	],
	"reqId": number
}

ParamProviderBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
providers	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providers": [
		{
			"asset": number,
			"config": number,
			"id": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phone": number,
			"pnd": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamProviderBatchReviveBaseParametersobject

Request description

Property	Type	Required	Description
providers	Array.<ParamIdentifier>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providers": [
		{
			"id": string
		}
	],
	"reqId": number
}

ParamProviderBatchSuspendBaseParametersobject

Request description

Property	Type	Required	Description
providers	Array.<ParamIdentifier>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providers": [
		{
			"id": string
		}
	],
	"reqId": number
}

ParamProviderConfigBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerConfigs	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfigs": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamProviderConfigBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerConfigs	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfigs": [
		{
			"company": number,
			"geofences": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: string
			},
			"script": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamProviderConfigDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerConfig	ParamId	always	An object to contain the "id" key.
providerConfig.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Contact.
providerConfig	ParamId	always		An object to contain the "id" key.
providerConfig.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamProviderConfigListByScriptBaseParametersobject

Request description

Property	Type	Required	Default	Description
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
providerScript	ParamId	always		An object to contain the "id" of the Company.
providerScript.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"providerScript": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerConfig	Object.<string, ?>	always	A simple object to contain the ProviderConfig parameters.
providerConfig.company	uint64?	create	The Company to which the ProviderConfig belongs.
providerConfig.geofences	expression	optional	A search pattern used to filter which Places' geometry are used as geofences. Use null or blank string to disable. Use "*" to match all the Places the Provider's Asset can match. Or use "#123456" or "label:term" like other Place search patterns.
providerConfig.id	uint64?	update	The unique identifier of the ProviderConfig you want to update.
providerConfig.name	string maximum-length: 100	create	Name for the ProviderConfig.
providerConfig.notes	string	optional	Notes for the ProviderConfig.
providerConfig.parameters	Object.<string, string>	optional	The values needed to implement the script. Each key in this object is the name of a required script variable.
providerConfig.script	uint64?	create	The ProviderScript to the ProviderConfig implements. After creation, this value is read-only.
providerConfig.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfig": {
		"company": number,
		"geofences": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: string
		},
		"script": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamProviderConfigRestoreBaseParametersobject

Request description

Property	Type	Required	Description
providerConfig	ParamId	always	An object to contain the "id" key.
providerConfig.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigurationBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerConfigurations	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfigurations": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamProviderConfigurationBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerConfigurations	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfigurations": [
		{
			"company": number,
			"geofences": [
				number
			],
			"id": number,
			"name": string,
			"notes": string,
			"scriptParameters": {
				string: Object
			},
			"type": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamProviderConfigurationDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerConfiguration	ParamId	always	An object to contain the "id" key.
providerConfiguration.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfiguration": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigurationGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted ProviderConfiguration.
providerConfiguration	ParamId	always		An object to contain the "id" key.
providerConfiguration.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"providerConfiguration": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigurationListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamProviderConfigurationMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerConfiguration	Object.<string, ?>	always	A simple object to contain the ProviderConfiguration parameters.
providerConfiguration.company	uint64?	create	The Company to which the ProviderConfiguration belongs.
providerConfiguration.geofences	Array.<uint64> for values see: Place.id	optional	A list of Places whose shape is programmed directly onto Providers to raise instant boundary events.
providerConfiguration.id	uint64?	update	The unique identifier of the ProviderConfiguration you want to update.
providerConfiguration.name	string maximum-length: 100	create	Name for the ProviderConfiguration.
providerConfiguration.notes	string	optional	Notes for the ProviderConfiguration.
providerConfiguration.scriptParameters	Object.<string, Object>	optional	The values needed to implement the ProviderConfigurationType. Each key in this object is the identifier of a required ProviderConfigurationNode. This command does not support patch semantics; all keys must be sent if any are sent.
providerConfiguration.type	uint64?	create	The ProviderConfigurationType that the ProviderConfiguration implements. After creation, this value is read-only.
providerConfiguration.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfiguration": {
		"company": number,
		"geofences": [
			number
		],
		"id": number,
		"name": string,
		"notes": string,
		"scriptParameters": {
			string: Object
		},
		"type": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamProviderConfigurationRestoreBaseParametersobject

Request description

Property	Type	Required	Description
providerConfiguration	ParamId	always	An object to contain the "id" key.
providerConfiguration.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfiguration": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigurationTypeGetBaseParametersobject

Request description

Property	Type	Required	Description
providerConfigurationType	ParamId	always	An object to contain the "id" of the ProviderConfigurationType.
providerConfigurationType.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerConfigurationType": {
		"id": number
	},
	"reqId": number
}

ParamProviderConfigurationTypeListBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamProviderConfigurationTypeListByTypeBaseParametersobject

Request description

Property	Type	Required	Default	Description
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
kind	ProviderType	optional		A ProviderType used to filter the list of ProviderConfigurationTypes.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"kind": string,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamProviderDeleteBaseParametersobject

Request description

Property	Type	Required	Description
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderGeneralGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Provider.
provider	ParamIdentifier	always		An object to contain the "id" of the Provider.
provider.id	string	always		The Provider's identifier.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderGeneralListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Providers.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamProviderGeneralListByConfigBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Providers.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
providerConfig	ParamId	always		An object to contain the "id" of the ProviderConfig/ProviderConfiguration.
providerConfig.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"last": string,
	"limit": number,
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Provider.
provider	ParamIdentifier	always		An object to contain the "id" of the Provider.
provider.id	string	always		The Provider's identifier.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Providers.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamProviderListByConfigBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeSuspended	boolean	optional	`true`	When true, the command will also return suspended Providers.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
providerConfig	ParamId	always		An object to contain the "id" of the ProviderConfig/ProviderConfiguration.
providerConfig.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeSuspended": boolean,
	"last": string,
	"limit": number,
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderMergeBaseParametersobject

Request description

Property	Type	Required	Description
provider	Object.<string, ?>	always	A simple object to contain the Provider parameters.
provider.asset	uint64?	optional	A reference to the Asset with which to provide events.
provider.config	uint64?	create	Identifier of the ProviderConfig/ProviderConfiguration this Provider will use.
provider.id	string maximum-length: 50 minimum-length: 10	always	Unique identifier of the Provider.
provider.kind	ProviderType?	create	The type of Provider.
provider.name	string maximum-length: 100	create	A name for the Provider.
provider.notes	string	optional	Notes for this Provider.
provider.password	string	optional	The password required to communicate and program this Provider.
provider.phone	uint64?	optional	The phone number this Provider uses (if known).
provider.pnd	string	optional	The name of the Personal Navigation Device connected to this Provider.
provider.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"provider": {
		"asset": number,
		"config": number,
		"id": string,
		"kind": string,
		"name": string,
		"notes": string,
		"password": string,
		"phone": number,
		"pnd": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamProviderRegistrationBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerRegistrations	Array.<ParamCode>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerRegistrations": [
		{
			"code": string
		}
	],
	"reqId": number
}

ParamProviderRegistrationBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerRegistrations	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerRegistrations": [
		{
			"asset": number,
			"config": number,
			"identifier": string,
			"lifetime": string,
			"name": string,
			"notes": string,
			"password": string,
			"phone": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamProviderRegistrationDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerRegistration	ParamCode	always	An object to contain the "id" of the provider.
providerRegistration.code	string	always	A "code" identifying a resource.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerRegistration": {
		"code": string
	},
	"reqId": number
}

ParamProviderRegistrationGetBaseParametersobject

Request description

Property	Type	Required	Description
providerRegistration	ParamCode	always	An object to contain the "id" of the provider.
providerRegistration.code	string	always	A "code" identifying a resource.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerRegistration": {
		"code": string
	},
	"reqId": number
}

ParamProviderRegistrationListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Companyv.
company.id	uint64	always		Identifier given as input for the command.
highest	int32?	optional		The maximum ProviderRegistration.code when listing from the database.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	int32?	optional		The minimum ProviderRegistration.code when listing from the database.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamProviderRegistrationListByConfigBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Companyv.
company.id	uint64	always		Identifier given as input for the command.
highest	int32?	optional		The maximum ProviderRegistration.code when listing from the database.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	int32?	optional		The minimum ProviderRegistration.code when listing from the database.
providerConfig	ParamId	always		An object to contain the "id" of the ProviderConfig/ProviderConfiguration.
providerConfig.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"providerConfig": {
		"id": number
	},
	"reqId": number
}

ParamProviderRegistrationListByKindBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Companyv.
company.id	uint64	always		Identifier given as input for the command.
highest	int32?	optional		The maximum ProviderRegistration.code when listing from the database.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
kind	ProviderType?	optional		The type of ProviderRegistrations to list.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	int32?	optional		The minimum ProviderRegistration.code when listing from the database.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"kind": string,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamProviderRegistrationMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerRegistration	Object.<string, ?>	always	A simple object to contain the ProviderRegistration parameters.
providerRegistration.asset	uint64?	optional	An optional Asset to which the new Provider will be assigned.
providerRegistration.config	uint64	create	The identifier of the ProviderConfig/ProviderConfiguration that will be loaded onto the new Provider.
providerRegistration.identifier	string see: Provider.id maximum-length: 50	optional	Identifier of the Provider to setup. This is helpful for long-term deployments, but will be overwritten during provisioning.
providerRegistration.lifetime	timespan	optional	The lifetime of the ProviderRegistration. The default value (if not specified) is 10 minutes. It can be specified as up to 2 months to allow for longer deployments.
providerRegistration.name	string maximum-length: 100	optional	A nickname given to the Provider once it has been provisioned.
providerRegistration.notes	string	optional	Notes about the Provider for after it's been programmed.
providerRegistration.password	string maximum-length: 50	optional	The password programmed on the Provider used to ensure the system is the only client authorized to make changes.
providerRegistration.phone	uint64?	optional	If known beforehand, a phone number can be specified for new Providers.
providerRegistration.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerRegistration": {
		"asset": number,
		"config": number,
		"identifier": string,
		"lifetime": string,
		"name": string,
		"notes": string,
		"password": string,
		"phone": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamProviderRestoreBaseParametersobject

Request description

Property	Type	Required	Description
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderReviveBaseParametersobject

Request description

Property	Type	Required	Description
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamProviderScriptBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerScripts	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerScripts": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamProviderScriptBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerScripts	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerScripts": [
		{
			"blocks": [
				{
					"condition": string,
					"content": string,
					"replace": string,
					"validate": string
				}
			],
			"company": number,
			"fill": string,
			"global": boolean,
			"graphic": string,
			"id": number,
			"kind": string,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"advanced": boolean,
					"context": string,
					"notes": string,
					"order": number,
					"type": string,
					"value": string
				}
			},
			"stroke": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamProviderScriptDeleteBaseParametersobject

Request description

Property	Type	Required	Description
providerScript	ParamId	always	An object to contain the "id" of the ProviderScript.
providerScript.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerScript": {
		"id": number
	},
	"reqId": number
}

ParamProviderScriptGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted ProviderScript.
providerScript	ParamId	always		An object to contain the "id" of the ProviderScript.
providerScript.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"providerScript": {
		"id": number
	},
	"reqId": number
}

ParamProviderScriptListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional	`true`	When true (default) the getter to retrieve the given Company's list of ProviderScripts as well as any publicly available ProviderScripts for the Company's parent(s).

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number,
	"tree": boolean
}

ParamProviderScriptMergeBaseParametersobject

Request description

Property	Type	Required	Description
providerScript	Object.<string, ?>	always	A simple object to contain the ProviderScript parameters.
providerScript.blocks	Array.<ProviderScriptBlock> minimum-count of values: 1	create	Blocks of file data which are (optionally) included in the ProviderScript data file.
providerScript.company	uint64?	create	The Company to which this ProviderScript belongs. After creation, this value is read-only.
providerScript.fill	string	optional	Background and fill colour in the UI.
providerScript.global	boolean	optional	Indicates whether this ProviderScript is available to child companies.
providerScript.graphic	string	optional	The name of the symbol shown in the UI.
providerScript.id	uint64?	update	The unique identifier of the ProviderScript you want to update.
providerScript.kind	ProviderType?	create	The type of provider for which this ProviderScript can be used. Limiting to a specific model from a manufacturer is accomplished through the block conditions.
providerScript.name	string maximum-length: 100	optional	Name for the ProviderScript.
providerScript.notes	string	optional	Notes for the ProviderScript.
providerScript.parameters	Object.<string, ProviderScriptParameter>	optional	Parameter definitions for this ProviderScript, including type-hints and default values.
providerScript.stroke	string	optional	Text and outline colour in the UI.
providerScript.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerScript": {
		"blocks": [
			{
				"condition": string,
				"content": string,
				"replace": string,
				"validate": string
			}
		],
		"company": number,
		"fill": string,
		"global": boolean,
		"graphic": string,
		"id": number,
		"kind": string,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"advanced": boolean,
				"context": string,
				"notes": string,
				"order": number,
				"type": string,
				"value": string
			}
		},
		"stroke": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamProviderScriptRestoreBaseParametersobject

Request description

Property	Type	Required	Description
providerScript	ParamId	always	An object to contain the "id" of the ProviderScript.
providerScript.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"providerScript": {
		"id": number
	},
	"reqId": number
}

ParamProviderSuspendBaseParametersobject

Request description

Property	Type	Required	Description
provider	ParamIdentifier	always	An object to contain the "id" of the Provider.
provider.id	string	always	The Provider's identifier.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"provider": {
		"id": string
	},
	"reqId": number
}

ParamSessionBatchKillBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
sessions	Array.<ParamHandle>	optional	Array of parameters successfully parsed by the sub-command.

Request structure

{
	"reqId": number,
	"sessions": [
		{
			"handle": string
		}
	]
}

Providerobject

A device, modem, or service which provides events from the field.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The asset for which this device provides field data.
attributes	Object.<string, Object.<string, ProviderData>> for keys see: ProviderDataGroup for value-keys see: ProviderDataName	Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
company	uint64 see: Company.id	The company to which this device belongs.
configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The provider's current (or pending) configuration profile.
firmware	string maximum-length: 100	The firmware/application version number.
firmwareStatus	ProvisioningStatus	The system's progress of updating the device's firmware/application.
geofenceLast	datetime	A timestamp from when the geofence list was updated by a User or a Provider.
geofenceStatus	ProvisioningStatus	The system's progress of updating the device's on-board geofence definitions.
id	string maximum-length: 50 minimum-length: 10	Unique identifier of this provider.
information	Object.<string, string> for keys see: ProviderDataName	A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
kind	ProviderType	The kind of communication protocol this device uses.
lastCheckIn	datetime	A timestamp from when the provider last checked for a new script or new geofences.
lastIP	ipv4	The last IP address of the device.
name	string maximum-length: 100	A nickname given to the device/hardware.
notes	string	Notes!
password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
phoneNumber	uint64?	The phone number of this device.
pnd	string maximum-length: 50	The short-name of the kind of PND attached to this device. Leave blank if none.
processedUtc	datetime	When the was change procesed.
scriptLast	datetime	A timestamp from when the script status was updated by a User or a Provider.
scriptStatus	ProvisioningStatus	The system's progress of updating the device's programming.
sim	string	ICCID of the SIM card installed in this provider
snf	Object.<string, string>	Store-and-forward information like last sequence number of SnF window
updated		by: login, from: monster
v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the general properties
v[1]	int32	The first element is for the advanced properties

JSON structure

{
	"asset": number,
	"attributes": {
		string: {
			string: {
				"dts": string,
				"unit": string,
				"value": Object
			}
		}
	},
	"company": number,
	"configuration": number,
	"firmware": string,
	"firmwareStatus": string,
	"geofenceLast": string,
	"geofenceStatus": string,
	"id": string,
	"information": {
		string: string
	},
	"kind": string,
	"lastCheckIn": string,
	"lastIP": string,
	"name": string,
	"notes": string,
	"password": string,
	"phoneNumber": number,
	"pnd": string,
	"processedUtc": string,
	"scriptLast": string,
	"scriptStatus": string,
	"sim": string,
	"snf": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

ProviderAdvancedobject

Device/hardware information reported from the field.

JSON description

Property	Type	Description
attributes	Object.<string, Object.<string, ProviderData>> for keys see: ProviderDataGroup for value-keys see: ProviderDataName	Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
company	uint64 see: Company.id	The company to which this device belongs.
id	string see: Provider.id maximum-length: 50 minimum-length: 10	Unique identifier of this device.
lastIP	ipv4	The last IP address of the device.
processedUtc	datetime	When the was change procesed.
snf	Object.<string, string>	Store-and-forward information like last sequence number of SnF window
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"attributes": {
		string: {
			string: {
				"dts": string,
				"unit": string,
				"value": Object
			}
		}
	},
	"company": number,
	"id": string,
	"lastIP": string,
	"processedUtc": string,
	"snf": {
		string: string
	},
	"updated": {
	},
	"v": [
		number
	]
}

ProviderConfigobject

The configured script loaded onto the provider over-the-air to control it's reporting schedule and behaviour.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this configuration belongs.
geofences	expression	A search pattern used to filter which Places' geometry are used as geofences. Use null to disable. Use "*" to match all the Places the Provider's Asset can match. Or use "#123456" or "label:term" like other Place search patterns.
id	uint64	Unique identifier of this configuration.
name	string maximum-length: 100	The nickname given to this configuration
notes	string	Simple details about how the providers are expected to behave.
parameters	Object.<string, string>	The list of defined variable name/value pairs that the script requires.
processedUtc	datetime	When the was change procesed.
script	uint64 see: ProviderScript.id	The script which this configuration implements.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"geofences": string,
	"id": number,
	"name": string,
	"notes": string,
	"parameters": {
		string: string
	},
	"processedUtc": string,
	"script": number,
	"updated": {
	},
	"v": [
		number
	]
}

ProviderConfigDeletedobject

The message format for when a deleted ProviderConfig is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this configuration belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this configuration.
name	string maximum-length: 100		The nickname given to this configuration
notes	string		Simple details about how the providers are expected to behave.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ProviderConfigurationobject Deprecated: Use ProviderConfig instead.

The configured logic loaded onto the provider over-the-air to control it's reporting schedule and behaviour.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this configuration belongs.
geofences	Array.<uint64>	List of Places loaded directly onto the provider.
id	uint64	Unique identifier of this configuration.
name	string maximum-length: 100	The nickname given to this configuration
notes	string	Simple details about how the providers are expected to behave.
processedUtc	datetime	When the was change procesed.
scriptParameters	Object.<string, Object>	The list of defined variables given to the logic type's options pairs for the logic type requires.
type	uint64 see: ProviderConfigurationType.id	The logic type which this configuration implements.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"geofences": [
		number
	],
	"id": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"scriptParameters": {
		string: Object
	},
	"type": number,
	"updated": {
	},
	"v": [
		number
	]
}

ProviderConfigurationDeletedobject Deprecated: Use ProviderConfig instead.

The message format for when a deleted ProviderConfiguration is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this configuration belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this configuration.
name	string maximum-length: 100		The nickname given to this configuration
notes	string		Simple details about how the providers are expected to behave.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ProviderConfigurationNodeobject Deprecated: Use ProviderScriptBlock instead.

This tree-like structure is given to the script processor for the device type so that the device can follow a program.

JSON description

Property	Type	Description
id	string	Unique identifier of the value being mapped.
isAdvanced	boolean	Indicates that this configuration is an advanced property and should only be set by someone who knows what they're doing.
max	Object	The maximum possible value for this confugration node.
min	Object	The minimum possible value for this confugration node.
nodes	Object.<string, ProviderConfigurationNode>	Child configuration nodes.
notes	string	Description of what this configuration does when mapped to a device.
type	string	Type hint used by the script processor to help format the value.
unit	ProviderDataUnit?	Unit hint used to help the script processor format the value.
value	Object	The value being set.

JSON structure

{
	"id": string,
	"isAdvanced": boolean,
	"max": Object,
	"min": Object,
	"nodes": {
		string: { /* recursive ProviderConfigurationNode objects */ }
	},
	"notes": string,
	"type": string,
	"unit": string,
	"value": Object
}

ProviderConfigurationTypeobject Deprecated: Use ProviderScript instead.

This read-only class describes a type of logic applied to a provider. ProviderConfigurationTypes are used to help define a ProviderConfiguration.

JSON description

Property	Type	Description
geofenceTypes	Array.<PlaceType>	A list of supported types of geofences which can be programmed directly onto the device.
id	uint64	Unique identifier.
maxGeofenceCount	uint32	The maximum number of geofences that can be programmed onto a device. This number changes based on device make and model, and can also change based on the supported geofence types.
minGeofenceCount	uint32	The minimum number of geofences that need to be programmed onto the device. This value is almost always zero.
name	string maximum-length: 100	Name of the configuration type.
notes	string	Notes regarding the use of this configuration.
processedUtc	datetime	When the was change procesed.
providerType	ProviderType	The applicable type of provider for which this configuration type can be created.
scriptOptions	Object.<string, ProviderConfigurationNode>	A tree-structure of configurations required (or optionally available) for programming a device.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"geofenceTypes": [
		string
	],
	"id": number,
	"maxGeofenceCount": number,
	"minGeofenceCount": number,
	"name": string,
	"notes": string,
	"processedUtc": string,
	"providerType": string,
	"scriptOptions": {
		string: {
			"id": string,
			"isAdvanced": boolean,
			"max": Object,
			"min": Object,
			"nodes": {
				string: { /* recursive ProviderConfigurationNode objects */ }
			},
			"notes": string,
			"type": string,
			"unit": string,
			"value": Object
		}
	},
	"updated": {
	},
	"v": [
		number
	]
}

ProviderConfigurationTypeDeletedobject Deprecated: Use ProviderScript instead.

The message format for when a deleted ProviderConfigurationType is retrieved

JSON description

Property	Type	Value	Description
deleted	boolean	`true`
id	uint64		Unique identifier.
name	string maximum-length: 100		Name of the configuration type.
notes	string		Notes regarding the use of this configuration.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ProviderDataobject

A fragment of data given by a device.

JSON description

Property	Type	Description
dts	datetime	Date/time stamp from when the device recorded (or reported) the data.
unit	ProviderDataUnit?	The relevant unit for the data provided like Km/h, degrees, volts, RPM, etc...
value	Object	The value of the data given like true, 17.3, "asdf", etc...

JSON structure

{
	"dts": string,
	"unit": string,
	"value": Object
}

ProviderDataGroupstring

Event groups used in ProviderAdvanced.data.

Value	Description
CAMERA	Dashcam picture and video recording events
CELL	Cellular network information.
DISPATCH	Task, clock-in/out, paired vehicle and driver information.
GPS	GPS and location data.
IO	Wiring data.
STATUS	Provider status and sensor data.
VBUS	OBD-II and J-Bus data.

ProviderDataNamestring

The kinds of values given by providers in Provider.attributes[ProviderDataGroup]:ProviderData.

Value	Description
CAMERA
CAMERA_1
CAMERA_2
CAMERA_3
CAMERA_4
TOTAL_CAMERAS
CELL
ACK_BYTES_IN
CELLUAR_IP_ADDRESS
CELLUAR_ROAMING
CELLUAR_SERVICE
CELLUAR_WAN_IP
CELLULAR_CARRIER	MNC (Mobile Network Code)
CELLULAR_COMM_STATE
CELLULAR_COUNTRY	MCC (Mobile Country Code)
CELLULAR_RSRP	Reference Signal Received Power, in dBm (decibel-milliwatts).
CELLULAR_RSRQ	Reference Signal Received Quality, in dB (decibels).
CELLULAR_RSSI	Received Signal Strength Indicator, in dBm. RSSI is a negative value, and the closer to 0, the stronger the signal.
DATA_AGE
DATA_BYTES_IN
DATA_BYTES_OUT
GPR_STATE
GSM_STATE
HOURS_DISCONNECTED_COUNTER
HOURS_ON_COUNTER
PASSTHROUGH_USER_MESSAGE
PASSTHROUGH_USER_MESSAGE_ID
PDP_STATE
PERCENT_LOST_GPRS
PERCENT_LOST_GSM
PERCENT_LOST_PDP
POLICY_FAULT_MESSAGEID
POLICY_FAULT_TEXT
SERVICE_FAULT_MESSAGEID
SERVICE_FAULT_TEXT
SERVICE_RESPONSE
SMS_MSG_IN_COUNTER
SMS_MSG_OUT_COUNTER
SMS_SPAM_MSG_IN_COUNTER
TERMINAL_STATUS
DISPATCH
DISPATCH_TASK	A task is marked as active or "on-route" when the DispatchTask.id is sent.
DRIVER_DRIVING	When the driver changes status to "driving" from another status.
DRIVER_LOGIN	When the driver logs-in the terminal/vehicle.
DRIVER_LOGOFF	When the driver logs-off the terminal/vehicle.
DRIVER_OFFDUTY	When the driver changes status to "off-duty" from another status.
DRIVER_ONDUTY	When the driver changes status to "on-duty" from another status.
DRIVER_SLEEPING	When the driver changes status to "sleeping" from another status.
DRIVER_VEHICLE	When the driver chooses a specific vehicle during the log-in process.
HOS_DRIVER
HOS_IS_CODRIVER
HOS_STATUS
HOS_VEHICLE
HOS_VIOLATION
GPS
COURSE	The heading or bearing over time.
GEOFENCE_ID	ID of violated geofence
GEOFENCE_VIOLATION	Geofence violation types(outside fence violation, inside fence violation)
GPS_ACCELERATION	A virtual accelerometer calculated by the GPS system's positions
GPS_ACCURACY	The approximate accuracy of the GPS fix
GPS_ALTITUDE	Altitude above sea-level
GPS_ANTENNA_STATUS	GPS antenna status could be related to power or unplugged states
GPS_DECELERATION	A virtual accelerometer calculated by the GPS system's positions
GPS_DISTANCE	Distance measured between two GPS fixes
GPS_FIX_STATUS	Status or validity of the GPS fix
GPS_FIX_TIME	Date/time stamp of the most recent GPS fix
GPS_HDOP	Horizontal dilution of precision for 3D fixes
GPS_HEADING	Direction of travel
GPS_LATITUDE	Latitude in decimal degrees
GPS_LONGITUDE	Longitude in decimal degrees
GPS_LOST_TIME	Date/time stamp from when the device lost GPS signal
GPS_ODOMETER	A virtual odometer accumulated by the GPS system's positions
GPS_SATELLITES	The number of satellites used to obtain the GPS fix
GPS_SPEED	Speed measured by GPS fix differentiation
MAGNETIC_VARIATION	Difference in horizontal angle between true north and magnetic north
PERCENT_LOST_GPS	Date/time stamp from when the device lost its precise GPS position
PERCENT_LOST_GPS_QUALITY_FACTOR	Statistical amount of bad GPS data
IO
ACCUMULATOR0
ACCUMULATOR1
ACCUMULATOR10
ACCUMULATOR11
ACCUMULATOR12
ACCUMULATOR13
ACCUMULATOR14
ACCUMULATOR15
ACCUMULATOR16
ACCUMULATOR17
ACCUMULATOR18
ACCUMULATOR19
ACCUMULATOR2
ACCUMULATOR20
ACCUMULATOR21
ACCUMULATOR22
ACCUMULATOR23
ACCUMULATOR24
ACCUMULATOR25
ACCUMULATOR26
ACCUMULATOR27
ACCUMULATOR28
ACCUMULATOR29
ACCUMULATOR3
ACCUMULATOR30
ACCUMULATOR31
ACCUMULATOR32
ACCUMULATOR33
ACCUMULATOR34
ACCUMULATOR35
ACCUMULATOR36
ACCUMULATOR37
ACCUMULATOR38
ACCUMULATOR39
ACCUMULATOR4
ACCUMULATOR40
ACCUMULATOR41
ACCUMULATOR42
ACCUMULATOR43
ACCUMULATOR44
ACCUMULATOR45
ACCUMULATOR46
ACCUMULATOR47
ACCUMULATOR48
ACCUMULATOR49
ACCUMULATOR5
ACCUMULATOR50
ACCUMULATOR51
ACCUMULATOR52
ACCUMULATOR53
ACCUMULATOR54
ACCUMULATOR55
ACCUMULATOR56
ACCUMULATOR57
ACCUMULATOR58
ACCUMULATOR59
ACCUMULATOR6
ACCUMULATOR60
ACCUMULATOR61
ACCUMULATOR62
ACCUMULATOR63
ACCUMULATOR64
ACCUMULATOR7
ACCUMULATOR8
ACCUMULATOR9
ANALOG_INPUT_0	Analog voltage reading from wire zero, or external power voltage, or internal battery voltage
ANALOG_INPUT_1	Analog voltage reading from wire #1
ANALOG_INPUT_10	Analog voltage reading from wire #10
ANALOG_INPUT_11	Analog voltage reading from wire #11
ANALOG_INPUT_2	Analog voltage reading from wire #2
ANALOG_INPUT_3	Analog voltage reading from wire #3
ANALOG_INPUT_4	Analog voltage reading from wire #4
ANALOG_INPUT_5	Analog voltage reading from wire #5
ANALOG_INPUT_6	Analog voltage reading from wire #6
ANALOG_INPUT_7	Analog voltage reading from wire #7
ANALOG_INPUT_8	Analog voltage reading from wire #8
ANALOG_INPUT_9	Analog voltage reading from wire #9
BAROMETRIC_PRESSURE
BATTERY_CAPACITY
BATTERY_LEVEL
DIGITAL_INPUT_0	Digital input wire zero, or external power, or internal battery power
DIGITAL_INPUT_1	Digital input wire #1
DIGITAL_INPUT_10	Digital input wire #10
DIGITAL_INPUT_11	Digital input wire #11
DIGITAL_INPUT_2	Digital input wire #2
DIGITAL_INPUT_3	Digital input wire #3
DIGITAL_INPUT_4	Digital input wire #4
DIGITAL_INPUT_5	Digital input wire #5
DIGITAL_INPUT_6	Digital input wire #6
DIGITAL_INPUT_7	Digital input wire #7
DIGITAL_INPUT_8	Digital input wire #8
DIGITAL_INPUT_9	Digital input wire #9
DIGITAL_INPUT_DTR	Legacy AirLink digital input wire #2
DIGITAL_INPUT_RTS	Legacy AirLink digital input wire #1
DIGITAL_OUTPUT_0	Voltage output wire #0
DIGITAL_OUTPUT_1	Voltage output wire #1
DIGITAL_OUTPUT_10	Voltage output wire #10
DIGITAL_OUTPUT_11	Voltage output wire #99
DIGITAL_OUTPUT_2	Voltage output wire #2
DIGITAL_OUTPUT_3	Voltage output wire #3
DIGITAL_OUTPUT_4	Voltage output wire #4
DIGITAL_OUTPUT_5	Voltage output wire #5
DIGITAL_OUTPUT_6	Voltage output wire #6
DIGITAL_OUTPUT_7	Voltage output wire #7
DIGITAL_OUTPUT_8	Voltage output wire #8
DIGITAL_OUTPUT_9	Voltage output wire #9
EXTERNAL_TEMPERATURE	Temperature measured outside of the modem casing.
GPIO0	Switchable input/output wire zero, or external power, or internal battery
GPIO1	Switchable input/output wire #1
GPIO2	Switchable input/output wire #2
GPIO3	Switchable input/output wire #3
GPIO4	Switchable input/output wire #4
GPIO5	Switchable input/output wire #5
GPIO6	Switchable input/output wire #6
GPIO7	Switchable input/output wire #7
GPIO8	Switchable input/output wire #8
GPIO9	Switchable input/output wire #9
HUMIDITY
INTERNAL_TEMPERATURE	Temperature measured on the mainboard, or inside the modem casing.
LIGHT
TEMPERATURE_SENSOR_1
TEMPERATURE_SENSOR_2
TEMPERATURE_SENSOR_3
TEMPERATURE_SENSOR_4
RFID
TAG_COUNT
TAG_LIST
STATUS,IO
ACCELEROMETER	A virtual accelerometer calculated by the GPS system's positions
MOTION_STATUS	Motion status determined by the GPS speed and ignition
STATUS
APP_ID	Identifier of the application communicating with the service(s).
APP_VERSION	Software/firmware version information.
BOOT_VERSION	Boot or kernel version information.
CONFIG_VERSION
ESN	The device's ESN (Electronic Serial Number).
EVENT_CODE	The provider-specific event code.
EVENT_NAME	The provider-specific event name. See ProviderEventName for more information.
EVENT_TIME	The time of the event.
GPS_HARDWARE	GPS chip information.
HARDWARE_VERSION	Device model information.
ICCID	The device's ICCID (Integrated Circuit Card ID)
IMEI	The device's IMEI (International Mobile Station Equipment Identity).
IMPACT
IMSI	The device's IMSI (International Mobile Subscriber Identity).
LAST_CONFIG_UPDATE
LAST_ID_REPORT
LOCATION_SOURCE	Source used to get position of the device (GPS, Network or Wi-fi)
MAIN_FIRMWARE_VERSION
MIN	The device's MIN (Mobile Identification Number).
MODEM_MODEL	Device model name.
MODEM_MODEL_ID	Device model name.
MODEM_NAME	Device friendly name.
NEW_SIM_ID
NUMBER_OF_OTA_TRY
OBDII_FIRMWARE_VERSION
OS_NAME	Operating System name (appropriate for mobile phones powered by Android or iOS).
OS_VERSION	Operating System version information.
PHONE_NUMBER	Phone number
POWER_UP_COUNTER
PREFERED_ROAMING_LIST
PREVIOUS_SIM_ID
RADIO_VERSION
RAP_VERSION
REGISTRATION_ID	Unique string given to mobile apps for FCM notifications.
RESET_COUNTER
SECONDARY_IMEI	The device's secondary IMEI.
SEQUENCE_NUMBER
SEQUENCE_NUMBER_FIRST
SEQUENCE_NUMBER_LAST
SERIAL_NUMBER	A serial not used as ESN, IMEI, or similar.
SOURCE
STATUS_POWERUP	Booting
STATUS_SLEEP	Low power mode
STATUS_WAKEUP	High power mode
VBUS
AIR_TEMPERATURE
ANTI_ICE_RATE
BILLING
BLAST
CONTROLLER
DISTANCE_TRAVELLED_AFTER_MIL_ON
DRY_RATE
ENGINE_HOURS
EQUIVALENT_COMMAND_RATIO
FUEL_TYPE
J1708_ACCELERATOR_PEDAL_POSITION
J1708_AIR_INTAKE_TEMPERATURE
J1708_BATTERY_VOLTAGE
J1708_BOOST_PRESSURE_INTAKE_MANIFOLD_PRESSURE
J1708_DIAGNOSTIC_CODE
J1708_ENGINE_AVERAGE_FUEL_ECONOMY
J1708_ENGINE_COOLANT_PRESSURE
J1708_ENGINE_COOLANT_TEMP
J1708_ENGINE_LOAD
J1708_ENGINE_OIL_PRESSURE
J1708_ENGINE_OIL_TEMP
J1708_ENGINE_SPEED
J1708_FUEL_LEVEL
J1708_FUEL_RATE
J1708_ODOMETER	Odometer reading from J-Bus 1708
J1708_SEATBELT
J1708_STATUS
J1708_THROTTLE_POSITION
J1708_TOTAL_ENGINE_HOURS
J1708_TOTAL_FUEL
J1708_TOTAL_IDLE_FUEL
J1708_TOTAL_IDLE_HOURS
J1708_VEHICLE_SPEED
J1939_ACCELERATOR_PEDAL_POSITION
J1939_BATTERY_VOLTAGE
J1939_DIAGNOSTIC_CODE
J1939_ENGINE_AVERAGE_FUEL_ECONOMY
J1939_ENGINE_COOLANT_PRESSURE
J1939_ENGINE_COOLANT_TEMP
J1939_ENGINE_LOAD
J1939_ENGINE_OIL_PRESSURE
J1939_ENGINE_OIL_TEMP
J1939_ENGINE_SPEED
J1939_FUEL_LEVEL
J1939_FUEL_RATE
J1939_ODOMETER	Odometer reading from J-Bus 1939
J1939_SEATBELT
J1939_STATUS
J1939_TOTAL_ENGINE_HOURS
J1939_TOTAL_FUEL
J1939_TOTAL_IDLE_FUEL
J1939_TOTAL_IDLE_HOURS
J1939_TRANSMISSION_GEAR
J1939_TURN_SIGNAL
J1939_VEHICLE_SPEED
LEFT_WIRING
LIQUID_RATE
MATERIAL_TYPE
MIL_STATUS
OBDII_AIR_FLOW_RATE
OBDII_AIR_INTAKE_TEMPERATURE
OBDII_AMBIENT_AIR_TEMPERATURE
OBDII_BAROMETRIC_PRESSURE
OBDII_BATTERY_VOLTAGE
OBDII_BOOST_PRESSURE_INTAKE_MANIFOLD_PRESSURE
OBDII_DERIVED_ENGINE_STATE
OBDII_DISTANCE_SINCE_CODE_CLEARED
OBDII_DISTANCE_TRAVELLED_AFTER_MIL_ON
OBDII_DTC	Diagnotic Trouble Code
OBDII_DTC_COUNT	The number of DTCs present
OBDII_ENGINE_AVERAGE_FUEL_ECONOMY
OBDII_ENGINE_COOLANT_PRESSURE
OBDII_ENGINE_COOLANT_TEMP
OBDII_ENGINE_LOAD
OBDII_ENGINE_OIL_TEMP
OBDII_ENGINE_SPEED
OBDII_EQUIVALENT_COMMAND_RATIO
OBDII_FUEL_AIR_COMMANDED_EQUIVAILENCE_RATIO
OBDII_FUEL_LEVEL
OBDII_FUEL_LEVEL_REMAINING
OBDII_FUEL_PRESSURE
OBDII_FUEL_RAIL_PRESSURE
OBDII_FUEL_RATE
OBDII_FUEL_TYPE
OBDII_HIGH_BATTERY_VOLTAGE
OBDII_IGNITION_TIMING_ADVANCE
OBDII_INDICATORS	List of OBD-II indicators
OBDII_INSTANT_FULE_RATE
OBDII_LONG_TERM_FUEL_TRIM_BANK_1
OBDII_LONG_TERM_FUEL_TRIM_BANK_2
OBDII_LOW_BATTERY_VOLTAGE
OBDII_MILES_SINCE_LAST_ALERT	Odometer reading from CAN-Bus since last DTC code was cleared
OBDII_ODOMETER	Odometer reading from CAN-Bus
OBDII_OEM_PARAMETERS
OBDII_OEM_PROTOCOL
OBDII_PARAMETERS	List of OBD-II parameters
OBDII_PROTOCOL	ame or code of the OBD-II protocol in use.
OBDII_SEATBELT
OBDII_SHROT_TERM_FUEL_TRIM_BANK_1
OBDII_SHROT_TERM_FUEL_TRIM_BANK_2
OBDII_THROTTLE_POSITION
OBDII_TOTAL_ENGINE_HOURS
OBDII_TRANSMISSION_GEAR
OBDII_TRIP_FUEL_CONSUMPTION
OBDII_TRIP_ODOMETER
OBDII_TURN_SIGNAL
OBDII_VEHICLE_SPEED
OBDII_WIDEBAND_AIR_FUEL_RATIO
OBDII_YMME
PAUSE
PLOW_PRIMARY
PLOW_SECONDARY
PREWET_RATE
RIGHT_WIRING
ROAD_TEMPERATURE
SOLID_RATE
SPINNER_RATE
SPREADER_STATUS_BLAST
SPREADER_STATUS_COMMUNICATION
SPREADER_STATUS_LIQUID
SPREADER_STATUS_MATERIAL
SPREADER_STATUS_PREWET
SPREADER_STATUS_SOLID
TOTAL_LIQUID
TOTAL_PREWET
TOTAL_SOLID
UNIT_STATUS
VBUS_ACCELERATOR_PEDAL_POSITION
VBUS_BRAKE_SWITCH_STATUS
VBUS_TOTAL_FUEL_USED
VIN	Vehicle Identification Number

ProviderDataUnitstring

Suggested units for ProviderData attributes.

Value	Description
	The "no unit" value is a blank string.
a	Amperage (amps)
ac	Area (acre)
c	Temperature (degrees Celsius)
cm	Distance (centimeters)
cmps	Speed (centimetres per second)
cmps2	Accelerometion (centimetres per second squared)
db	Decibels
dbm	Decibels (milliwatts)
degree	Used for heading/bearing, latitude, and longitude
f	Temperature (degrees Fahrenheit)
floz	Volume (fluid ounces)
ft	Distance (feet)
ftps	Speed (feet per second)
g	Weight (grams)
gal	Volume (US gallons)
gf	Accelerometion (G-force)
gmps	Flow rate (grams per second)
ha	Area (hectares)
hour	Time (hours)
in	Distance (inches)
inps	Speed (inches per second)
k	Temperature (degrees Kelvin)
kg	Weight (kilograms)
kgpkm	Dry rate in kilogram per kilometer
km	Distance (kilometers)
kn	Speed (nautical miles per hour)
knps	Speed (nautical miles per second)
kpa	Pressure (kilopascals)
kph	Speed (kilometres per hour)
l	Volume (litres)
l100km	Fuel Economy (litres per 100 kilometres)
lbs	Weight (pounds)
lm	Light by Lumens
lph	Fuel consumption (litres per hour)
lpkm	Prew and anti ice rate in (liter per kilometer)
m	Distance (meters)
mgf	Accelerometion (Milli-G-force)
mi	Distance (miles)
minute	Time (minutes)
mips	Speed (miles per second)
ml	Volume (millilitres)
mlph	Fuel consumption (millilitres per hour)
mpg	Fuel Economy (miles per gallon)
mph	Speed (miles per hour)
mps	Speed (metres per second)
mv	Voltage (millivolts)
oz	Weight (ounces)
percent	Percentage (%)
psi	Pressure (pounds per square inch)
rpm	Engine speed
second	Time (seconds)
sqft	Area (square feet)
sqkm	Area (kilometers squared)
sqm	Area (metres squared)
sqmi	Area (square miles)
t	Weight (metric tonnes)
ton	Weight (US tons)
v	Voltage (volts)

ProviderDeletedobject

The message format for when a deleted Provider is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this device belongs.
configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id		The provider's current (or pending) configuration profile.
deleted	boolean	`true`
id	string see: Provider.id maximum-length: 50 minimum-length: 10		Unique identifier of this device.
kind	ProviderType		The kind of communication protocol this device uses.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"configuration": number,
	"deleted": boolean,
	"id": string,
	"kind": string,
	"since": string,
	"v": [
		number
	]
}

ProviderEventNamestring

The kinds of event messages.

Value	Description
ACCELERATION	Hard-acceleration detected
DECELERATION	Hard-braking detected
GPS_FOUND	GPS signal re-acquired.
GPS_LOST	GPS fix was lost.
HARSH_TURN	Hard-cornering detected
IB_IN	Gen-X iButton clock-in
IB_OUT	Gen-X iButton clock-out
IDLING	Vehicle is stopped and the ignition is on.
IGNITION_OFF	Vehicle's ignition turned off.
IGNITION_ON	Vehicle's ignition turned on.
IMPACT	Impact detected
IN_REGION	Has entered a designated region or geofence
LIGHT_OUT_OF_BAND	BeWhere Light sensor alert
MOVING	Device is in motion
OUT_REGION	Has left a designated region or geofence
PANIC	Smartwitness Panic button pressed.
PARK	Vehicle has stopped and engaged parking brake or the transmission was set to "P".
PERIODIC	Regular interval report.
POWER_CONNECTED	External power was connected.
POWER_DISCONNECTED	External power was disconnected.
POWER_OFF	Modem is powering off or shutting down.
POWER_UP	Modem has completed its power-on or boot routine.
SHORT_POWER_OUT	Modem is shutting down immediately.
SLEEP	Modem is going in to low-power state or sleep mode.
SPEEDING	Device is speeding
SPEEDING_STOP	Device stopped speeding
STOP_MOVING	Device has stopped moving
TAMPER_DETECT	Tamper detection sensor activated
TOWING	Device is being towed.
UNDEFINED	Unknown or undefined event name.
VIN_FOUND	VIN has been retreived from VBus
WAKE_UP	Modem is coming in to normal power consumption state, or wake mode.

ProviderGeneralobject

Device/hardware information and configuration.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The asset for which this device provides field data.
company	uint64 see: Company.id	The company to which this device belongs.
configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The provider's current (or pending) configuration profile.
firmware	string maximum-length: 100	The firmware/application version number.
firmwareStatus	ProvisioningStatus	The system's progress of updating the device's firmware/application.
geofenceLast	datetime	A timestamp from when the geofence list was updated by a User or a Provider.
geofenceStatus	ProvisioningStatus	The system's progress of updating the device's on-board geofence definitions.
id	string see: Provider.id maximum-length: 50 minimum-length: 10	Unique identifier of this device.
information	Object.<string, string> for keys see: ProviderDataName	A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
kind	ProviderType	The kind of communication protocol this device uses.
lastCheckIn	datetime	A timestamp from when the provider last checked for a new script or new geofences.
name	string maximum-length: 100	A nickname given to the device/hardware.
notes	string	Notes!
password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
phoneNumber	uint64?	The phone number of this device.
pnd	string maximum-length: 50	The short-name of the kind of PND attached to this device. Leave blank if none.
processedUtc	datetime	When the was change procesed.
scriptLast	datetime	A timestamp from when the script status was updated by a User or a Provider.
scriptStatus	ProvisioningStatus	The system's progress of updating the device's programming.
sim	string	ICCID of the SIM card installed in this provider
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"asset": number,
	"company": number,
	"configuration": number,
	"firmware": string,
	"firmwareStatus": string,
	"geofenceLast": string,
	"geofenceStatus": string,
	"id": string,
	"information": {
		string: string
	},
	"kind": string,
	"lastCheckIn": string,
	"name": string,
	"notes": string,
	"password": string,
	"phoneNumber": number,
	"pnd": string,
	"processedUtc": string,
	"scriptLast": string,
	"scriptStatus": string,
	"sim": string,
	"updated": {
	},
	"v": [
		number
	]
}

ProviderGeofenceCircularobject Deprecated

A geofence defined by a centre coordinate and a threshold value to indicate the boundary around that point.

JSON description

Property	Type	Description
maxGeofenceCount	uint32	The maximum number of unique geofences supported by the device.
maxRadius	uint32	The largest possible radius for this geofence.
minRadius	uint32	The smallest possible radius for this geofence.
type	PlaceType	The supported shape of geofence.

JSON structure

{
	"maxGeofenceCount": number,
	"maxRadius": number,
	"minRadius": number,
	"type": string
}

ProviderGeofencePointobject Deprecated

This is a point and not a geofence, so I don't know why this is defined.

JSON description

Property	Type	Description
maxGeofenceCount	uint32	The maximum number of unique geofences supported by the device.
type	PlaceType	The supported shape of geofence.

JSON structure

{
	"maxGeofenceCount": number,
	"type": string
}

ProviderGeofencePolygonobject Deprecated

A geofence whose boundary is defined by a non-overlapping series of coordinates.

JSON description

Property	Type	Description
maxGeofenceCount	uint32	The maximum number of unique geofences supported by the device.
maxVertices	uint32	The maximum number of vertices supported by the device.
type	PlaceType	The supported shape of geofence.

JSON structure

{
	"maxGeofenceCount": number,
	"maxVertices": number,
	"type": string
}

ProviderGeofenceRectangleobject Deprecated

A geofence whose boundary is a "rectangle" defined by corner coordinates.

JSON description

Property	Type	Description
maxGeofenceCount	uint32	The maximum number of unique geofences supported by the device.
maxLength	uint32	The smallest possible diameter for this geofence.
maxWidth	uint32	The smallest possible diameter for this geofence.
type	PlaceType	The supported shape of geofence.

JSON structure

{
	"maxGeofenceCount": number,
	"maxLength": number,
	"maxWidth": number,
	"type": string
}

ProviderRegistrationobject

The temporary reference to a device whose ownership is pending.

JSON description

Property	Type	Description
asset	uint64? see: Asset.id	The Asset for which this device will provide data.
code	string fixed length: 6	A unique six digit code.
company	uint64 see: Company.id	The company to which the device will belong.
completed	datetime	Date/time stamp of when this registration ended successfully.
config	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The predefined configuration this device will use.
expires	datetime	The expiry date for this registration.
identifier	string see: Provider.id maximum-length: 50	The unique identifier of the device that completed this registration.
kind	ProviderType	The kind of protocol this device supports.
name	string maximum-length: 100	A nickname given to the device once it has been provisioned.
notes	string	Notes!
password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
phoneNumber	uint64?	The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup.
since	datetime	Date/time stamp of when this registration began.
user	email see: User.login maximum-length: 254	The unique identifier the user who generated this registration.

JSON structure

{
	"asset": number,
	"code": string,
	"company": number,
	"completed": string,
	"config": number,
	"expires": string,
	"identifier": string,
	"kind": string,
	"name": string,
	"notes": string,
	"password": string,
	"phoneNumber": number,
	"since": string,
	"user": string
}

ProviderRegistrationDeletedobject

The message format for when a deleted ProviderRegistration is retrieved

JSON description

Property	Type	Value	Description
code	string fixed length: 6		A unique six digit code.
company	uint64 see: Company.id		The company to which the device will belong.
deleted	boolean	`true`	Indicates whether this ProviderRegistration is expired.
kind	ProviderType		The kind of protocol this device supports.
since	datetime		The expiry date for this registration.
since	datetime		A timestamp from the moment the object was deleted.

JSON structure

{
	"code": string,
	"company": number,
	"deleted": boolean,
	"kind": string,
	"since": string,
	"since": string
}

ProviderScriptobject

This class describes a type of logic applied to a provider. A script will generate a file which is loaded onto a provider in the field.

JSON description

Property	Type	Description
blocks	Array.<ProviderScriptBlock>	Blocks of file data which are (optionally) included in the script data file.
company	uint64 see: Company.id	The company to which this configuration belongs.
fill	colour maximum-length: 22	The fill/background colour of the icon.
global	boolean	Indicates whether this script is available to child companies.
graphic	codified maximum-length: 22	The name of the symbol for this script.
id	uint64	Unique identifier of this configuration.
kind	ProviderType	The type of provider for which this script can be used. Limiting to a specific model from a manufacturer is accomplished through the block conditions.
name	string maximum-length: 100	The nickname given to this configuration
notes	string	Simple details about how the providers are expected to behave.
parameters	Object.<string, ProviderScriptParameter>	Parameter definitions for this script, including type-hints and default values.
processedUtc	datetime	When the was change procesed.
stroke	colour maximum-length: 22	Outline and graphic colour.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"blocks": [
		{
			"condition": string,
			"content": string,
			"replace": string,
			"validate": string
		}
	],
	"company": number,
	"fill": string,
	"global": boolean,
	"graphic": string,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"parameters": {
		string: {
			"advanced": boolean,
			"context": string,
			"notes": string,
			"order": number,
			"type": string,
			"value": string
		}
	},
	"processedUtc": string,
	"stroke": string,
	"updated": {
	},
	"v": [
		number
	]
}

ProviderScriptBlockobject

A chunk of script and variables used to assemble a working ProviderScript.

JSON description

Property	Type	Description
condition	string maximum-length: 50	When defined, this condition matches a ProviderScriptParameter defined in the ProviderConfig to include or exclude this chunk from the script.
content	string	A chunk of the file loaded onto a provider with it's variables replaced with configurable variables. Trailing or leading whitespace should be included here, so when blocks are merged, so too is the newline characters.
replace	string maximum-length: 20	A regular expression used to match variables in the content. The regex must contain at least one match-group. The value fom the last group is what's used as a parameter name. Examples: `{{([a-z]+)}}`, or `<(var[a-z]+)>`
validate	string	Used in conjunction with condition, this value must match the given ProviderScriptParameter value to have the chunk included.

JSON structure

{
	"condition": string,
	"content": string,
	"replace": string,
	"validate": string
}

ProviderScriptDeletedobject

The message format for when a deleted ProviderScript is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this configuration belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this configuration.
kind	ProviderType		The type of provider for which this script can be used. Limiting to a specific model from a manufacturer is accomplished through the block conditions.
name	string maximum-length: 100		The nickname given to this configuration
notes	string		Simple details about how the providers are expected to behave.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"kind": string,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ProviderScriptParameterobject

Definition of an argument passed to a ProviderScript.

JSON description

Property	Type	Description
advanced	boolean	Used as a hint that this parameter controls an advanced script option and should only be set if you really know what you're doing.
context	string	Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types.
notes	string	Usage notes.
order	uint32	The order in which this parameter is displayed compared to other parameters. The value has no effect on how this parameter is inserted into the ProviderScriptBlocks.
type	ProviderScriptParameterType	Simple type information for the gateway to process.
value	string	The value is given as a string, but parsed into native type when used by the gateway.

JSON structure

{
	"advanced": boolean,
	"context": string,
	"notes": string,
	"order": number,
	"type": string,
	"value": string
}

ProviderScriptParameterTypestring

Possible data-types given to ProviderScriptParameter.

Value	Description
boolean	True or false.
number	Numeric value (double-precision floating point number).
text	Text.

ProviderSuspendedobject

The message format for when a suspended Provider is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this device belongs.
configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id		The provider's current (or pending) configuration profile.
id	string see: Provider.id maximum-length: 50 minimum-length: 10		Unique identifier of this device.
kind	ProviderType		The kind of communication protocol this device uses.
name	string maximum-length: 100		A nickname given to the device/hardware.
notes	string		Notes!
since	datetime		A timestamp from the moment the object was suspended.
suspended	boolean	`true`	Indicates whether this Provider is suspended from event processing.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"configuration": number,
	"id": string,
	"kind": string,
	"name": string,
	"notes": string,
	"since": string,
	"suspended": boolean,
	"v": [
		number
	]
}

ProviderTypestring

Protocols supported by the system.

Value	Description
airlink Deprecated	Sierra Wireless AirLink RAP protocol No longer supported.
aspenta Deprecated	Aspenta Open API format No longer supported.
atrack	ATrack device protocols
bewhere	BeWhere beacon protocols
bluetree Deprecated	Sixnet BlueTree BEP protocol No longer supported.
calamp	CalAmp LMU/TTU modem protocols
concox Deprecated	Concox Tracker protocol No longer supported.
datatrans	TachWest DataTrans protocol
enfora Deprecated	Enfora (Novotel) modem protocols No longer supported.
genx	Gen-X modem protocol
json Deprecated	Fleet Freedom JSON protocol No longer supported.
lbs	Bell Mobility LBS
lmu Deprecated	CalAmp LMU series protocol Use calamp instead.
mobile	Trak iT Wireless Mobile App
smartwitness	SmartWitness dashcam formats
spiderAT Deprecated	Novotel Enfora SpiderAT protocol Use enfora instead.
spiderMT Deprecated	Novotel Enfora SpiderMT protocol Use enfora instead.
teltonika	Teltonika device protocols
titan Deprecated	Certified Tracking protocol No longer supported.
ttu Deprecated	CalAmp TTU series protocol Use calamp instead.
unknown	Your guess is as good as mine. It should never be this.
xirgo Deprecated	Xirgo modem protocol No longer supported.

ProvisioningStatusstring

Progress lifetime of changing the on-board information of a remote device.

Value	Description
cancelled	Sending of the new configuration was halted by a user.
completed	New configuration successfully sent to provider.
created	The new configuration has been created, but not yet sent to the provider.
error	Something went wrong while trying to send configuration.
inProgress	Currently sending configuration over-the-air to the provider.
maxRetries	The maximum number of retries were attempted before giving up.
otaSent	A message was sent to the provider asking it to check in.
partial	Only a partial configuration was sent to the provider.
pending	Provider is notified of new configuration, but has not yet checked in.
unknown	Your guess is as good as mine. It should never be this.

RespProviderAdvancedGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerAdvanced	ProviderAdvanced	The requested Provider.
providerAdvanced.attributes	Object.<string, Object.<string, ProviderData>> for keys see: ProviderDataGroup for value-keys see: ProviderDataName	Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
providerAdvanced.company	uint64 see: Company.id	The company to which this device belongs.
providerAdvanced.id	string see: Provider.id maximum-length: 50 minimum-length: 10	Unique identifier of this device.
providerAdvanced.lastIP	ipv4	The last IP address of the device.
providerAdvanced.processedUtc	datetime	When the was change procesed.
providerAdvanced.snf	Object.<string, string>	Store-and-forward information like last sequence number of SnF window
providerAdvanced.updated		by: login, from: monster
providerAdvanced.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerAdvanced": {
		"attributes": {
			string: {
				string: {
					"dts": string,
					"unit": string,
					"value": Object
				}
			}
		},
		"company": number,
		"id": string,
		"lastIP": string,
		"processedUtc": string,
		"snf": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderAdvancedListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Providers belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerAdvanceds	Array.<ProviderAdvanced>	The list of requested Providers.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerAdvanceds": [
		{
			"attributes": {
				string: {
					string: {
						"dts": string,
						"unit": string,
						"value": Object
					}
				}
			},
			"company": number,
			"id": string,
			"lastIP": string,
			"processedUtc": string,
			"snf": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderAdvancedListByConfigBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerAdvanceds	Array.<ProviderAdvanced>	The list of requested Providers.
providerConfig	RespIdCompany	An object to contain the "id" of the ProviderConfig/ProviderConfiguration to which the array of Providers belong.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerAdvanceds": [
		{
			"attributes": {
				string: {
					string: {
						"dts": string,
						"unit": string,
						"value": Object
					}
				}
			},
			"company": number,
			"id": string,
			"lastIP": string,
			"processedUtc": string,
			"snf": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"providerConfig": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespProviderBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providers	Array.<RespIdendifierDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providers": [
		{
			"company": number,
			"deleted": boolean,
			"id": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providers	Array.<RespIdendifierCompany>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providers": [
		{
			"company": number,
			"id": string
		}
	],
	"reqId": number
}

RespProviderBatchReviveBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providers	Array.<RespIdendifierSuspended>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providers": [
		{
			"company": number,
			"id": string,
			"suspended": boolean,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderBatchSuspendBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providers	Array.<RespIdendifierSuspended>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providers": [
		{
			"company": number,
			"id": string,
			"suspended": boolean,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigs	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigs": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigs	Array.<RespIdScript>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigs": [
		{
			"company": number,
			"id": number,
			"script": number
		}
	],
	"reqId": number
}

RespProviderConfigDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespDeleted	An object which contains the ProviderConfig's id, owning Company id, and deleted status.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.deleted	boolean	Flag showing if the object is deleted.
providerConfig.id	uint64?	Identifier given as input for the command.
providerConfig.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	ProviderConfig	The requested ProviderConfig.
providerConfig.company	uint64 see: Company.id	The company to which this configuration belongs.
providerConfig.geofences	expression	A search pattern used to filter which Places' geometry are used as geofences. Use null to disable. Use "*" to match all the Places the Provider's Asset can match. Or use "#123456" or "label:term" like other Place search patterns.
providerConfig.id	uint64	Unique identifier of this configuration.
providerConfig.name	string maximum-length: 100	The nickname given to this configuration
providerConfig.notes	string	Simple details about how the providers are expected to behave.
providerConfig.parameters	Object.<string, string>	The list of defined variable name/value pairs that the script requires.
providerConfig.processedUtc	datetime	When the was change procesed.
providerConfig.script	uint64 see: ProviderScript.id	The script which this configuration implements.
providerConfig.updated		by: login, from: monster
providerConfig.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"geofences": string,
		"id": number,
		"name": string,
		"notes": string,
		"parameters": {
			string: string
		},
		"processedUtc": string,
		"script": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of ProviderConfigs belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigs	Array.<ProviderConfig>	The list of reqested ProviderConfigs.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigs": [
		{
			"company": number,
			"geofences": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: string
			},
			"processedUtc": string,
			"script": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigListByScriptBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigs	Array.<ProviderConfig>	The list of reqested ProviderConfigs.
providerScript	RespId	An object to contain the "id" of the Company to which the array of ProviderConfigs belong.
providerScript.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigs": [
		{
			"company": number,
			"geofences": string,
			"id": number,
			"name": string,
			"notes": string,
			"parameters": {
				string: string
			},
			"processedUtc": string,
			"script": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"providerScript": {
		"id": number
	},
	"reqId": number
}

RespProviderConfigMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespIdScript	An object which contains the "id", "company", and "script" keys when there is no error.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.id	uint64?	Identifier given as input for the command.
providerConfig.script	uint64	Identifier of the script to which this object belongs.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"id": number,
		"script": number
	},
	"reqId": number
}

RespProviderConfigRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespDeleted	An object which contains the ProviderConfig's id, owning Company id, and deleted status.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.deleted	boolean	Flag showing if the object is deleted.
providerConfig.id	uint64?	Identifier given as input for the command.
providerConfig.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigurationBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurations	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurations": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigurationBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurations	Array.<RespIdScript>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurations": [
		{
			"company": number,
			"id": number,
			"script": number
		}
	],
	"reqId": number
}

RespProviderConfigurationDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfiguration	RespDeleted	An object which contains the ProviderConfiguration's id, owning Company id, and deleted status.
providerConfiguration.company	uint64	Identifier of the Company to which this object belongs.
providerConfiguration.deleted	boolean	Flag showing if the object is deleted.
providerConfiguration.id	uint64?	Identifier given as input for the command.
providerConfiguration.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfiguration": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigurationGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfiguration Deprecated	ProviderConfiguration	The requested ProviderConfiguration. Use ProviderConfig instead.
providerConfiguration.company	uint64 see: Company.id	The company to which this configuration belongs.
providerConfiguration.geofences	Array.<uint64>	List of Places loaded directly onto the provider.
providerConfiguration.id	uint64	Unique identifier of this configuration.
providerConfiguration.name	string maximum-length: 100	The nickname given to this configuration
providerConfiguration.notes	string	Simple details about how the providers are expected to behave.
providerConfiguration.processedUtc	datetime	When the was change procesed.
providerConfiguration.scriptParameters	Object.<string, Object>	The list of defined variables given to the logic type's options pairs for the logic type requires.
providerConfiguration.type	uint64 see: ProviderConfigurationType.id	The logic type which this configuration implements.
providerConfiguration.updated		by: login, from: monster
providerConfiguration.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfiguration": {
		"company": number,
		"geofences": [
			number
		],
		"id": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"scriptParameters": {
			string: Object
		},
		"type": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigurationListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurations	Array.<ProviderConfiguration>	The list of reqested ProviderConfigurations.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurations": [
		{
			"company": number,
			"geofences": [
				number
			],
			"id": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"scriptParameters": {
				string: Object
			},
			"type": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigurationMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfiguration	RespIdScript	An object which contains the "id", "company", and "script" keys when there is no error.
providerConfiguration.company	uint64	Identifier of the Company to which this object belongs.
providerConfiguration.id	uint64?	Identifier given as input for the command.
providerConfiguration.script	uint64	Identifier of the script to which this object belongs.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfiguration": {
		"company": number,
		"id": number,
		"script": number
	},
	"reqId": number
}

RespProviderConfigurationRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfiguration	RespDeleted	An object which contains the ProviderConfiguration's id, owning Company id, and deleted status.
providerConfiguration.company	uint64	Identifier of the Company to which this object belongs.
providerConfiguration.deleted	boolean	Flag showing if the object is deleted.
providerConfiguration.id	uint64?	Identifier given as input for the command.
providerConfiguration.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfiguration": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigurationTypeGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurationType Deprecated	ProviderConfigurationType	The requested ProviderConfigurationTypes. Use ProviderScript instead.
providerConfigurationType.geofenceTypes	Array.<PlaceType>	A list of supported types of geofences which can be programmed directly onto the device.
providerConfigurationType.id	uint64	Unique identifier.
providerConfigurationType.maxGeofenceCount	uint32	The maximum number of geofences that can be programmed onto a device. This number changes based on device make and model, and can also change based on the supported geofence types.
providerConfigurationType.minGeofenceCount	uint32	The minimum number of geofences that need to be programmed onto the device. This value is almost always zero.
providerConfigurationType.name	string maximum-length: 100	Name of the configuration type.
providerConfigurationType.notes	string	Notes regarding the use of this configuration.
providerConfigurationType.processedUtc	datetime	When the was change procesed.
providerConfigurationType.providerType	ProviderType	The applicable type of provider for which this configuration type can be created.
providerConfigurationType.scriptOptions	Object.<string, ProviderConfigurationNode>	A tree-structure of configurations required (or optionally available) for programming a device.
providerConfigurationType.updated		by: login, from: monster
providerConfigurationType.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurationType": {
		"geofenceTypes": [
			string
		],
		"id": number,
		"maxGeofenceCount": number,
		"minGeofenceCount": number,
		"name": string,
		"notes": string,
		"processedUtc": string,
		"providerType": string,
		"scriptOptions": {
			string: {
				"id": string,
				"isAdvanced": boolean,
				"max": Object,
				"min": Object,
				"nodes": {
					string: { /* recursive ProviderConfigurationNode objects */ }
				},
				"notes": string,
				"type": string,
				"unit": string,
				"value": Object
			}
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderConfigurationTypeListBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurationTypes	Array.<ProviderConfigurationType>	The list of requested ProviderConfigurationTypes.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurationTypes": [
		{
			"geofenceTypes": [
				string
			],
			"id": number,
			"maxGeofenceCount": number,
			"minGeofenceCount": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"providerType": string,
			"scriptOptions": {
				string: {
					"id": string,
					"isAdvanced": boolean,
					"max": Object,
					"min": Object,
					"nodes": {
						string: { /* recursive ProviderConfigurationNode objects */ }
					},
					"notes": string,
					"type": string,
					"unit": string,
					"value": Object
				}
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderConfigurationTypeListByTypeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfigurationTypes	Array.<ProviderConfigurationType>	The list of requested ProviderConfigurationTypes.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfigurationTypes": [
		{
			"geofenceTypes": [
				string
			],
			"id": number,
			"maxGeofenceCount": number,
			"minGeofenceCount": number,
			"name": string,
			"notes": string,
			"processedUtc": string,
			"providerType": string,
			"scriptOptions": {
				string: {
					"id": string,
					"isAdvanced": boolean,
					"max": Object,
					"min": Object,
					"nodes": {
						string: { /* recursive ProviderConfigurationNode objects */ }
					},
					"notes": string,
					"type": string,
					"unit": string,
					"value": Object
				}
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifierDeleted	An object which contains the Provider's id, owning Company id, and deleted status.
provider.company	uint64	Identifier of the Company to which this object belongs.
provider.deleted	boolean	Flag showing if the object is deleted.
provider.id	string	Identifier given as input for the command.
provider.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"company": number,
		"deleted": boolean,
		"id": string,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderGeneralGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerGeneral	ProviderGeneral	The requested Provider.
providerGeneral.asset	uint64? see: Asset.id	The asset for which this device provides field data.
providerGeneral.company	uint64 see: Company.id	The company to which this device belongs.
providerGeneral.configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The provider's current (or pending) configuration profile.
providerGeneral.firmware	string maximum-length: 100	The firmware/application version number.
providerGeneral.firmwareStatus	ProvisioningStatus	The system's progress of updating the device's firmware/application.
providerGeneral.geofenceLast	datetime	A timestamp from when the geofence list was updated by a User or a Provider.
providerGeneral.geofenceStatus	ProvisioningStatus	The system's progress of updating the device's on-board geofence definitions.
providerGeneral.id	string see: Provider.id maximum-length: 50 minimum-length: 10	Unique identifier of this device.
providerGeneral.information	Object.<string, string> for keys see: ProviderDataName	A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
providerGeneral.kind	ProviderType	The kind of communication protocol this device uses.
providerGeneral.lastCheckIn	datetime	A timestamp from when the provider last checked for a new script or new geofences.
providerGeneral.name	string maximum-length: 100	A nickname given to the device/hardware.
providerGeneral.notes	string	Notes!
providerGeneral.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
providerGeneral.phoneNumber	uint64?	The phone number of this device.
providerGeneral.pnd	string maximum-length: 50	The short-name of the kind of PND attached to this device. Leave blank if none.
providerGeneral.processedUtc	datetime	When the was change procesed.
providerGeneral.scriptLast	datetime	A timestamp from when the script status was updated by a User or a Provider.
providerGeneral.scriptStatus	ProvisioningStatus	The system's progress of updating the device's programming.
providerGeneral.sim	string	ICCID of the SIM card installed in this provider
providerGeneral.updated		by: login, from: monster
providerGeneral.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerGeneral": {
		"asset": number,
		"company": number,
		"configuration": number,
		"firmware": string,
		"firmwareStatus": string,
		"geofenceLast": string,
		"geofenceStatus": string,
		"id": string,
		"information": {
			string: string
		},
		"kind": string,
		"lastCheckIn": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"pnd": string,
		"processedUtc": string,
		"scriptLast": string,
		"scriptStatus": string,
		"sim": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderGeneralListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Providers belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerGenerals	Array.<ProviderGeneral>	The list of requested Providers.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerGenerals": [
		{
			"asset": number,
			"company": number,
			"configuration": number,
			"firmware": string,
			"firmwareStatus": string,
			"geofenceLast": string,
			"geofenceStatus": string,
			"id": string,
			"information": {
				string: string
			},
			"kind": string,
			"lastCheckIn": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"pnd": string,
			"processedUtc": string,
			"scriptLast": string,
			"scriptStatus": string,
			"sim": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderGeneralListByConfigBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespIdCompany	An object to contain the "id" of the ProviderConfig/ProviderConfiguration to which the array of Providers belong.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.id	uint64?	Identifier given as input for the command.
providerGenerals	Array.<ProviderGeneral>	The list of requested Providers.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"id": number
	},
	"providerGenerals": [
		{
			"asset": number,
			"company": number,
			"configuration": number,
			"firmware": string,
			"firmwareStatus": string,
			"geofenceLast": string,
			"geofenceStatus": string,
			"id": string,
			"information": {
				string: string
			},
			"kind": string,
			"lastCheckIn": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"pnd": string,
			"processedUtc": string,
			"scriptLast": string,
			"scriptStatus": string,
			"sim": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	Provider	The requested Provider.
provider.asset	uint64? see: Asset.id	The asset for which this device provides field data.
provider.attributes	Object.<string, Object.<string, ProviderData>> for keys see: ProviderDataGroup for value-keys see: ProviderDataName	Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
provider.company	uint64 see: Company.id	The company to which this device belongs.
provider.configuration	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The provider's current (or pending) configuration profile.
provider.firmware	string maximum-length: 100	The firmware/application version number.
provider.firmwareStatus	ProvisioningStatus	The system's progress of updating the device's firmware/application.
provider.geofenceLast	datetime	A timestamp from when the geofence list was updated by a User or a Provider.
provider.geofenceStatus	ProvisioningStatus	The system's progress of updating the device's on-board geofence definitions.
provider.id	string maximum-length: 50 minimum-length: 10	Unique identifier of this provider.
provider.information	Object.<string, string> for keys see: ProviderDataName	A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
provider.kind	ProviderType	The kind of communication protocol this device uses.
provider.lastCheckIn	datetime	A timestamp from when the provider last checked for a new script or new geofences.
provider.lastIP	ipv4	The last IP address of the device.
provider.name	string maximum-length: 100	A nickname given to the device/hardware.
provider.notes	string	Notes!
provider.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
provider.phoneNumber	uint64?	The phone number of this device.
provider.pnd	string maximum-length: 50	The short-name of the kind of PND attached to this device. Leave blank if none.
provider.processedUtc	datetime	When the was change procesed.
provider.scriptLast	datetime	A timestamp from when the script status was updated by a User or a Provider.
provider.scriptStatus	ProvisioningStatus	The system's progress of updating the device's programming.
provider.sim	string	ICCID of the SIM card installed in this provider
provider.snf	Object.<string, string>	Store-and-forward information like last sequence number of SnF window
provider.updated		by: login, from: monster
provider.v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
provider.v[0]	int32	The first element is for the general properties
provider.v[1]	int32	The first element is for the advanced properties
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"asset": number,
		"attributes": {
			string: {
				string: {
					"dts": string,
					"unit": string,
					"value": Object
				}
			}
		},
		"company": number,
		"configuration": number,
		"firmware": string,
		"firmwareStatus": string,
		"geofenceLast": string,
		"geofenceStatus": string,
		"id": string,
		"information": {
			string: string
		},
		"kind": string,
		"lastCheckIn": string,
		"lastIP": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"pnd": string,
		"processedUtc": string,
		"scriptLast": string,
		"scriptStatus": string,
		"sim": string,
		"snf": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Providers belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providers	Array.<Provider>	The list of requested Providers.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providers": [
		{
			"asset": number,
			"attributes": {
				string: {
					string: {
						"dts": string,
						"unit": string,
						"value": Object
					}
				}
			},
			"company": number,
			"configuration": number,
			"firmware": string,
			"firmwareStatus": string,
			"geofenceLast": string,
			"geofenceStatus": string,
			"id": string,
			"information": {
				string: string
			},
			"kind": string,
			"lastCheckIn": string,
			"lastIP": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"pnd": string,
			"processedUtc": string,
			"scriptLast": string,
			"scriptStatus": string,
			"sim": string,
			"snf": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderListByConfigBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespIdCompany	An object to contain the "id" of the ProviderConfig/ProviderConfiguration to which the array of Providers belong.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.id	uint64?	Identifier given as input for the command.
providers	Array.<Provider>	The list of requested Providers.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"id": number
	},
	"providers": [
		{
			"asset": number,
			"attributes": {
				string: {
					string: {
						"dts": string,
						"unit": string,
						"value": Object
					}
				}
			},
			"company": number,
			"configuration": number,
			"firmware": string,
			"firmwareStatus": string,
			"geofenceLast": string,
			"geofenceStatus": string,
			"id": string,
			"information": {
				string: string
			},
			"kind": string,
			"lastCheckIn": string,
			"lastIP": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"pnd": string,
			"processedUtc": string,
			"scriptLast": string,
			"scriptStatus": string,
			"sim": string,
			"snf": {
				string: string
			},
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifierCompany	An object which contains the "id" and "company" keys when there is no error.
provider.company	uint64	Identifier of the Company to which this object belongs.
provider.id	string	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"company": number,
		"id": string
	},
	"reqId": number
}

RespProviderRegistrationBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistrations	Array.<ProviderRegistration>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistrations": [
		{
			"asset": number,
			"code": string,
			"company": number,
			"completed": string,
			"config": number,
			"expires": string,
			"identifier": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"since": string,
			"user": string
		}
	],
	"reqId": number
}

RespProviderRegistrationBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistrations	Array.<ProviderRegistration>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistrations": [
		{
			"asset": number,
			"code": string,
			"company": number,
			"completed": string,
			"config": number,
			"expires": string,
			"identifier": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"since": string,
			"user": string
		}
	],
	"reqId": number
}

RespProviderRegistrationDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistration	ProviderRegistration	The requested provider.
providerRegistration.asset	uint64? see: Asset.id	The Asset for which this device will provide data.
providerRegistration.code	string fixed length: 6	A unique six digit code.
providerRegistration.company	uint64 see: Company.id	The company to which the device will belong.
providerRegistration.completed	datetime	Date/time stamp of when this registration ended successfully.
providerRegistration.config	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The predefined configuration this device will use.
providerRegistration.expires	datetime	The expiry date for this registration.
providerRegistration.identifier	string see: Provider.id maximum-length: 50	The unique identifier of the device that completed this registration.
providerRegistration.kind	ProviderType	The kind of protocol this device supports.
providerRegistration.name	string maximum-length: 100	A nickname given to the device once it has been provisioned.
providerRegistration.notes	string	Notes!
providerRegistration.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
providerRegistration.phoneNumber	uint64?	The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup.
providerRegistration.since	datetime	Date/time stamp of when this registration began.
providerRegistration.user	email see: User.login maximum-length: 254	The unique identifier the user who generated this registration.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistration": {
		"asset": number,
		"code": string,
		"company": number,
		"completed": string,
		"config": number,
		"expires": string,
		"identifier": string,
		"kind": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"since": string,
		"user": string
	},
	"reqId": number
}

RespProviderRegistrationGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistration	ProviderRegistration	The requested provider.
providerRegistration.asset	uint64? see: Asset.id	The Asset for which this device will provide data.
providerRegistration.code	string fixed length: 6	A unique six digit code.
providerRegistration.company	uint64 see: Company.id	The company to which the device will belong.
providerRegistration.completed	datetime	Date/time stamp of when this registration ended successfully.
providerRegistration.config	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The predefined configuration this device will use.
providerRegistration.expires	datetime	The expiry date for this registration.
providerRegistration.identifier	string see: Provider.id maximum-length: 50	The unique identifier of the device that completed this registration.
providerRegistration.kind	ProviderType	The kind of protocol this device supports.
providerRegistration.name	string maximum-length: 100	A nickname given to the device once it has been provisioned.
providerRegistration.notes	string	Notes!
providerRegistration.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
providerRegistration.phoneNumber	uint64?	The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup.
providerRegistration.since	datetime	Date/time stamp of when this registration began.
providerRegistration.user	email see: User.login maximum-length: 254	The unique identifier the user who generated this registration.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistration": {
		"asset": number,
		"code": string,
		"company": number,
		"completed": string,
		"config": number,
		"expires": string,
		"identifier": string,
		"kind": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"since": string,
		"user": string
	},
	"reqId": number
}

RespProviderRegistrationListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of providers belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistrations	Array.<ProviderRegistration>	The list of ProviderRegistrations.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistrations": [
		{
			"asset": number,
			"code": string,
			"company": number,
			"completed": string,
			"config": number,
			"expires": string,
			"identifier": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"since": string,
			"user": string
		}
	],
	"reqId": number
}

RespProviderRegistrationListByConfigBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerConfig	RespIdCompany	An object to contain the "id" of the ProviderConfig/ProviderConfiguration to which the array of ProviderRegistrations belong.
providerConfig.company	uint64	Identifier of the Company to which this object belongs.
providerConfig.id	uint64?	Identifier given as input for the command.
providerRegistrations	Array.<ProviderRegistration>	The list of ProviderRegistrations.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerConfig": {
		"company": number,
		"id": number
	},
	"providerRegistrations": [
		{
			"asset": number,
			"code": string,
			"company": number,
			"completed": string,
			"config": number,
			"expires": string,
			"identifier": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"since": string,
			"user": string
		}
	],
	"reqId": number
}

RespProviderRegistrationListByKindBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of providers belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
kind	ProviderType?	The type of ProviderRegistrations being listed.
message	string	An English description of the error.
providerRegistrations	Array.<ProviderRegistration>	The list of ProviderRegistrations.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"kind": string,
	"message": string,
	"providerRegistrations": [
		{
			"asset": number,
			"code": string,
			"company": number,
			"completed": string,
			"config": number,
			"expires": string,
			"identifier": string,
			"kind": string,
			"name": string,
			"notes": string,
			"password": string,
			"phoneNumber": number,
			"since": string,
			"user": string
		}
	],
	"reqId": number
}

RespProviderRegistrationMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerRegistration	ProviderRegistration	The complete ProviderRegistration object.
providerRegistration.asset	uint64? see: Asset.id	The Asset for which this device will provide data.
providerRegistration.code	string fixed length: 6	A unique six digit code.
providerRegistration.company	uint64 see: Company.id	The company to which the device will belong.
providerRegistration.completed	datetime	Date/time stamp of when this registration ended successfully.
providerRegistration.config	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The predefined configuration this device will use.
providerRegistration.expires	datetime	The expiry date for this registration.
providerRegistration.identifier	string see: Provider.id maximum-length: 50	The unique identifier of the device that completed this registration.
providerRegistration.kind	ProviderType	The kind of protocol this device supports.
providerRegistration.name	string maximum-length: 100	A nickname given to the device once it has been provisioned.
providerRegistration.notes	string	Notes!
providerRegistration.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
providerRegistration.phoneNumber	uint64?	The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup.
providerRegistration.since	datetime	Date/time stamp of when this registration began.
providerRegistration.user	email see: User.login maximum-length: 254	The unique identifier the user who generated this registration.
registration Deprecated	ProviderRegistration	Use providerRegistration instead..
registration.asset	uint64? see: Asset.id	The Asset for which this device will provide data.
registration.code	string fixed length: 6	A unique six digit code.
registration.company	uint64 see: Company.id	The company to which the device will belong.
registration.completed	datetime	Date/time stamp of when this registration ended successfully.
registration.config	uint64 see: ProviderConfig.id see: ProviderConfiguration.id	The predefined configuration this device will use.
registration.expires	datetime	The expiry date for this registration.
registration.identifier	string see: Provider.id maximum-length: 50	The unique identifier of the device that completed this registration.
registration.kind	ProviderType	The kind of protocol this device supports.
registration.name	string maximum-length: 100	A nickname given to the device once it has been provisioned.
registration.notes	string	Notes!
registration.password	string maximum-length: 50	The password programmed on the device used to ensure the system is the only client authorized to make changes.
registration.phoneNumber	uint64?	The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup.
registration.since	datetime	Date/time stamp of when this registration began.
registration.user	email see: User.login maximum-length: 254	The unique identifier the user who generated this registration.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerRegistration": {
		"asset": number,
		"code": string,
		"company": number,
		"completed": string,
		"config": number,
		"expires": string,
		"identifier": string,
		"kind": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"since": string,
		"user": string
	},
	"registration": {
		"asset": number,
		"code": string,
		"company": number,
		"completed": string,
		"config": number,
		"expires": string,
		"identifier": string,
		"kind": string,
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,
		"since": string,
		"user": string
	},
	"reqId": number
}

RespProviderRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifierDeleted	An object which contains the Provider's id, owning Company id, and deleted status.
provider.company	uint64	Identifier of the Company to which this object belongs.
provider.deleted	boolean	Flag showing if the object is deleted.
provider.id	string	Identifier given as input for the command.
provider.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"company": number,
		"deleted": boolean,
		"id": string,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderReviveBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifierSuspended	An object which contains the Provider's unique identifier and suspended status.
provider.company	uint64	Identifier of the Company to which this object belongs.
provider.id	string	Identifier given as input for the command.
provider.suspended	boolean	Flag showing if the object is suspended.
provider.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"company": number,
		"id": string,
		"suspended": boolean,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderScriptBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScripts	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScripts": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderScriptBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScripts	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScripts": [
		{
			"company": number,
			"id": number
		}
	],
	"reqId": number
}

RespProviderScriptDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScript	RespDeleted	An object which contains the ProviderScript's id, owning company id, and deleted status.
providerScript.company	uint64	Identifier of the Company to which this object belongs.
providerScript.deleted	boolean	Flag showing if the object is deleted.
providerScript.id	uint64?	Identifier given as input for the command.
providerScript.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScript": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderScriptGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScript	ProviderScript	The requested ProviderScript.
providerScript.blocks	Array.<ProviderScriptBlock>	Blocks of file data which are (optionally) included in the script data file.
providerScript.company	uint64 see: Company.id	The company to which this configuration belongs.
providerScript.fill	colour maximum-length: 22	The fill/background colour of the icon.
providerScript.global	boolean	Indicates whether this script is available to child companies.
providerScript.graphic	codified maximum-length: 22	The name of the symbol for this script.
providerScript.id	uint64	Unique identifier of this configuration.
providerScript.kind	ProviderType	The type of provider for which this script can be used. Limiting to a specific model from a manufacturer is accomplished through the block conditions.
providerScript.name	string maximum-length: 100	The nickname given to this configuration
providerScript.notes	string	Simple details about how the providers are expected to behave.
providerScript.parameters	Object.<string, ProviderScriptParameter>	Parameter definitions for this script, including type-hints and default values.
providerScript.processedUtc	datetime	When the was change procesed.
providerScript.stroke	colour maximum-length: 22	Outline and graphic colour.
providerScript.updated		by: login, from: monster
providerScript.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScript": {
		"blocks": [
			{
				"condition": string,
				"content": string,
				"replace": string,
				"validate": string
			}
		],
		"company": number,
		"fill": string,
		"global": boolean,
		"graphic": string,
		"id": number,
		"kind": string,
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"advanced": boolean,
				"context": string,
				"notes": string,
				"order": number,
				"type": string,
				"value": string
			}
		},
		"processedUtc": string,
		"stroke": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderScriptListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of ProviderScripts belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScripts	Array.<ProviderScript>	The list of requested ProviderScripts.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScripts": [
		{
			"blocks": [
				{
					"condition": string,
					"content": string,
					"replace": string,
					"validate": string
				}
			],
			"company": number,
			"fill": string,
			"global": boolean,
			"graphic": string,
			"id": number,
			"kind": string,
			"name": string,
			"notes": string,
			"parameters": {
				string: {
					"advanced": boolean,
					"context": string,
					"notes": string,
					"order": number,
					"type": string,
					"value": string
				}
			},
			"processedUtc": string,
			"stroke": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespProviderScriptMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScript	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
providerScript.company	uint64	Identifier of the Company to which this object belongs.
providerScript.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScript": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespProviderScriptRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
providerScript	RespDeleted	An object which contains the ProviderScript's id, owning company id, and deleted status.
providerScript.company	uint64	Identifier of the Company to which this object belongs.
providerScript.deleted	boolean	Flag showing if the object is deleted.
providerScript.id	uint64?	Identifier given as input for the command.
providerScript.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"providerScript": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespProviderSuspendBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
provider	RespIdendifierSuspended	An object which contains the Provider's unique identifier and suspended status.
provider.company	uint64	Identifier of the Company to which this object belongs.
provider.id	string	Identifier given as input for the command.
provider.suspended	boolean	Flag showing if the object is suspended.
provider.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"provider": {
		"company": number,
		"id": string,
		"suspended": boolean,
		"v": [
			number
		]
	},
	"reqId": number
}

RespSessionBatchKillBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
sessions	Array.<Session>	Array or responses successfully processed by the sub-command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"sessions": [
		{
			"company": number,
			"expiry": string,
			"handle": string,
			"login": string
		}
	]
}

Reports

ParamReportNotifyobject

Parameter values for updating the ReportNotifications for a ReportSchedule.

JSON description

Property	Type	Description
assets	expression maximum-length: 255	A targeting expression to identify which Assets receive the ReportResult.
users	Array.<email> maximum-count: 50	List of Users to send emailed report. Each email will only contain the ReportResult for the Assets each User is allowed to view.

JSON structure

{
	"assets": string,
	"users": [
		string
	]
}

ParamReportOptionsobject

Parameter values for creating a new or updating an existing ReportOptions.

JSON description

Property	Type	Description
filtering	ReportFilterMode?	The mechanism to use for filtering based on Places and regions.
parameters	Array.<ReportParameter>	A list of parameters to better shape the ReportResult.
places	expression	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
regions	Array.<string>	A list of provinces and states, where only Assets within those regions will be included in the ReportResult.
scorecardRules	Object.<string, ?>	Rules used to generate ReportScorecard for the ReportResult.
scorecardRules.baseScore	double	Base score for the ReportScorecard.
scorecardRules.parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final ReportScorecard.score.
targets	expression	A targeting expression for including/excluding Assets.

JSON structure

{
	"filtering": string,
	"parameters": [
		{
			"type": string,
			"value": string
		}
	],
	"places": string,
	"regions": [
		string
	],
	"scorecardRules": {
		"baseScore": number,
		"parameters": [
			{
				"condition": string,
				"duration": string,
				"points": number
			}
		]
	},
	"targets": string
}

ParamReportRecurrenceobject

Parameter values for creating a new or updating an existing ReportRecurrence.

JSON description

Property	Type	Description
end	datetime	The optional time when the ReportSchedule stops recurring in local-time (not UTC).
kind	ReportRecurrenceType?	How often the report is automatically run. Daily, weekly, monthly, etc...
start	datetime	When the ReportSchedule is to begin recurring in local-time (not UTC).
timezone	codified see: Timezone.code	The local Timezone used to calculate recurring date/time ranges.
weekday	byte?	Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week.
weekdays	Array.<boolean>	Used only for daily schedules, this 7 item, boolean array, determines if the ReportSchedule should recur on that day of the week.

JSON structure

{
	"end": string,
	"kind": string,
	"start": string,
	"timezone": string,
	"weekday": number,
	"weekdays": [
		boolean
	]
}

ParamReportResultBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportResults	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportResults": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamReportResultBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportResults	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportResults": [
		{
			"archive": boolean,
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"template": number,
			"timezone": string,
			"type": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamReportResultDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportResult	ParamId	always	An object to contain the "id" of the ReportResult.
reportResult.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportResult": {
		"id": number
	},
	"reqId": number
}

ParamReportResultGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
breakdown	boolean	optional		When true, will also retrieve all the ReportBreakdowns (when used through an applicable REST service).
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted ReportResult.
reportResult	ParamId	always		An object to contain the "id" of the ReportResult.
reportResult.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
summary	boolean	optional		When true, will also retrieve all the ReportSummarys (when used through an applicable REST service).

Request structure

{
	"breakdown": boolean,
	"includeDeleted": boolean,
	"reportResult": {
		"id": number
	},
	"reqId": number,
	"summary": boolean
}

ParamReportResultListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"company": {
		"id": number
	},
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamReportResultListByScheduleBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reportSchedule	ParamId	always		An object to contain the "id" of the reportSchedule.
reportSchedule.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reportSchedule": {
		"id": number
	},
	"reqId": number
}

ParamReportResultListByTemplateBaseParametersobject

Request description

Property	Type	Required	Default	Description
after	datetime	optional
before	datetime	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reportTemplate	ParamId	always		An object to contain the "id" of the reportTemplate.
reportTemplate.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"after": string,
	"before": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reportTemplate": {
		"id": number
	},
	"reqId": number
}

ParamReportResultMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportResult	Object.<string, ?>	always	A simple object to contain the ReportResult parameters.
reportResult.archive	boolean	optional	Indicates whether this report should be archived. Archived report ReportResult are stored for six months. Non-archive reports are purged after 24 hours.
reportResult.company	uint64?	create (complex)	The Company to which these report ReportResult belongs.
reportResult.id	uint64?	update	The unique identifier of the ReportResult you want to update.
reportResult.name	string maximum-length: 100	create	Name for the report ReportResult.
reportResult.notes	string	optional	Notes for these report ReportResult.
reportResult.options	Object.<string, ?>	create (complex)	Specified parameters for the report logic, targeted Assets, and filtering Places and/or regions.
reportResult.options.filtering	ReportFilterMode?	optional	The mechanism to use for filtering based on Places and regions.
reportResult.options.parameters	Array.<ReportParameter>	optional	A list of parameters to better shape the ReportResult.
reportResult.options.places	expression	optional	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportResult.options.regions	Array.<string>	optional	A list of provinces and states, where only Assets within those regions will be included in the ReportResult.
reportResult.options.scorecardRules	Object.<string, ?>	always	Rules used to generate ReportScorecard for the ReportResult.
reportResult.options.scorecardRules.baseScore	double	optional	Base score for the ReportScorecard.
reportResult.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	optional	Infraction parameters used to generate the final ReportScorecard.score.
reportResult.options.targets	expression	optional	A targeting expression for including/excluding Assets.
reportResult.template	uint64?	create (simple)	Identifier of the ReportTemplate used to help create these ReportResult.
reportResult.timezone	codified see: Timezone.code	create	The Timezone.code of the local timezone used to calculate times.
reportResult.type	ReportType?	create (complex)	The kind of logic used to build the report ReportResult.
reportResult.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportResult": {
		"archive": boolean,
		"company": number,
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"template": number,
		"timezone": string,
		"type": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamReportResultRestoreBaseParametersobject

Request description

Property	Type	Required	Description
reportResult	ParamId	always	An object to contain the "id" of the ReportResult.
reportResult.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportResult": {
		"id": number
	},
	"reqId": number
}

ParamReportScheduleBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportSchedules	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportSchedules": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamReportScheduleBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportSchedules	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportSchedules": [
		{
			"enabled": boolean,
			"id": number,
			"name": string,
			"notes": string,
			"notify": {
				"assets": string,
				"users": [
					string
				]
			},
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"owner": string,
			"repetition": {
				"end": string,
				"kind": string,
				"start": string,
				"timezone": string,
				"weekday": number,
				"weekdays": [
					boolean
				]
			},
			"template": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamReportScheduleDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportSchedule	ParamId	always	An object to contain the "id" of the ReportSchedule.
reportSchedule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportSchedule": {
		"id": number
	},
	"reqId": number
}

ParamReportScheduleGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted ReportSchedule.
reportSchedule	ParamId	always		An object to contain the "id" of the ReportSchedule.
reportSchedule.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"reportSchedule": {
		"id": number
	},
	"reqId": number
}

ParamReportScheduleListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamReportScheduleListByTemplateBaseParametersobject

Request description

Property	Type	Required	Default	Description
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reportTemplate	ParamId	always
reportTemplate.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reportTemplate": {
		"id": number
	},
	"reqId": number
}

ParamReportScheduleMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportSchedule	Object.<string, ?>	always	A simple object to contain the ReportSchedule parameters.
reportSchedule.enabled	boolean	optional	Indicates whether this schedule is allowed to run.
reportSchedule.id	uint64?	update	The unique identifier of the ReportSchedule you want to update.
reportSchedule.name	string maximum-length: 100	create	Name for the ReportSchedule.
reportSchedule.notes	string	optional	Notes for the ReportSchedule.
reportSchedule.notify	Object.<string, ?>	always	A list of users and a targeting expression for Assets which receive report results notifications.
reportSchedule.notify.assets	expression maximum-length: 255	optional	A targeting expression to identify which Assets receive the ReportResult.
reportSchedule.notify.users	Array.<email> maximum-count: 50	optional	List of Users to send emailed report. Each email will only contain the ReportResult for the Assets each User is allowed to view.
reportSchedule.options	Object.<string, ?>	always	Specified parameters for the report logic, targeted Assets, and filtering Places.
reportSchedule.options.filtering	ReportFilterMode?	optional	The mechanism to use for filtering based on Places and regions.
reportSchedule.options.parameters	Array.<ReportParameter>	optional	A list of parameters to better shape the ReportResult.
reportSchedule.options.places	expression	optional	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportSchedule.options.regions	Array.<string>	optional	A list of provinces and states, where only Assets within those regions will be included in the ReportResult.
reportSchedule.options.scorecardRules	Object.<string, ?>	always	Rules used to generate ReportScorecard for the ReportResult.
reportSchedule.options.scorecardRules.baseScore	double	optional	Base score for the ReportScorecard.
reportSchedule.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	optional	Infraction parameters used to generate the final ReportScorecard.score.
reportSchedule.options.targets	expression	optional	A targeting expression for including/excluding Assets.
reportSchedule.owner	email	create	The user which owns the schedule. When report results are created, they will be created with this user's Asset permissions.
reportSchedule.repetition	Object.<string, ?>	create	The recurring schedule to generate report results.
reportSchedule.repetition.end	datetime	optional	The optional time when the ReportSchedule stops recurring in local-time (not UTC).
reportSchedule.repetition.kind	ReportRecurrenceType?	optional	How often the report is automatically run. Daily, weekly, monthly, etc...
reportSchedule.repetition.start	datetime	optional	When the ReportSchedule is to begin recurring in local-time (not UTC).
reportSchedule.repetition.timezone	codified see: Timezone.code	optional	The local Timezone used to calculate recurring date/time ranges.
reportSchedule.repetition.weekday	byte?	optional	Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week.
reportSchedule.repetition.weekdays	Array.<boolean>	optional	Used only for daily schedules, this 7 item, boolean array, determines if the ReportSchedule should recur on that day of the week.
reportSchedule.template	uint64?	create	Identifier of the ReportTemplate used to help create results.
reportSchedule.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportSchedule": {
		"enabled": boolean,
		"id": number,
		"name": string,
		"notes": string,
		"notify": {
			"assets": string,
			"users": [
				string
			]
		},
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"owner": string,
		"repetition": {
			"end": string,
			"kind": string,
			"start": string,
			"timezone": string,
			"weekday": number,
			"weekdays": [
				boolean
			]
		},
		"template": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamReportScheduleRestoreBaseParametersobject

Request description

Property	Type	Required	Description
reportSchedule	ParamId	always	An object to contain the "id" of the ReportSchedule.
reportSchedule.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportSchedule": {
		"id": number
	},
	"reqId": number
}

ParamReportScorecardRulesobject

Parameter values for creating a new or updating an existing ReportScorecardRules.

JSON description

Property	Type	Description
baseScore	double	Base score for the ReportScorecard.
parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final ReportScorecard.score.

JSON structure

{
	"baseScore": number,
	"parameters": [
		{
			"condition": string,
			"duration": string,
			"points": number
		}
	]
}

ParamReportTemplateBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportTemplates	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportTemplates": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamReportTemplateBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportTemplates	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportTemplates": [
		{
			"company": number,
			"fill": string,
			"graphic": string,
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"stroke": string,
			"type": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamReportTemplateDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reportTemplate	ParamId	always	An object to contain the "id" of the ReportTemplate.
reportTemplate.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportTemplate": {
		"id": number
	},
	"reqId": number
}

ParamReportTemplateGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted ReportTemplate.
reportTemplate	ParamId	always		An object to contain the "id" of the ReportTemplate.
reportTemplate.id	uint64	always		Identifier given as input for the command.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"reportTemplate": {
		"id": number
	},
	"reqId": number
}

ParamReportTemplateListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamReportTemplateMergeBaseParametersobject

Request description

Property	Type	Required	Description
reportTemplate	Object.<string, ?>	always	A simple object to contain the ReportTemplate parameters.
reportTemplate.company	uint64?	create	The Company to which this ReportTemplate belongs.
reportTemplate.fill	string	optional	Background and fill colour in the UI.
reportTemplate.graphic	string	optional	The name of the symbol shown in the UI.
reportTemplate.id	uint64?	update	The unique identifier of the ReportTemplate you want to update.
reportTemplate.name	string maximum-length: 100	create	Name for the ReportTemplate.
reportTemplate.notes	string	optional	Notes about the ReportTemplate.
reportTemplate.options	Object.<string, ?>	always	Specified parameters for the report logic, targeted Assets, and filtering Places and/or regions.
reportTemplate.options.filtering	ReportFilterMode?	optional	The mechanism to use for filtering based on Places and regions.
reportTemplate.options.parameters	Array.<ReportParameter>	optional	A list of parameters to better shape the ReportResult.
reportTemplate.options.places	expression	optional	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportTemplate.options.regions	Array.<string>	optional	A list of provinces and states, where only Assets within those regions will be included in the ReportResult.
reportTemplate.options.scorecardRules	Object.<string, ?>	always	Rules used to generate ReportScorecard for the ReportResult.
reportTemplate.options.scorecardRules.baseScore	double	optional	Base score for the ReportScorecard.
reportTemplate.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	optional	Infraction parameters used to generate the final ReportScorecard.score.
reportTemplate.options.targets	expression	optional	A targeting expression for including/excluding Assets.
reportTemplate.stroke	string	optional	Text and outline colour in the UI.
reportTemplate.type	ReportType?	create	The kind of logic used to build the report results.
reportTemplate.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportTemplate": {
		"company": number,
		"fill": string,
		"graphic": string,
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"stroke": string,
		"type": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamReportTemplateRestoreBaseParametersobject

Request description

Property	Type	Required	Description
reportTemplate	ParamId	always	An object to contain the "id" of the ReportTemplate.
reportTemplate.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reportTemplate": {
		"id": number
	},
	"reqId": number
}

ReportBreakdownobject

Asset information used in calculating a summary instance.

JSON description

Property	Type	Description
advanced	AssetAdvanced	Advanced/detailed information used.
asset	uint64	The asset to which this event data belongs.
general	AssetGeneral	General Asset information.
instance	uint32	Report specific identifier of the event data.
summaryInstances	Array.<uint32>	Identifiers of the summary instances that used this event.

JSON structure

{
	"advanced": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"id": number,
		"odometer": number,
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"asset": number,
	"general": {
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"instance": number,
	"summaryInstances": [
		number
	]
}

ReportBreakdownJobReportBreakdownobject

Dispatch Job information used in this report.

JSON description

Property	Type	Description
advanced	AssetAdvanced	Advanced/detailed information used.
asset	uint64	The asset to which this event data belongs.
general	AssetGeneral	General Asset information.
instance	uint32	Report specific identifier of the event data.
job	DispatchJob	The Job used.
summaryInstances	Array.<uint32>	Identifiers of the summary instances that used this event.

JSON structure

{
	"advanced": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"id": number,
		"odometer": number,
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"asset": number,
	"general": {
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"instance": number,
	"job": {
		"asset": number,
		"attachments": [
			number
		],
		"company": number,
		"created": string,
		"driver": string,
		"forms": [
			number
		],
		"id": number,
		"instructions": string,
		"labels": [
			string
		],
		"name": string,
		"priority": string,
		"processedUtc": string,
		"references": {
			string: string
		},
		"steps": [
			{
				"address": string,
				"duration": string,
				"eta": string,
				"id": number,
				"latlng": {
					"lat": number,
					"lng": number
				},
				"name": string,
				"notes": string,
				"place": number,
				"signatory": string,
				"signature": boolean,
				"states": {
					string: {
						"latlng": {
							"lat": number,
							"lng": number
						},
						"updated": string
					}
				}
			}
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"summaryInstances": [
		number
	]
}

ReportBreakdownMessageReportBreakdownobject

Message information used in this report.

JSON description

Property	Type	Description
advanced	AssetAdvanced	Advanced/detailed information used.
asset	uint64	The asset to which this event data belongs.
general	AssetGeneral	General Asset information.
instance	uint32	Report specific identifier of the event data.
message	AssetMessage	The Message used.
summaryInstances	Array.<uint32>	Identifiers of the summary instances that used this event.

JSON structure

{
	"advanced": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"id": number,
		"odometer": number,
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"asset": number,
	"general": {
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"instance": number,
	"message": {
		"asset": number,
		"body": string,
		"company": number,
		"delivered": string,
		"folder": string,
		"from": string,
		"id": number,
		"incoming": boolean,
		"kind": string,
		"processed": string,
		"processedUtc": string,
		"readBy": string,
		"status": string,
		"subject": string,
		"to": string,
		"updated": {
		},
		"user": string,
		"v": [
			number
		]
	},
	"summaryInstances": [
		number
	]
}

ReportBreakdownTaskReportBreakdownobject

Dispatch Task information used in this report.

JSON description

Property	Type	Description
advanced	AssetAdvanced	Advanced/detailed information used.
asset	uint64	The asset to which this event data belongs.
general	AssetGeneral	General Asset information.
instance	uint32	Report specific identifier of the event data.
summaryInstances	Array.<uint32>	Identifiers of the summary instances that used this event.
task Deprecated	DispatchTask	The Task used. Use DispatchJob instead.

JSON structure

{
	"advanced": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"id": number,
		"odometer": number,
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"asset": number,
	"general": {
		"company": number,
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"pictures": [
			number
		],
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"instance": number,
	"summaryInstances": [
		number
	],
	"task": {
		"address": string,
		"arrived": string,
		"asset": number,
		"attachments": [
			number
		],
		"company": number,
		"completed": string,
		"created": string,
		"duration": string,
		"eta": string,
		"id": number,
		"instructions": string,
		"latlng": {
			"lat": number,
			"lng": number
		},
		"name": string,
		"notes": string,
		"place": number,
		"processedUtc": string,
		"reference": string,
		"references": {
			string: string
		},
		"signatory": string,
		"signature": boolean,
		"status": string,
		"updated": {
		},
		"v": [
			number
		]
	}
}

ReportDataSummaryReasonstring

The kind of reason associated with the range caps for a summary instance.

Value	Description
filterMatch	The asset started/stopped matching the report filter settings. For example, they left a province or entered a Place. see: ReportFilterMode
outsideRange	If the report starting/ending date range overlaps the actual start of the state.
split	The summary instance elapsed a Rubicon or prolonged parameter, and was split into two summary instances. see: ReportParameterType
stateMatch	The asset started/stopped matching the required state. For example, a status tag was added or removed.
targeted	The targeting query starts or stops matching. For example, the Asset's labels were changed.

ReportFilterModestring

Drill-down mechanism for highlighting only those places and regions desired in report results.

Value	Description
exclusive	Exclude all results except those whose filters match.
inclusive	Include any results for those whose filters match.
none	Filtering is not enabled for the report.

ReportNotificationsobject

A group of users and targeted assets which receive report notifications.

JSON description

Property	Type	Description
assets	expression	A targeting expression to identify which assets receive the report results. The results emailed to each asset will only be for themselves, not all assets. To receive the emailed results, the Asset must have a Asset.messagingAddress, or for a Person type asset, their Contact.emails["Email"].
users	Array.<email> for values see: UserGeneral.login maximum-length of values: 50	List of users to send emailed report. Each email will only contain the results for the assets each user is allowed to view.

JSON structure

{
	"assets": string,
	"users": [
		string
	]
}

ReportOptionsobject

The options used by the report runner to process results.

JSON description

Property	Type	Description
filtering	ReportFilterMode	The mechanism to use for filtering based on places and regions.
parameters	Array.<ReportParameter>	A list of parameters to better shape the results.
places	expression	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
regions	Array.<string>	A list of provinces and states, where only assets within those regions will be included in the results.
scorecardRules	ReportScorecardRules	Rules used to generate scorecard for this report.
targets	expression	A targeting expression for including/excluding Assets.

JSON structure

{
	"filtering": string,
	"parameters": [
		{
			"type": string,
			"value": string
		}
	],
	"places": string,
	"regions": [
		string
	],
	"scorecardRules": {
		"baseScore": number,
		"parameters": [
			{
				"condition": string,
				"duration": string,
				"points": number
			}
		]
	},
	"targets": string
}

ReportParameterobject

An argument passed to the report runner.

JSON description

Property	Type	Description
type	ReportParameterType	The type of argument.
value	string	The parsed value of the argument. Each type of argument has a different parsing.

JSON structure

{
	"type": string,
	"value": string
}

ReportParameterTypestring

The kinds of parameters required and optional to build Report Results

Value	Description
attributes	A list of attribute names an Asset must have to be included in the results. Should be a comma separated string of codified tag names.
collate	A choice in the method used to calculate a Summary Instance's values. For an attribute report, the possible values are "instance" where if the attribute is present it is included, and "value" where each attribute's simple value becomes it's own summary instance. For a Tag Summary report, the possible values are "inclusive" where any of the given tags must match, and "exclusive" where all the given tags must match.
distance	The minimum distance travelled in a Summary Instance before it is included in the results. Supplied as a number of meters.
duration	The minimum amount of time for a Summary nice before it is included in the results. Supplied as a duration string.
endDate	The ending date/time range for events to be included in the results. The date should be a valid ISO-8601 string.
prolonged	The maximum amount of time in a Summary Instance before it is split into two and the latter marked as an exception in the results. Supplied as a duration string.
rubicon	The maximum distance travelled in a Summary Instance before it is split into two and the latter marked as an exception in the results. Supplied as a number of meters.
startDate	The staring date/time range for events to be included in the results. The date should be a valid ISO-8601 string.
tags	A list of status tags an Asset must have to be included in the results. Should be a comma separated string of codified tag names.
timeOfDay	Time-span processed on each day. Only data within the time-span is included in the results. The times should be 2 space separated duration strings.

ReportRecurrenceobject

Determines when and how often a report schedule runs automatically.

JSON description

Property	Type	Description
end	datetime	The optional time when the schedule stops recurring in local-time (not UTC).
iterations	uint16	The number of times this schedule has been invoked to generate results.
kind	ReportRecurrenceType	How often the report is automatically run. Daily, weekly, monthly, etc...
lastEndDate	datetime	The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once.
lastResult	uint64?	The unique identifier of the last ReportResult generated by this schedule.
lastStartDate	datetime	The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once.
nextEndDate	datetime	This date/time is used as the endDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring.
nextStartDate	datetime	This date/time is used as the startDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring.
start	datetime	When the schedule is to begin recurring in local-time (not UTC).
timezone	codified see: Timezone.code	The local timezone used to calculate recurring date/time ranges.
weekday	byte	Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week.
weekdays	Array.<boolean> fixed count: 7	Used only for daily schedules, this 7 item, boolean array, determines if the schedule should recur on that day of the week.

JSON structure

{
	"end": string,
	"iterations": number,
	"kind": string,
	"lastEndDate": string,
	"lastResult": number,
	"lastStartDate": string,
	"nextEndDate": string,
	"nextStartDate": string,
	"start": string,
	"timezone": string,
	"weekday": number,
	"weekdays": [
		boolean
	]
}

ReportRecurrenceTypestring

Specifies how often a Report Template is automatically generates a Report Result.

Value	Description
annually	Yearly at midnight in the local timezone based on the ReportRecurrence.start date. see: ReportRecurrence.start
daily	Daily at midnight in the local timezone for the previous day based on the ReportRecurrence.weekdays. see: ReportRecurrence.weekdays
monthly	Monthly at midnight in the local timezone for the previous month based on the ReportRecurrence.start date. see: ReportRecurrence.start
once	Runs only once. This type is used for large reports which need to run overnight.
quarterly	Runs once every three months at midnight in the local timezone for the previous 3 months based on the ReportRecurrence.start date. see: ReportRecurrence.start
weekly	Weekly at midnight in the local timezone for the previous 7 days based on the ReportRecurrence.weekday. see: ReportRecurrence.weekday

ReportResultobject

Report results

JSON description

Property	Type	Description
archive	boolean	Preserve these results for later review. Results are regularly culled from the system.
bounds	LatLngBounds	After processing, the boundary of the results are given so that a map can be focused on that area.
company	uint64 see: Company.id	The company to which this report belongs
completed	datetime	The date/time this result was finished processing.
created	datetime	The date/time this result was requested.
error	string see: ReportStatus maximum-length: 250	A field which contains report error details if the ReportResult.status is ReportStatus.failed.
filtered	Array.<uint64>	When the report runs, a list of filtered places is calculated based on the ReportOption's place filtering expression.
id	uint64	Unique identifier
name	string maximum-length: 100	Name of this report.
notes	string	Notes about this report.
options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
processedUtc	datetime	When the was change procesed.
progress	byte	The progress in processing/saving this result is a number between 0 and 100.
runBy	email see: User.login maximum-length: 254	The login of the user that ran this report.
schedule	uint64? see: ReportSchedule.id	A reference to the schedule used to create this result. This field is optional as not all results are created on a schedule.
scorecards	Array.<ReportScorecard>	Scorecards for all the targeted assets based on the scorecard rules.
status	ReportStatus	The processing status of this report.
targeted	Array.<uint64>	When the report runs, a list of targeted assets is calculated based on the ReportOption's targeting expression.
template	uint64? see: ReportTemplate.id	A reference to the Template used to create this result. This field is optional because templates are not necessarily required; they just make life a lot easier.
timezone	codified see: Timezone.code	The timezone code used to adjust dates/times used in processing and saving this report.
totals	Array.<ReportTotal>	After processing, the report totals the values from all summary instances for a quick overview of the kind of results generated.
type	ReportType	Refers to the type of logic used by this report.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"archive": boolean,
	"bounds": {
		"east": number,
		"north": number,
		"south": number,
		"west": number
	},
	"company": number,
	"completed": string,
	"created": string,
	"error": string,
	"filtered": [
		number
	],
	"id": number,
	"name": string,
	"notes": string,
	"options": {
		"filtering": string,
		"parameters": [
			{
				"type": string,
				"value": string
			}
		],
		"places": string,
		"regions": [
			string
		],
		"scorecardRules": {
			"baseScore": number,
			"parameters": [
				{
					"condition": string,
					"duration": string,
					"points": number
				}
			]
		},
		"targets": string
	},
	"processedUtc": string,
	"progress": number,
	"runBy": string,
	"schedule": number,
	"scorecards": [
		{
			"asset": number,
			"rulePoints": {
				string: number
			},
			"score": number
		}
	],
	"status": string,
	"targeted": [
		number
	],
	"template": number,
	"timezone": string,
	"totals": [
		{
			"asset": number,
			"distance": number,
			"duration": string,
			"stateDetail": string,
			"summaryCount": number,
			"value": number,
			"valueType": string
		}
	],
	"type": string,
	"updated": {
	},
	"v": [
		number
	]
}

ReportResultDeletedobject

The message format for when a deleted ReportResult is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this report belongs
deleted	boolean	`true`
id	uint64		Unique identifier
name	string maximum-length: 100		Name of this report.
notes	string		Notes about this report.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ReportScheduleobject

Determines when and how often a report schedule runs automatically.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this report belongs
enabled	boolean	Indicates whether this schedule is allowed to run.
id	uint64	Unique identifier
name	string maximum-length: 100	Name of this report.
notes	string	Notes about this report.
notify	ReportNotifications	A list of users and a targeting expression for assets which receive report results notifications.
options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
owner	email see: User.login maximum-length: 254	Login of the user who has ownership of this report schedule.
processedUtc	datetime	When the was change procesed.
repetition	ReportRecurrence	The recurring schedule to generate report results.
template	uint64 see: ReportTemplate.id	A reference to the Template used to create this result.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"enabled": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"notify": {
		"assets": string,
		"users": [
			string
		]
	},
	"options": {
		"filtering": string,
		"parameters": [
			{
				"type": string,
				"value": string
			}
		],
		"places": string,
		"regions": [
			string
		],
		"scorecardRules": {
			"baseScore": number,
			"parameters": [
				{
					"condition": string,
					"duration": string,
					"points": number
				}
			]
		},
		"targets": string
	},
	"owner": string,
	"processedUtc": string,
	"repetition": {
		"end": string,
		"iterations": number,
		"kind": string,
		"lastEndDate": string,
		"lastResult": number,
		"lastStartDate": string,
		"nextEndDate": string,
		"nextStartDate": string,
		"start": string,
		"timezone": string,
		"weekday": number,
		"weekdays": [
			boolean
		]
	},
	"template": number,
	"updated": {
	},
	"v": [
		number
	]
}

ReportScheduleDeletedobject

The message format for when a deleted ReportSchedule is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this report belongs
deleted	boolean	`true`
id	uint64		Unique identifier
name	string maximum-length: 100		Name of this report.
notes	string		Notes about this report.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ReportScorecardobject

Scorecard generated from the results of this report.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this scorecard belongs.
rulePoints	Object.<string, double>	Points per rule
score	double	Final score calculated based on scorecard rules.

JSON structure

{
	"asset": number,
	"rulePoints": {
		string: number
	},
	"score": number
}

ReportScorecardParameterobject

Infraction parameter used to generate scorecard

JSON description

Property	Type	Description
condition	string	Type of exception, example speeding, idling, etc.
duration	timespan	Threshold per instance. If the threshold is 0, each instance is used in the calculation
points	double	Points applied against the base score per instance

JSON structure

{
	"condition": string,
	"duration": string,
	"points": number
}

ReportScorecardRulesobject

Rules used for generating a scorecard.

JSON description

Property	Type	Description
baseScore	double	Base score for the scorecard.
parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final score

JSON structure

{
	"baseScore": number,
	"parameters": [
		{
			"condition": string,
			"duration": string,
			"points": number
		}
	]
}

ReportStatusstring

The lifetime of building a ReportResult.

Value	Description
completed	The ReportResult is available for retrieval.
created	The ReportResult has been requested, but not yet begun processing.
failed	There was an error processing the ReportResult; see the ReportResult.error for a description.
queued	The ReportResult is waiting for required resources to begin processing.
running	The ReportResult is currently being processed.
saving	The ReportResult results have been calculated, and are being saved for review.

ReportSummaryobject

Summarized asset details.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this summary instance belongs.
distance	double	The distance travelled in kilometres by the asset during this summary instance.
endingReason	ReportDataSummaryReason	The reason code that this summary instance ended.
endingUtc	datetime	Date/time stamp of the last event in this summary's sequence.
firstState	Asset	The first asset state which begins this summary instance.
instance	uint32	Identifier of the summary instance in the report.
instancesCount	uint32	The number of events included in calculating this summary instance.
lastState	Asset	The asset state that ended this summary instance.
polyline	Array.<LatLng>	A simplified polyline of all the asset's positions in sequence.
startingReason	ReportDataSummaryReason	The reason code that this summary instance began.
startingUtc	datetime	Date/time stamp of the first event in this summary's sequence.
stateDetail	string maximum-length: 100	Code given to this summary instance for an asset.

JSON structure

{
	"asset": number,
	"distance": number,
	"endingReason": string,
	"endingUtc": string,
	"firstState": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"dispatch": {
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		},
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messages": [
			{
				"asset": number,
				"body": string,
				"company": number,
				"delivered": string,
				"folder": string,
				"from": string,
				"id": number,
				"incoming": boolean,
				"kind": string,
				"processed": string,
				"processedUtc": string,
				"readBy": string,
				"status": string,
				"subject": string,
				"to": string,
				"updated": {
				},
				"user": string,
				"v": [
					number
				]
			}
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"reference": string,
		"references": {
			string: string
		},
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"instance": number,
	"instancesCount": number,
	"lastState": {
		"attributes": {
			string: {
				"asset": number,
				"complex": string,
				"dts": string,
				"global": boolean,
				"name": string,
				"provider": string,
				"raw": Object,
				"simple": string,
				"unit": string
			}
		},
		"company": number,
		"dispatch": {
			"company": number,
			"directions": [
				{
					"directions": [
						{ /* recursive DispatchDirection objects */ }
					],
					"distance": number,
					"duration": string,
					"instructions": string,
					"job": number,
					"path": string,
					"step": number
				}
			],
			"id": number,
			"jobs": [
				number
			],
			"lastDispatched": string,
			"processedUtc": string,
			"tasks": [
				{
					"address": string,
					"arrived": string,
					"asset": number,
					"attachments": [
						number
					],
					"company": number,
					"completed": string,
					"created": string,
					"duration": string,
					"eta": string,
					"id": number,
					"instructions": string,
					"latlng": {
						"lat": number,
						"lng": number
					},
					"name": string,
					"notes": string,
					"place": number,
					"processedUtc": string,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"updated": {
					},
					"v": [
						number
					]
				}
			],
			"updated": {
			},
			"v": [
				number
			]
		},
		"icon": number,
		"id": number,
		"kind": string,
		"labels": [
			string
		],
		"messages": [
			{
				"asset": number,
				"body": string,
				"company": number,
				"delivered": string,
				"folder": string,
				"from": string,
				"id": number,
				"incoming": boolean,
				"kind": string,
				"processed": string,
				"processedUtc": string,
				"readBy": string,
				"status": string,
				"subject": string,
				"to": string,
				"updated": {
				},
				"user": string,
				"v": [
					number
				]
			}
		],
		"messagingAddress": string,
		"name": string,
		"notes": string,
		"odometer": number,
		"pictures": [
			number
		],
		"places": {
			string: {
				"enter": string,
				"kind": string,
				"latest": string
			}
		},
		"position": {
			"accuracy": number,
			"address": string,
			"altitude": number,
			"bearing": number,
			"dts": string,
			"lat": number,
			"lng": number,
			"origin": string,
			"speed": number,
			"speedLimit": number,
			"streetAddress": {
				"city": string,
				"country": string,
				"isToll": boolean,
				"number": string,
				"postal": string,
				"province": string,
				"region": string,
				"street": string
			}
		},
		"processedUtc": string,
		"providers": [
			string
		],
		"reference": string,
		"references": {
			string: string
		},
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"updated": {
		},
		"v": [
			number
		]
	},
	"polyline": [
		{
			"lat": number,
			"lng": number
		}
	],
	"startingReason": string,
	"startingUtc": string,
	"stateDetail": string
}

ReportTemplateobject

A partially created report used to quickly build results.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this report belongs
fill	colour maximum-length: 22	The fill/background colour of the icon.
graphic	codified maximum-length: 22	The name of the symbol for this report.
id	uint64	Unique identifier
name	string maximum-length: 100	Name of this report.
notes	string	Notes about this report.
options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
processedUtc	datetime	When the was change procesed.
stroke	colour maximum-length: 22	Outline and graphic colour.
type	ReportType	Refers to the type of logic used by this report.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"fill": string,
	"graphic": string,
	"id": number,
	"name": string,
	"notes": string,
	"options": {
		"filtering": string,
		"parameters": [
			{
				"type": string,
				"value": string
			}
		],
		"places": string,
		"regions": [
			string
		],
		"scorecardRules": {
			"baseScore": number,
			"parameters": [
				{
					"condition": string,
					"duration": string,
					"points": number
				}
			]
		},
		"targets": string
	},
	"processedUtc": string,
	"stroke": string,
	"type": string,
	"updated": {
	},
	"v": [
		number
	]
}

ReportTemplateDeletedobject

The message format for when a deleted ReportTemplate is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this report belongs
deleted	boolean	`true`
id	uint64		Unique identifier
name	string maximum-length: 100		Name of this report.
notes	string		Notes about this report.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

ReportTotalobject

Totalled information from all the results of the report.

JSON description

Property	Type	Description
asset	uint64 see: Asset.id	The asset to which this report total belongs.
distance	double	The total distance travelled in kilometres of all summary instances.
duration	timespan	The total duration of all summary instances.
stateDetail	string maximum-length: 100	Unique code given to the report total.
summaryCount	uint32	The number of summary instances included in this total.
value	double	The total value of all summary instances.
valueType	string	The type of totalled value.

JSON structure

{
	"asset": number,
	"distance": number,
	"duration": string,
	"stateDetail": string,
	"summaryCount": number,
	"value": number,
	"valueType": string
}

ReportTypestring

The type of logic used by the report runner.

Value	Description
attributes	Summarizes the timeline based on the given attributes and thresholds.
full	Processes all history for the assets.
jobs	Summarizes the timeline based on the asset's jobs's lifetimes.
messages	Processes the log of messages sent to and from the assets.
places	Summarizes the timeline based on places visited.
regions	Summarizes the timeline based on the regions (cities, provinces/states, countries) through which the assets travelled.
tags	Summarizes the timeline based on the given tags.
tasks Deprecated	Summarizes the timeline based on the asset's task's lifetimes. Use .jobs instead.

RespReportResultBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResults	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResults": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportResultBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResults	Array.<RespIdCompanyTemplate>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResults": [
		{
			"company": number,
			"id": number,
			"template": number
		}
	],
	"reqId": number
}

RespReportResultDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResult	RespDeleted	An object which contains the ReportResult's id, owning Company id, and deleted status.
reportResult.company	uint64	Identifier of the Company to which this object belongs.
reportResult.deleted	boolean	Flag showing if the object is deleted.
reportResult.id	uint64?	Identifier given as input for the command.
reportResult.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResult": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportResultGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResult	ReportResult	The requested ReportResult.
reportResult.archive	boolean	Preserve these results for later review. Results are regularly culled from the system.
reportResult.bounds	LatLngBounds	After processing, the boundary of the results are given so that a map can be focused on that area.
reportResult.bounds.east	double	Eastern longitude
reportResult.bounds.north	double	Northern latitude
reportResult.bounds.south	double	Southern latitude
reportResult.bounds.west	double	Western longitude
reportResult.company	uint64 see: Company.id	The company to which this report belongs
reportResult.completed	datetime	The date/time this result was finished processing.
reportResult.created	datetime	The date/time this result was requested.
reportResult.error	string see: ReportStatus maximum-length: 250	A field which contains report error details if the ReportResult.status is ReportStatus.failed.
reportResult.filtered	Array.<uint64>	When the report runs, a list of filtered places is calculated based on the ReportOption's place filtering expression.
reportResult.id	uint64	Unique identifier
reportResult.name	string maximum-length: 100	Name of this report.
reportResult.notes	string	Notes about this report.
reportResult.options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
reportResult.options.filtering	ReportFilterMode	The mechanism to use for filtering based on places and regions.
reportResult.options.parameters	Array.<ReportParameter>	A list of parameters to better shape the results.
reportResult.options.places	expression	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportResult.options.regions	Array.<string>	A list of provinces and states, where only assets within those regions will be included in the results.
reportResult.options.scorecardRules	ReportScorecardRules	Rules used to generate scorecard for this report.
reportResult.options.scorecardRules.baseScore	double	Base score for the scorecard.
reportResult.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final score
reportResult.options.targets	expression	A targeting expression for including/excluding Assets.
reportResult.processedUtc	datetime	When the was change procesed.
reportResult.progress	byte	The progress in processing/saving this result is a number between 0 and 100.
reportResult.runBy	email see: User.login maximum-length: 254	The login of the user that ran this report.
reportResult.schedule	uint64? see: ReportSchedule.id	A reference to the schedule used to create this result. This field is optional as not all results are created on a schedule.
reportResult.scorecards	Array.<ReportScorecard>	Scorecards for all the targeted assets based on the scorecard rules.
reportResult.status	ReportStatus	The processing status of this report.
reportResult.targeted	Array.<uint64>	When the report runs, a list of targeted assets is calculated based on the ReportOption's targeting expression.
reportResult.template	uint64? see: ReportTemplate.id	A reference to the Template used to create this result. This field is optional because templates are not necessarily required; they just make life a lot easier.
reportResult.timezone	codified see: Timezone.code	The timezone code used to adjust dates/times used in processing and saving this report.
reportResult.totals	Array.<ReportTotal>	After processing, the report totals the values from all summary instances for a quick overview of the kind of results generated.
reportResult.type	ReportType	Refers to the type of logic used by this report.
reportResult.updated		by: login, from: monster
reportResult.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResult": {
		"archive": boolean,
		"bounds": {
			"east": number,
			"north": number,
			"south": number,
			"west": number
		},
		"company": number,
		"completed": string,
		"created": string,
		"error": string,
		"filtered": [
			number
		],
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"processedUtc": string,
		"progress": number,
		"runBy": string,
		"schedule": number,
		"scorecards": [
			{
				"asset": number,
				"rulePoints": {
					string: number
				},
				"score": number
			}
		],
		"status": string,
		"targeted": [
			number
		],
		"template": number,
		"timezone": string,
		"totals": [
			{
				"asset": number,
				"distance": number,
				"duration": string,
				"stateDetail": string,
				"summaryCount": number,
				"value": number,
				"valueType": string
			}
		],
		"type": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportResultListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of ReportResults belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResults	Array.<ReportResult>	The list of requested ReportResults.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResults": [
		{
			"archive": boolean,
			"bounds": {
				"east": number,
				"north": number,
				"south": number,
				"west": number
			},
			"company": number,
			"completed": string,
			"created": string,
			"error": string,
			"filtered": [
				number
			],
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"processedUtc": string,
			"progress": number,
			"runBy": string,
			"schedule": number,
			"scorecards": [
				{
					"asset": number,
					"rulePoints": {
						string: number
					},
					"score": number
				}
			],
			"status": string,
			"targeted": [
				number
			],
			"template": number,
			"timezone": string,
			"totals": [
				{
					"asset": number,
					"distance": number,
					"duration": string,
					"stateDetail": string,
					"summaryCount": number,
					"value": number,
					"valueType": string
				}
			],
			"type": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportResultListByScheduleBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResults	Array.<ReportResult>	The list of requested ReportResults.
reportSchedule	RespIdCompany	An object to contain the "id" of the ReportSchedule to which the array of ReportResults belong.
reportSchedule.company	uint64	Identifier of the Company to which this object belongs.
reportSchedule.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResults": [
		{
			"archive": boolean,
			"bounds": {
				"east": number,
				"north": number,
				"south": number,
				"west": number
			},
			"company": number,
			"completed": string,
			"created": string,
			"error": string,
			"filtered": [
				number
			],
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"processedUtc": string,
			"progress": number,
			"runBy": string,
			"schedule": number,
			"scorecards": [
				{
					"asset": number,
					"rulePoints": {
						string: number
					},
					"score": number
				}
			],
			"status": string,
			"targeted": [
				number
			],
			"template": number,
			"timezone": string,
			"totals": [
				{
					"asset": number,
					"distance": number,
					"duration": string,
					"stateDetail": string,
					"summaryCount": number,
					"value": number,
					"valueType": string
				}
			],
			"type": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reportSchedule": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespReportResultListByTemplateBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResults	Array.<ReportResult>	The list of requested ReportResults.
reportTemplate	RespIdCompany	An object to contain the "id" of the ReportTemplate to which the array of ReportResults belong.
reportTemplate.company	uint64	Identifier of the Company to which this object belongs.
reportTemplate.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResults": [
		{
			"archive": boolean,
			"bounds": {
				"east": number,
				"north": number,
				"south": number,
				"west": number
			},
			"company": number,
			"completed": string,
			"created": string,
			"error": string,
			"filtered": [
				number
			],
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"processedUtc": string,
			"progress": number,
			"runBy": string,
			"schedule": number,
			"scorecards": [
				{
					"asset": number,
					"rulePoints": {
						string: number
					},
					"score": number
				}
			],
			"status": string,
			"targeted": [
				number
			],
			"template": number,
			"timezone": string,
			"totals": [
				{
					"asset": number,
					"distance": number,
					"duration": string,
					"stateDetail": string,
					"summaryCount": number,
					"value": number,
					"valueType": string
				}
			],
			"type": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reportTemplate": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespReportResultMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResult	RespIdCompanyTemplate	An object which contains the "id", "company", and "template" keys.
reportResult.company	uint64	Identifier of the Company to which this object belongs.
reportResult.id	uint64?	Identifier given as input for the command.
reportResult.template	uint64?	Identifier of the ReportTemplate the report object implements.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResult": {
		"company": number,
		"id": number,
		"template": number
	},
	"reqId": number
}

RespReportResultRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportResult	RespDeleted	An object which contains the ReportResult's id, owning Company id, and deleted status.
reportResult.company	uint64	Identifier of the Company to which this object belongs.
reportResult.deleted	boolean	Flag showing if the object is deleted.
reportResult.id	uint64?	Identifier given as input for the command.
reportResult.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportResult": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportScheduleBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedules	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedules": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportScheduleBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedules	Array.<RespIdCompanyTemplate>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedules": [
		{
			"company": number,
			"id": number,
			"template": number
		}
	],
	"reqId": number
}

RespReportScheduleDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedule	RespDeleted	An object which contains the ReportSchedule's id, owning Company id, and deleted status.
reportSchedule.company	uint64	Identifier of the Company to which this object belongs.
reportSchedule.deleted	boolean	Flag showing if the object is deleted.
reportSchedule.id	uint64?	Identifier given as input for the command.
reportSchedule.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportScheduleGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedule	ReportSchedule	The requested ReportSchedule.
reportSchedule.company	uint64 see: Company.id	The company to which this report belongs
reportSchedule.enabled	boolean	Indicates whether this schedule is allowed to run.
reportSchedule.id	uint64	Unique identifier
reportSchedule.name	string maximum-length: 100	Name of this report.
reportSchedule.notes	string	Notes about this report.
reportSchedule.notify	ReportNotifications	A list of users and a targeting expression for assets which receive report results notifications.
reportSchedule.notify.assets	expression	A targeting expression to identify which assets receive the report results. The results emailed to each asset will only be for themselves, not all assets. To receive the emailed results, the Asset must have a Asset.messagingAddress, or for a Person type asset, their Contact.emails["Email"].
reportSchedule.notify.users	Array.<email> for values see: UserGeneral.login maximum-length of values: 50	List of users to send emailed report. Each email will only contain the results for the assets each user is allowed to view.
reportSchedule.options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
reportSchedule.options.filtering	ReportFilterMode	The mechanism to use for filtering based on places and regions.
reportSchedule.options.parameters	Array.<ReportParameter>	A list of parameters to better shape the results.
reportSchedule.options.places	expression	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportSchedule.options.regions	Array.<string>	A list of provinces and states, where only assets within those regions will be included in the results.
reportSchedule.options.scorecardRules	ReportScorecardRules	Rules used to generate scorecard for this report.
reportSchedule.options.scorecardRules.baseScore	double	Base score for the scorecard.
reportSchedule.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final score
reportSchedule.options.targets	expression	A targeting expression for including/excluding Assets.
reportSchedule.owner	email see: User.login maximum-length: 254	Login of the user who has ownership of this report schedule.
reportSchedule.processedUtc	datetime	When the was change procesed.
reportSchedule.repetition	ReportRecurrence	The recurring schedule to generate report results.
reportSchedule.repetition.end	datetime	The optional time when the schedule stops recurring in local-time (not UTC).
reportSchedule.repetition.iterations	uint16	The number of times this schedule has been invoked to generate results.
reportSchedule.repetition.kind	ReportRecurrenceType	How often the report is automatically run. Daily, weekly, monthly, etc...
reportSchedule.repetition.lastEndDate	datetime	The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once.
reportSchedule.repetition.lastResult	uint64?	The unique identifier of the last ReportResult generated by this schedule.
reportSchedule.repetition.lastStartDate	datetime	The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once.
reportSchedule.repetition.nextEndDate	datetime	This date/time is used as the endDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring.
reportSchedule.repetition.nextStartDate	datetime	This date/time is used as the startDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring.
reportSchedule.repetition.start	datetime	When the schedule is to begin recurring in local-time (not UTC).
reportSchedule.repetition.timezone	codified see: Timezone.code	The local timezone used to calculate recurring date/time ranges.
reportSchedule.repetition.weekday	byte	Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week.
reportSchedule.repetition.weekdays	Array.<boolean> fixed count: 7	Used only for daily schedules, this 7 item, boolean array, determines if the schedule should recur on that day of the week.
reportSchedule.template	uint64 see: ReportTemplate.id	A reference to the Template used to create this result.
reportSchedule.updated		by: login, from: monster
reportSchedule.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedule": {
		"company": number,
		"enabled": boolean,
		"id": number,
		"name": string,
		"notes": string,
		"notify": {
			"assets": string,
			"users": [
				string
			]
		},
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"owner": string,
		"processedUtc": string,
		"repetition": {
			"end": string,
			"iterations": number,
			"kind": string,
			"lastEndDate": string,
			"lastResult": number,
			"lastStartDate": string,
			"nextEndDate": string,
			"nextStartDate": string,
			"start": string,
			"timezone": string,
			"weekday": number,
			"weekdays": [
				boolean
			]
		},
		"template": number,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportScheduleListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedules	Array.<ReportSchedule>	The list of schedules.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedules": [
		{
			"company": number,
			"enabled": boolean,
			"id": number,
			"name": string,
			"notes": string,
			"notify": {
				"assets": string,
				"users": [
					string
				]
			},
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"owner": string,
			"processedUtc": string,
			"repetition": {
				"end": string,
				"iterations": number,
				"kind": string,
				"lastEndDate": string,
				"lastResult": number,
				"lastStartDate": string,
				"nextEndDate": string,
				"nextStartDate": string,
				"start": string,
				"timezone": string,
				"weekday": number,
				"weekdays": [
					boolean
				]
			},
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportScheduleListByTemplateBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedules	Array.<ReportSchedule>	The list of schedules.
reportTemplate	RespIdCompany	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
reportTemplate.company	uint64	Identifier of the Company to which this object belongs.
reportTemplate.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedules": [
		{
			"company": number,
			"enabled": boolean,
			"id": number,
			"name": string,
			"notes": string,
			"notify": {
				"assets": string,
				"users": [
					string
				]
			},
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"owner": string,
			"processedUtc": string,
			"repetition": {
				"end": string,
				"iterations": number,
				"kind": string,
				"lastEndDate": string,
				"lastResult": number,
				"lastStartDate": string,
				"nextEndDate": string,
				"nextStartDate": string,
				"start": string,
				"timezone": string,
				"weekday": number,
				"weekdays": [
					boolean
				]
			},
			"template": number,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reportTemplate": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespReportScheduleMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedule	RespIdCompanyTemplate	An object which contains the "id", "company", and "template" keys.
reportSchedule.company	uint64	Identifier of the Company to which this object belongs.
reportSchedule.id	uint64?	Identifier given as input for the command.
reportSchedule.template	uint64?	Identifier of the ReportTemplate the report object implements.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedule": {
		"company": number,
		"id": number,
		"template": number
	},
	"reqId": number
}

RespReportScheduleRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportSchedule	RespDeleted	An object which contains the ReportSchedule's id, owning Company id, and deleted status.
reportSchedule.company	uint64	Identifier of the Company to which this object belongs.
reportSchedule.deleted	boolean	Flag showing if the object is deleted.
reportSchedule.id	uint64?	Identifier given as input for the command.
reportSchedule.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportSchedule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportTemplateBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplates	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplates": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportTemplateBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplates	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplates": [
		{
			"company": number,
			"id": number
		}
	],
	"reqId": number
}

RespReportTemplateDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplate	RespDeleted	An object which contains the ReportTemplate's id, owning Company id, and deleted status.
reportTemplate.company	uint64	Identifier of the Company to which this object belongs.
reportTemplate.deleted	boolean	Flag showing if the object is deleted.
reportTemplate.id	uint64?	Identifier given as input for the command.
reportTemplate.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplate": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportTemplateGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplate	ReportTemplate	The requested ReportTemplate.
reportTemplate.company	uint64 see: Company.id	The company to which this report belongs
reportTemplate.fill	colour maximum-length: 22	The fill/background colour of the icon.
reportTemplate.graphic	codified maximum-length: 22	The name of the symbol for this report.
reportTemplate.id	uint64	Unique identifier
reportTemplate.name	string maximum-length: 100	Name of this report.
reportTemplate.notes	string	Notes about this report.
reportTemplate.options	ReportOptions	Specified parameters for the report logic, targeted Assets, and filtering Places.
reportTemplate.options.filtering	ReportFilterMode	The mechanism to use for filtering based on places and regions.
reportTemplate.options.parameters	Array.<ReportParameter>	A list of parameters to better shape the results.
reportTemplate.options.places	expression	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportTemplate.options.regions	Array.<string>	A list of provinces and states, where only assets within those regions will be included in the results.
reportTemplate.options.scorecardRules	ReportScorecardRules	Rules used to generate scorecard for this report.
reportTemplate.options.scorecardRules.baseScore	double	Base score for the scorecard.
reportTemplate.options.scorecardRules.parameters	Array.<ReportScorecardParameter>	Infraction parameters used to generate the final score
reportTemplate.options.targets	expression	A targeting expression for including/excluding Assets.
reportTemplate.processedUtc	datetime	When the was change procesed.
reportTemplate.stroke	colour maximum-length: 22	Outline and graphic colour.
reportTemplate.type	ReportType	Refers to the type of logic used by this report.
reportTemplate.updated		by: login, from: monster
reportTemplate.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplate": {
		"company": number,
		"fill": string,
		"graphic": string,
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,
			"parameters": [
				{
					"type": string,
					"value": string
				}
			],
			"places": string,
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,
				"parameters": [
					{
						"condition": string,
						"duration": string,
						"points": number
					}
				]
			},
			"targets": string
		},
		"processedUtc": string,
		"stroke": string,
		"type": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"reqId": number
}

RespReportTemplateListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of ReportTemplates belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplates	Array.<ReportTemplate>	The list of requested ReportTemplates.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplates": [
		{
			"company": number,
			"fill": string,
			"graphic": string,
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				"filtering": string,
				"parameters": [
					{
						"type": string,
						"value": string
					}
				],
				"places": string,
				"regions": [
					string
				],
				"scorecardRules": {
					"baseScore": number,
					"parameters": [
						{
							"condition": string,
							"duration": string,
							"points": number
						}
					]
				},
				"targets": string
			},
			"processedUtc": string,
			"stroke": string,
			"type": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

RespReportTemplateMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplate	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
reportTemplate.company	uint64	Identifier of the Company to which this object belongs.
reportTemplate.id	uint64?	Identifier given as input for the command.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplate": {
		"company": number,
		"id": number
	},
	"reqId": number
}

RespReportTemplateRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reportTemplate	RespDeleted	An object which contains the ReportTemplate's id, owning Company id, and deleted status.
reportTemplate.company	uint64	Identifier of the Company to which this object belongs.
reportTemplate.deleted	boolean	Flag showing if the object is deleted.
reportTemplate.id	uint64?	Identifier given as input for the command.
reportTemplate.v	Array.<uint32>
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reportTemplate": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"reqId": number
}

Self

ParamSelfDetailsBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

ParamSelfIsLoggedInBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

ParamSelfLoginBaseParametersobject

Request description

Property	Type	Required	Description
password	string	always	User's password.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userAgent	string	optional	Application name. This should match the allowed applications from user's company's SessionPolicy.applications.
username	string	always	User's email address.

Request structure

{
	"password": string,
	"reqId": number,
	"userAgent": string,
	"username": string
}

ParamSelfLogoutBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"reqId": number
}

ParamSelfRecoverCompleteBaseParametersobject

Request description

Property	Type	Required	Description
guid	guid	always	Unique code to identify the password reset request.
length	uint32?	optional	Optionally specified minimum length for the temporary password.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"guid": string,
	"length": number,
	"reqId": number
}

ParamSelfRecoverStartBaseParametersobject

Request description

Property	Type	Required	Description
key	string	optional	Optional key in the User's Contact.emails address list to use for recovery.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
username	string	always	User's email address.

Request structure

{
	"key": string,
	"reqId": number,
	"username": string
}

ParamSelfUpdateContactBaseParametersobject

Request description

Property	Type	Required	Description
addresses	Object.<string, string>	optional	Mailing addresses Use the object key like a name of the address. Example keys: Home, Work, Park, etc.
dates	Object.<string, datetime>	optional	Date information Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc.
emails	Object.<string, email> maximum-length of values: 254	optional	Email addresses Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc.
name	string	optional	Name for yourself.
notes	string	optional	Notes for yourself.
options	Object.<string, string>	optional	Uncategorized information Use the object keys and values however you'd like.
otherNames	Object.<string, string> maximum-length of values: 254	optional	A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc.
phones	Object.<string, phone?>	optional	Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc.
pictures	Array.<uint64> for values see: Picture.id	optional	Pictures of yourself.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
roles	Array.<codified>	optional	A list of roles they play in the Company.
urls	Object.<string, url> maximum-length of values: 254	optional	Websites and other online resources Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc.

Request structure

{
	"addresses": {
		string: string
	},
	"dates": {
		string: string
	},
	"emails": {
		string: string
	},
	"name": string,
	"notes": string,
	"options": {
		string: string
	},
	"otherNames": {
		string: string
	},
	"phones": {
		string: number
	},
	"pictures": [
		number
	],
	"reqId": number,
	"roles": [
		string
	],
	"urls": {
		string: string
	}
}

ParamSelfUpdatePasswordBaseParametersobject

Request description

Property	Type	Required	Description
current	string	always	Your current password, as verification that you are the proper account owner.
password	string	always	Your new password must conform to your company's password policy.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"current": string,
	"password": string,
	"reqId": number
}

ParamSelfUpdatePreferencesBaseParametersobject

Request description

Property	Type	Required	Description
formats	Object.<string, string>	optional	Formatting help for dates, times, numbers.
language	string	optional	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
measurements	Object.<string, SystemsOfUnits?>	optional	Preferred way of displaying ambiguous numbers in the context of measurements.
notify	Array.<UserNotifications>	optional	List of UserNotifications preferences. Please note that active times cannot overlap.
options	Object.<string, string>	optional	Additional options which do not fit in with the formats or measurements preferences. If a value of null is given, the option is removed. To keep the option, you can use a blank string. For convenience, if the value of an option is given as JSON (instead of a string), they are automatically serialized with no white-space.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
timezone	codified see: Timezone.code	optional	Your local Timezone used to calculate times.

Request structure

{
	"formats": {
		string: string
	},
	"language": string,
	"measurements": {
		string: string
	},
	"notify": [
		{
			"email": string,
			"enabled": boolean,
			"end": string,
			"name": string,
			"offline": [
				string
			],
			"online": [
				string
			],
			"sms": number,
			"start": string,
			"weekdays": [
				boolean
			]
		}
	],
	"options": {
		string: string
	},
	"reqId": number,
	"timezone": string
}

RespSelfDetailsBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
expiry	datetime	The timestamp of when this session expires.
ghostId	string	Your session identifier.
machine	SelfMachine	This Machine's details (if the service is being used by a Machine). If this value is not present, then the session is not a machine account.
machine.company	uint64 see: Company.id	The company to which this user belongs.
machine.enabled	boolean	Indicates whether system access is disable.
machine.formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
machine.groups	Array.<UserGroup>	The list of UserGroup to which this User belongs.
machine.insecure	boolean	When true, no access restrictions (SelfMachine.secret, SelfMachine.referrers, or SelfMachine.ipRanges) are enforced.
machine.ipRanges	Array.<ipv4> maximum-length of values: 19	Restrict service access to only the provided IP ranges. Currently we only support IPv4 ranges using CIDR slash-notation.
machine.key	string maximum-length: 50	The unique idenifier used to access the system.
machine.language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
machine.measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
machine.nickname	string maximum-length: 100	Human friendly name for these credentials
machine.notAfter	datetime	An optional timestamp that restricts this machine account from being used after the given date.
machine.notBefore	datetime	An optional timestamp that restricts this machine account from being used before the given date.
machine.notes	string maximum-length: 8000	Notes about this machine.
machine.options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
machine.permissions	Array.<Permission>	Permission rules which override the group rules.
machine.processedUtc	datetime	When the was change procesed.
machine.referrers	Array.<url> maximum-length of values: 254	Optional list of your managed domains from which this machine account can be used.
machine.secret	string maximum-length: 1000	A token used to encode or validate requests.
machine.services	Array.<url> maximum-length of values: 254	List of system service URIs that this machine account is permitted to access.
machine.timezone	codified see: Timezone.code	The service account's local timezone.
machine.updated		by: login, from: monster
machine.v	Array.<uint32>
message	string	An English description of the error.
passwordPolicy	PasswordPolicy	This User's Company.passwordPolicy.
passwordPolicy.expireMode	PasswordExpiryMode	Defines how passwords expire.
passwordPolicy.expireThreshold	byte	The threshold for expiry.
passwordPolicy.includeLetters	boolean	Do passwords require alphabetical characters.
passwordPolicy.includeNumbers	boolean	Do passwords require numeric characters.
passwordPolicy.includeSpecial	boolean	Do passwords require non-alphanumeric characters.
passwordPolicy.includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
passwordPolicy.minimumLength	byte	The minimum number of characters required.
reqId	int32?	Identifier used by external system to correlate requests to responses.
serverTime	datetime	The UTC date/time of the server hosting the connection.
sessionPolicy	SessionPolicy	This User's Company.sessionPolicy.
sessionPolicy.applications	Array.<string>	The list of applications users are allowed to use to create sessions.
sessionPolicy.expireTimeout	uint16	The lifetime duration of a session in minutes.
sessionPolicy.idleAllowed	boolean	Defines whether a session should be automatically killed when the connection breaks.
sessionPolicy.ipv4Ranges	Array.<ipv4> maximum-length of values: 19	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
sessionPolicy.maxSessions	byte	The maximum number of sessions allowed per user.
sessionPolicy.multiUser	SessionMultiUser	Defines the behaviour of the system when a user creates multiple sessions.
user	SelfUser	This session's User details (if the service is being used by a User). If this value is not present, then the session is not yet authenticated.
user.company	uint64 see: Company.id	The company to which this user belongs.
user.contact	Contact	Associated contact information for this user.
user.contact.addresses	Object.<string, string>	Mailing addresses. Use the object key like a name of the address. Example keys: Home, Work, Park, etc.
user.contact.company	uint64 see: Company.id	The company to which this contact belongs
user.contact.dates	Object.<string, datetime>	Date information. Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc.
user.contact.emails	Object.<string, email> maximum-length of values: 254	Email addresses. Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc.
user.contact.id	uint64	Unique identifier of this contact.
user.contact.name	string maximum-length: 100	The person's name
user.contact.notes	string	Notes about this person.
user.contact.options	Object.<string, string>	Uncategorized information. Use the object keys and values however you'd like.
user.contact.otherNames	Object.<string, string> maximum-length of values: 254	A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc.
user.contact.phones	Object.<string, phone>	Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc.
user.contact.pictures	Array.<uint64> for values see: Picture.id	Pictures of this Contact.
user.contact.processedUtc	datetime	When the was change procesed.
user.contact.roles	Array.<string>	A list of roles they play in the Company.
user.contact.updated		by: login, from: monster
user.contact.urls	Object.<string, url> maximum-length of values: 254	Websites and other online resources. Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc.
user.contact.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
user.enabled	boolean	Indicates whether system access is disable.
user.formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
user.groups	Array.<UserGroup>	The list of UserGroups to which this User belongs.
user.language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
user.login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
user.measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
user.nickname	string maximum-length: 100	Human friendly name for these credentials
user.notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
user.options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
user.passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
user.permissions	Array.<Permission>	Individual permission rules which override the UserGroup rules.
user.processedUtc	datetime	When the was change procesed.
user.timezone	codified see: Timezone.code	The user's local timezone.
user.updated		by: login, from: monster
user.v	Array.<uint32>

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"expiry": string,
	"ghostId": string,
	"machine": {
		"company": number,
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			{
				"company": number,
				"id": number,
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,
						"kind": string,
						"labels": [
							string
						],
						"level": string,
						"method": string,
						"type": string
					}
				],
				"processedUtc": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"insecure": boolean,
		"ipRanges": [
			string
		],
		"key": string,
		"language": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notAfter": string,
		"notBefore": string,
		"notes": string,
		"options": {
			string: string
		},
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string,
				"type": string
			}
		],
		"processedUtc": string,
		"referrers": [
			string
		],
		"secret": string,
		"services": [
			string
		],
		"timezone": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"reqId": number,
	"serverTime": string,
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string
		],
		"maxSessions": number,
		"multiUser": string
	},
	"user": {
		"company": number,
		"contact": {
			"addresses": {
				string: string
			},
			"company": number,
			"dates": {
				string: string
			},
			"emails": {
				string: string
			},
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number
			},
			"pictures": [
				number
			],
			"processedUtc": string,
			"roles": [
				string
			],
			"updated": {
			},
			"urls": {
				string: string
			},
			"v": [
				number
			]
		},
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			{
				"company": number,
				"id": number,
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,
						"kind": string,
						"labels": [
							string
						],
						"level": string,
						"method": string,
						"type": string
					}
				],
				"processedUtc": string,
				"updated": {
				},
				"v": [
					number
				]
			}
		],
		"language": string,
		"login": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notify": [
			{
				"email": string,
				"enabled": boolean,
				"end": string,
				"name": string,
				"offline": [
					string
				],
				"online": [
					string
				],
				"sms": number,
				"start": string,
				"weekdays": [
					boolean
				]
			}
		],
		"options": {
			string: string
		},
		"passwordExpired": boolean,
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string,
				"type": string
			}
		],
		"processedUtc": string,
		"timezone": string,
		"updated": {
		},
		"v": [
			number
		]
	}
}

RespSelfIsLoggedInBaseResponseobject

Response description

Property	Type	Description
company	uint64?	The User's Company.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
expiry	datetime	The timestamp of when this session expires.
ghostId	string	Your session identifier.
login	string	The User's login.
message	string	An English description of the error.
passwordExpired	boolean	When true, the User's password must be changed before action commands will be processed.
reqId	int32?	Identifier used by external system to correlate requests to responses.
serverTime	datetime	The UTC date/time of the server hosting the connection.
status	SessionStatus	Your current session state.

Response structure

{
	"company": number,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"expiry": string,
	"ghostId": string,
	"login": string,
	"message": string,
	"passwordExpired": boolean,
	"reqId": number,
	"serverTime": string,
	"status": string
}

RespSelfLoginobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespSelfLogoutBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
expiry	datetime	The timestamp from when you session expired.
ghostId	string	Your old, no longer valid, session identifier.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"expiry": string,
	"ghostId": string,
	"message": string,
	"reqId": number
}

RespSelfRecoverCompleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
password	string	User's temporary password.
reqId	int32?	Identifier used by external system to correlate requests to responses.
username	string	User's email address.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"password": string,
	"reqId": number,
	"username": string
}

RespSelfRecoverStartBaseResponseobject

Response description

Property	Type	Description
email	string	User's email address.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
name	string	User's nickname or Contact name.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"email": string,
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"name": string,
	"reqId": number
}

RespSelfUpdateContactobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespSelfUpdatePasswordBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
expires	datetime	Specific date/time of when the password will expire.
message	string	An English description of the error.
passwordPolicy	PasswordPolicy	Your Company's password policy.
passwordPolicy.expireMode	PasswordExpiryMode	Defines how passwords expire.
passwordPolicy.expireThreshold	byte	The threshold for expiry.
passwordPolicy.includeLetters	boolean	Do passwords require alphabetical characters.
passwordPolicy.includeNumbers	boolean	Do passwords require numeric characters.
passwordPolicy.includeSpecial	boolean	Do passwords require non-alphanumeric characters.
passwordPolicy.includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
passwordPolicy.minimumLength	byte	The minimum number of characters required.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"expires": string,
	"message": string,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"reqId": number
}

RespSelfUpdatePreferencesobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

SelfMachineMachineobject

Similar to the Machine object, but instead of the SelfMachine.groups properties being identifiers of other objects, the UserGroup objects are embedded within.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
groups	Array.<UserGroup>	The list of UserGroup to which this User belongs.
insecure	boolean	When true, no access restrictions (SelfMachine.secret, SelfMachine.referrers, or SelfMachine.ipRanges) are enforced.
ipRanges	Array.<ipv4> maximum-length of values: 19	Restrict service access to only the provided IP ranges. Currently we only support IPv4 ranges using CIDR slash-notation.
key	string maximum-length: 50	The unique idenifier used to access the system.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notAfter	datetime	An optional timestamp that restricts this machine account from being used after the given date.
notBefore	datetime	An optional timestamp that restricts this machine account from being used before the given date.
notes	string maximum-length: 8000	Notes about this machine.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
permissions	Array.<Permission>	Permission rules which override the group rules.
processedUtc	datetime	When the was change procesed.
referrers	Array.<url> maximum-length of values: 254	Optional list of your managed domains from which this machine account can be used.
secret	string maximum-length: 1000	A token used to encode or validate requests.
services	Array.<url> maximum-length of values: 254	List of system service URIs that this machine account is permitted to access.
timezone	codified see: Timezone.code	The service account's local timezone.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"enabled": boolean,
	"formats": {
		string: string
	},
	"groups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"insecure": boolean,
	"ipRanges": [
		string
	],
	"key": string,
	"language": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notAfter": string,
	"notBefore": string,
	"notes": string,
	"options": {
		string: string
	},
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"referrers": [
		string
	],
	"secret": string,
	"services": [
		string
	],
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

SelfUserUserobject

Similar to the User object, but instead of the SelfUser.contact and SelfUser.groups properties being identifiers of other objects, the Contact and UserGroup objects are embedded within.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
contact	Contact	Associated contact information for this user.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
groups	Array.<UserGroup>	The list of UserGroups to which this User belongs.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
permissions	Array.<Permission>	Individual permission rules which override the UserGroup rules.
processedUtc	datetime	When the was change procesed.
timezone	codified see: Timezone.code	The user's local timezone.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"contact": {
		"addresses": {
			string: string
		},
		"company": number,
		"dates": {
			string: string
		},
		"emails": {
			string: string
		},
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			string: string
		},
		"otherNames": {
			string: string
		},
		"phones": {
			string: number
		},
		"pictures": [
			number
		],
		"processedUtc": string,
		"roles": [
			string
		],
		"updated": {
		},
		"urls": {
			string: string
		},
		"v": [
			number
		]
	},
	"enabled": boolean,
	"formats": {
		string: string
	},
	"groups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"language": string,
	"login": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notify": [
		{
			"email": string,
			"enabled": boolean,
			"end": string,
			"name": string,
			"offline": [
				string
			],
			"online": [
				string
			],
			"sms": number,
			"start": string,
			"weekdays": [
				boolean
			]
		}
	],
	"options": {
		string: string
	},
	"passwordExpired": boolean,
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

SelfUserAdvancedUserAdvancedobject

Similar to the UserAdvanced object, but instead of the SelfUserAdvanced.groups being a list of identifiers, the UserGroup objects are embedded within.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
groups	Array.<UserGroup>	The list of UserGroup to which this User belongs.
login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
permissions	Array.<Permission>	Individual permission rules which override the group rules.
processedUtc	datetime	When the was change procesed.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"groups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"login": string,
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"updated": {
	},
	"v": [
		number
	]
}

SelfUserGeneralUserGeneralobject

Similar to the UserGeneral object, but instead of the SelfUser.contact being an identifier, it is a Contact object.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
contact	Contact	Associated contact information for this user.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
processedUtc	datetime	When the was change procesed.
timezone	codified see: Timezone.code	The user's local timezone.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"contact": {
		"addresses": {
			string: string
		},
		"company": number,
		"dates": {
			string: string
		},
		"emails": {
			string: string
		},
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			string: string
		},
		"otherNames": {
			string: string
		},
		"phones": {
			string: number
		},
		"pictures": [
			number
		],
		"processedUtc": string,
		"roles": [
			string
		],
		"updated": {
		},
		"urls": {
			string: string
		},
		"v": [
			number
		]
	},
	"enabled": boolean,
	"formats": {
		string: string
	},
	"language": string,
	"login": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notify": [
		{
			"email": string,
			"enabled": boolean,
			"end": string,
			"name": string,
			"offline": [
				string
			],
			"online": [
				string
			],
			"sms": number,
			"start": string,
			"weekdays": [
				boolean
			]
		}
	],
	"options": {
		string: string
	},
	"passwordExpired": boolean,
	"processedUtc": string,
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

Users and Groups

Contactobject

Contact information

JSON description

Property	Type	Description
addresses	Object.<string, string>	Mailing addresses. Use the object key like a name of the address. Example keys: Home, Work, Park, etc.
company	uint64 see: Company.id	The company to which this contact belongs
dates	Object.<string, datetime>	Date information. Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc.
emails	Object.<string, email> maximum-length of values: 254	Email addresses. Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc.
id	uint64	Unique identifier of this contact.
name	string maximum-length: 100	The person's name
notes	string	Notes about this person.
options	Object.<string, string>	Uncategorized information. Use the object keys and values however you'd like.
otherNames	Object.<string, string> maximum-length of values: 254	A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc.
phones	Object.<string, phone>	Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc.
pictures	Array.<uint64> for values see: Picture.id	Pictures of this Contact.
processedUtc	datetime	When the was change procesed.
roles	Array.<string>	A list of roles they play in the Company.
updated		by: login, from: monster
urls	Object.<string, url> maximum-length of values: 254	Websites and other online resources. Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc.
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"addresses": {
		string: string
	},
	"company": number,
	"dates": {
		string: string
	},
	"emails": {
		string: string
	},
	"id": number,
	"name": string,
	"notes": string,
	"options": {
		string: string
	},
	"otherNames": {
		string: string
	},
	"phones": {
		string: number
	},
	"pictures": [
		number
	],
	"processedUtc": string,
	"roles": [
		string
	],
	"updated": {
	},
	"urls": {
		string: string
	},
	"v": [
		number
	]
}

ContactDeletedobject

The message format for when a deleted Contact is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this contact belongs
deleted	boolean	`true`
id	uint64		Unique identifier of this contact.
name	string maximum-length: 100		The person's name
notes	string		Notes about this person.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

Machineobject

A service account that allowes for API access of system services.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
groups	Array.<uint64> see: UserGroup.id	A list of groups to which this machine account belongs.
insecure	boolean	When true, no access restrictions (SelfMachine.secret, SelfMachine.referrers, or SelfMachine.ipRanges) are enforced.
ipRanges	Array.<ipv4> maximum-length of values: 19	Restrict service access to only the provided IP ranges. Currently we only support IPv4 ranges using CIDR slash-notation.
key	string maximum-length: 50	The unique idenifier used to access the system.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notAfter	datetime	An optional timestamp that restricts this machine account from being used after the given date.
notBefore	datetime	An optional timestamp that restricts this machine account from being used before the given date.
notes	string maximum-length: 8000	Notes about this machine.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
permissions	Array.<Permission>	Permission rules which override the group rules.
processedUtc	datetime	When the was change procesed.
referrers	Array.<url> maximum-length of values: 254	Optional list of your managed domains from which this machine account can be used.
secret	string maximum-length: 1000	A token used to encode or validate requests.
services	Array.<url> maximum-length of values: 254	List of system service URIs that this machine account is permitted to access.
timezone	codified see: Timezone.code	The service account's local timezone.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"enabled": boolean,
	"formats": {
		string: string
	},
	"groups": [
		number
	],
	"insecure": boolean,
	"ipRanges": [
		string
	],
	"key": string,
	"language": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notAfter": string,
	"notBefore": string,
	"notes": string,
	"options": {
		string: string
	},
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"referrers": [
		string
	],
	"secret": string,
	"services": [
		string
	],
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

MachineDeletedobject

The message format for when a deleted Machine is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this user belongs.
deleted	boolean	`true`
key	string maximum-length: 50		The unique idenifier used to access the system.
nickname	string maximum-length: 100		Human friendly name for these credentials
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"key": string,
	"nickname": string,
	"since": string,
	"v": [
		number
	]
}

NotificationMethodstring

The types of alerts used.

Value	Description
email	Carrier pigeon.
popup	A separate message sent across the WebSocket.
sms	A text message (SMS).

ParamContactBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
contacts	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"contacts": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamContactBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
contacts	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"contacts": [
		{
			"addresses": {
				string: string
			},
			"company": number,
			"dates": {
				string: string
			},
			"emails": {
				string: string
			},
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number
			},
			"pictures": [
				number
			],
			"roles": [
				string
			],
			"urls": {
				string: string
			},
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamContactDeleteBaseParametersobject

Request description

Property	Type	Required	Description
contact	ParamId	always	An object to contain the "id" of the Contact.
contact.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"contact": {
		"id": number
	},
	"reqId": number
}

ParamContactGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
contact	ParamId	always		An object to contain the "id" of the Contact.
contact.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Contact.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"contact": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamContactListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamContactMergeBaseParametersobject

Request description

Property	Type	Required	Description
contact	Object.<string, ?>	always	A simple object to contain the Contact parameters.
contact.addresses	Object.<string, string>	optional	Mailing addresses Use the object key like a name of the address. Example keys: Home, Work, Park, etc.
contact.company	uint64?	create	The Company to which this Contact belongs. After creation, this value is read-only.
contact.dates	Object.<string, datetime>	optional	Date information Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc.
contact.emails	Object.<string, email> maximum-length of values: 254	optional	Email addresses Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc.
contact.id	uint64?	update	The unique identifier of the Contact you want to update.
contact.name	string maximum-length: 100	optional	Name for the Contact.
contact.notes	string	optional	Notes for the Contact.
contact.options	Object.<string, string>	optional	Uncategorized information Use the object keys and values however you'd like.
contact.otherNames	Object.<string, string> maximum-length of values: 254	optional	A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc.
contact.phones	Object.<string, phone?>	optional	Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc.
contact.pictures	Array.<uint64> for values see: Picture.id	optional	Pictures of this Contact.
contact.roles	Array.<codified>	optional	A list of roles they play in the Company.
contact.urls	Object.<string, url> maximum-length of values: 254	optional	Websites and other online resources Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc.
contact.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"contact": {
		"addresses": {
			string: string
		},
		"company": number,
		"dates": {
			string: string
		},
		"emails": {
			string: string
		},
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			string: string
		},
		"otherNames": {
			string: string
		},
		"phones": {
			string: number
		},
		"pictures": [
			number
		],
		"roles": [
			string
		],
		"urls": {
			string: string
		},
		"v": [
			number
		]
	},
	"reqId": number
}

ParamContactRestoreBaseParametersobject

Request description

Property	Type	Required	Description
contact	ParamId	always	An object to contain the "id" of the Contact.
contact.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"contact": {
		"id": number
	},
	"reqId": number
}

ParamMachineBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
machines	Array.<ParamKey>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"machines": [
		{
			"key": string
		}
	],
	"reqId": number
}

ParamMachineBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
machines	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"machines": [
		{
			"company": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"insecure": boolean,
			"ipRanges": [
				string
			],
			"key": string,
			"language": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notAfter": string,
			"notBefore": string,
			"notes": string,
			"options": {
				string: string
			},
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string
				}
			],
			"referrers": [
				string
			],
			"secret": boolean,
			"services": [
				string
			],
			"timezone": string,
			"v": [
				number
			]
		}
	],
	"reqId": number
}

ParamMachineDeleteBaseParametersobject

Request description

Property	Type	Required	Description
machine	ParamKey	always	An object to contain the "key" of the Machine.
machine.key	string	always	The Machine's login.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"machine": {
		"key": string
	},
	"reqId": number
}

ParamMachineGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Machine.
machine	ParamKey	always		An object to contain the "key" of the Machine.
machine.key	string	always		The Machine's login.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeDeleted": boolean,
	"machine": {
		"key": string
	},
	"reqId": number
}

ParamMachineListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamMachineListByGroupBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always		An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always		Identifier given as input for the command.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamMachineMergeBaseParametersobject

Request description

Property	Type	Required	Description
machine	Object.<string, ?>	always	An object to contain the Machine parameters.
machine.company	uint64?	create	The company to which this Machine belongs. After creation, this value is read-only.
machine.enabled	boolean	optional	Indicates whether system access is disable.
machine.formats	Object.<string, string>	optional	The format strings defining the preferred way to display ambiguous values.
machine.groups	Array.<uint64> for values see: UserGroup.id	optional	A list of UserGroup to which this Machine belongs.
machine.insecure	boolean	optional	Indicates whether completely insecure/unrestricted system access is allowed.
machine.ipRanges	Array.<ipv4> maximum-length of values: 19	optional	Restrict Machine access to only the provided IPv4 ranges (using CIDR slash-notation).
machine.key	string	update	The unique identifier of the Machine you want to update.
machine.language	string maximum-length: 5 minimum-length: 2	optional	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
machine.measurements	Object.<string, SystemsOfUnits?>	optional	Preferred way of displaying ambiguous numbers in the context of measurements.
machine.nickname	string maximum-length: 100	optional	Human friendly name for this Machine.
machine.notAfter	datetime	optional	An optional timestamp that restricts this Machine from being used after the given date.
machine.notBefore	datetime	optional	An optional timestamp that restricts this Machine from being used before the given date.
machine.notes	string maximum-length: 8000	optional	Notes about this Machine.
machine.options	Object.<string, string>	optional	Additional options which do not fit in with the formats or measurements preferences.
machine.permissions	Array.<ParamPermission>	optional	Individual permission rules which override the UserGroup rules.
machine.referrers	Array.<url> maximum-length of values: 254	optional	Optional list of your managed domains from which this Machine can be used.
machine.secret	boolean	optional	A flag to either remove, or generate a new SelfMachine.secret.
machine.services	Array.<url> maximum-length of values: 254	optional	List of Fleet Freedom service URIs that this Machine is permitted to access.
machine.timezone	codified see: Timezone.code	optional	The Machine's local timezone.
machine.v	Array.<int32>	optional
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"machine": {
		"company": number,
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			number
		],
		"insecure": boolean,
		"ipRanges": [
			string
		],
		"key": string,
		"language": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notAfter": string,
		"notBefore": string,
		"notes": string,
		"options": {
			string: string
		},
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string
			}
		],
		"referrers": [
			string
		],
		"secret": boolean,
		"services": [
			string
		],
		"timezone": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamMachineRestoreBaseParametersobject

Request description

Property	Type	Required	Description
machine	ParamKey	always	An object to contain the "key" of the Machine.
machine.key	string	always	The Machine's login.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"machine": {
		"key": string
	},
	"reqId": number
}

ParamPermissionobject

Similar to the Permission object, but the ParamPermission.company, ParamPermission.level, ParamPermission.method, and ParamPermission.labels are all optional.

JSON description

Property	Type	Required	Default	Description
company	uint64? see: Company.id	optional		The Company that this permission targets. If not given, will default to the SelfUserAdvanced.company, UserGroup.company or SelfMachine.company to which it belongs.
kind	PermissionType	always		The kind of PermissionType.
labels	Array.<codified> for values see: LabelStyle.code	optional		Codified names of Company.labels. If list is empty, this permission applies for all labels.
level	PermissionLevel?	optional	`PermissionLevel.read`	The level of access being defined.
method	PermissionMethod?	optional	`PermissionMethod.grant`	The way the access is used.

JSON structure

{
	"company": number,
	"kind": string,
	"labels": [
		string
	],
	"level": string,
	"method": string
}

ParamSelfSessionListBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
user	ParamLogin	always	An object to contain the "login" of the User.
user.login	email	always	The User's login.

Request structure

{
	"reqId": number,
	"user": {
		"login": string
	}
}

ParamSessionGetBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
session	ParamHandle	always	An object to contain the "handle" of the SessionFull.
session.handle	string	always	A "handle" identifying a session.

Request structure

{
	"reqId": number,
	"session": {
		"handle": string
	}
}

ParamSessionKillBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
session	ParamHandle	always	An object to contain the "handle" of the SessionFull.
session.handle	string	always	A "handle" identifying a session.

Request structure

{
	"reqId": number,
	"session": {
		"handle": string
	}
}

ParamSessionListByCompanyBaseParametersobject

Request description

Property	Type	Required	Description
company	ParamId	always	An object to contain the "id" of the Company.
company.id	uint64	always	Identifier given as input for the command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamSessionListByUserBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
user	ParamLogin	always	An object to contain the "login" of the User.
user.login	email	always	The User's login.

Request structure

{
	"reqId": number,
	"user": {
		"login": string
	}
}

ParamUserAdvancedListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamUserAdvancedListByGroupBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always		An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always		Identifier given as input for the command.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
users	Array.<ParamLogin>	optional	Array of parameters successfully parsed by the sub-command.

Request structure

{
	"reqId": number,
	"users": [
		{
			"login": string
		}
	]
}

ParamUserBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
users	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.

Request structure

{
	"reqId": number,
	"users": [
		{
			"company": number,
			"contact": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"language": string,
			"login": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notify": [
				{
					"email": string,
					"enabled": boolean,
					"end": string,
					"name": string,
					"offline": [
						string
					],
					"online": [
						string
					],
					"sms": number,
					"start": string,
					"weekdays": [
						boolean
					]
				}
			],
			"options": {
				string: string
			},
			"password": string,
			"passwordExpired": boolean,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string
				}
			],
			"timezone": string,
			"v": [
				number
			]
		}
	]
}

ParamUserDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
user	ParamLogin	always	An object to contain the "login" of the User.
user.login	email	always	The User's login.

Request structure

{
	"reqId": number,
	"user": {
		"login": string
	}
}

ParamUserGeneralListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamUserGeneralListByGroupBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always		An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always		Identifier given as input for the command.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted User.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
user	ParamLogin	always		An object to contain the "login" of the User.
user.login	email	always		The User's login.

Request structure

{
	"includeDeleted": boolean,
	"reqId": number,
	"user": {
		"login": string
	}
}

ParamUserGroupBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userGroups	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.

Request structure

{
	"reqId": number,
	"userGroups": [
		{
			"id": number
		}
	]
}

ParamUserGroupBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userGroups	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.

Request structure

{
	"reqId": number,
	"userGroups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string
				}
			],
			"v": [
				number
			]
		}
	]
}

ParamUserGroupDeleteBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always	An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always	Identifier given as input for the command.

Request structure

{
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserGroupGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted UserGroup.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always		An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always		Identifier given as input for the command.

Request structure

{
	"includeDeleted": boolean,
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserGroupListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"lowest": number,
	"reqId": number
}

ParamUserGroupMergeBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userGroup	Object.<string, ?>	always	A simple object to contain the UserGroup parameters.
userGroup.company	uint64?	create	The company to which this UserGroup belongs. After creation, this value is read-only.
userGroup.id	uint64?	update	The unique identifier of the UserGroup you want to update.
userGroup.name	string maximum-length: 100	create	Name for the UserGroup.
userGroup.notes	string	optional	Notes for the UserGroup.
userGroup.permissions	Array.<ParamPermission> maximum-count of values: 254	optional	List of permissions assigned to members of this UserGroup.
userGroup.v	Array.<int32>	optional

Request structure

{
	"reqId": number,
	"userGroup": {
		"company": number,
		"id": number,
		"name": string,
		"notes": string,
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string
			}
		],
		"v": [
			number
		]
	}
}

ParamUserGroupRestoreBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always	An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always	Identifier given as input for the command.

Request structure

{
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserListByCompanyBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" of the Company.
company.id	uint64	always		Identifier given as input for the command.
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number
}

ParamUserListByGroupBaseParametersobject

Request description

Property	Type	Required	Default	Description
first	string	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
last	string	optional
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
userGroup	ParamId	always		An object to contain the "id" of the UserGroup.
userGroup.id	uint64	always		Identifier given as input for the command.

Request structure

{
	"first": string,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"last": string,
	"limit": number,
	"reqId": number,
	"userGroup": {
		"id": number
	}
}

ParamUserMergeBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
user	Object.<string, ?>	always
user.company	uint64?	create	The company to which this User belongs. After creation, this value is read-only.
user.contact	uint64? see: Contact.id	optional	Contact information for this User.
user.enabled	boolean	optional	Indicates whether system access is disable.
user.formats	Object.<codified, string>	optional	The format strings defining the preferred way to display ambiguous values.
user.groups	Array.<uint64> for values see: UserGroup.id	optional	A list of UserGroups to which this User is a member.
user.language	string maximum-length: 5 minimum-length: 2	optional	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
user.login	email	always	The unique identifier of the User you want to update.
user.measurements	Object.<codified, SystemsOfUnits?>	optional	Preferred way of displaying ambiguous numbers in the context of measurements.
user.nickname	string maximum-length: 100	optional	Human friendly name for these credentials
user.notify	Array.<UserNotifications>	optional	Definition of how and when to send alerts to the User.
user.options	Object.<codified, string>	optional	Additional options which do not fit in with the formats or measurements preferences.
user.password	string	create	This User's password.
user.passwordExpired	boolean	optional	Indicated whether the credentials have expired according to the company's policy.
user.permissions	Array.<ParamPermission> maximum-count of values: 254	optional	Individual permission rules which override the UserGroup rules.
user.timezone	codified see: Timezone.code	optional	The User's local timezone.
user.v	Array.<int32>	optional

Request structure

{
	"reqId": number,
	"user": {
		"company": number,
		"contact": number,
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			number
		],
		"language": string,
		"login": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notify": [
			{
				"email": string,
				"enabled": boolean,
				"end": string,
				"name": string,
				"offline": [
					string
				],
				"online": [
					string
				],
				"sms": number,
				"start": string,
				"weekdays": [
					boolean
				]
			}
		],
		"options": {
			string: string
		},
		"password": string,
		"passwordExpired": boolean,
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string
			}
		],
		"timezone": string,
		"v": [
			number
		]
	}
}

ParamUserRestoreBaseParametersobject

Request description

Property	Type	Required	Description
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.
user	ParamLogin	always	An object to contain the "login" of the User.
user.login	email	always	The User's login.

Request structure

{
	"reqId": number,
	"user": {
		"login": string
	}
}

Permissionobject

A defined permission for Users, UserGroups, and Machines.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The Company that this permission targets.
kind	PermissionType	The type of permission.
labels	Array.<codified> for values see: LabelStyle.code	Codified names of LabelStyles. If list is empty, this permission applies for all labels.
level	PermissionLevel	The level of access being defined.
method	PermissionMethod	The way the access is used.
type Deprecated	PermissionType?	The kind of permission. Use .kind instead.

JSON structure

{
	"company": number,
	"kind": string,
	"labels": [
		string
	],
	"level": string,
	"method": string,
	"type": string
}

PermissionEscalationobject

Used to throw permission escalation exceptions, this is similar to a Permission, but defines a PermissionEscalation.before and PermissionEscalation.after for a proposed change.

JSON description

Property	Type	Description
after	PermissionEscalationState	Effective permission after the proposed change.
before	PermissionEscalationState	Effective permission before the proposed change.
company	uint64 see: Company.id	The Company that this permission targets.
direction	PermissionEscalationType	Gets the direction of the escalation.
kind	PermissionType	The type of permission.

JSON structure

{
	"after": {
		"labels": [
			string
		],
		"level": string
	},
	"before": {
		"labels": [
			string
		],
		"level": string
	},
	"company": number,
	"direction": string,
	"kind": string
}

PermissionEscalationStateobject

Describes the changes in state that raised the escalation.

JSON description

Property	Type	Description
labels	Array.<codified> for values see: LabelStyle.code	Codified names of LabelStyles. If list is empty, this permission applies for all labels.
level	PermissionLevel?	The level of access defined before the proposed change.

JSON structure

{
	"labels": [
		string
	],
	"level": string
}

PermissionEscalationTypestring

Definition for the kinds of permission escalations.

Value	Description
horizontal	Increase in access to an object.
vertical	Increase in privileges.

PermissionLevelstring

The levels of permission available.

Value	Description
full	Full control to read, write, delete and create things.
read	Read-only access, no changes allowed.
update	Read and write access, but things cannot be deleted or new things created.

PermissionMethodstring

How a permission is applied.

Value	Description
grant	Permission is given.
revoke	Permission is taken away.

PermissionTypestring

The kinds of permissions available for a UserPermission.

Value	Objects	Description
Assets
assetAdvanced	AssetAdvanced VehicleAdvanced	Assets' advanced properties such as position, attributes, and status tags.
assetGeneral	Asset AssetDeleted AssetGeneral AssetSuspended Person PersonGeneral Trailer TrailerGeneral Vehicle VehicleGeneral	Assets' general properties such as name, icon, and labels.
assetMessage	AssetMessage AssetMessageDeleted	AssetMessages from assets and AssetAlerts.
Behaviours
behaviour	Behaviour BehaviourDeleted	Configured Behaviour.
behaviourLog	BehaviourLog BehaviourLogDeleted	View and clear the log of debug messages for a BehaviourScript or Behaviour.
behaviourScript	BehaviourScript BehaviourScriptDeleted	BehaviourScript logic.
Billing
billingHosting	BillableHostingRule BillableHostingRuleDeleted	Billing rule for Assets.
billingLicense	BillableHostingLicense BillableHostingLicenseDeleted	Hardware License for Providers.
billingProfile	BillingProfile BillingProfileDeleted	Profile used to generate BillingReport for a customer.
billingReport	BillingReport BillingReportDeleted	Generated bill for a customer.
Company
companyCreate	CompanyDeleted CompanyGeneral	Access to add a new child Company.
companyGeneral	Company CompanyDeleted CompanyGeneral	Basic information about a Company. This permissions is required to have access to other aspects of the company.
companyLabels	CompanyStyles	Company's label and tag styles.
companyPolicies	CompanyPolicies	Company's SessionPolicy and PasswordPolicy.
companyReseller	CompanyReseller CompanyResellerDeleted	White-labeler specific settings.
Contacts
contact	Contact ContactDeleted	Contact information.
Dispatch
dispatchJob	DispatchJob DispatchJobDeleted	Some work that needs to be completed by an Asset. Like a multi-step DispatchTask.
dispatchTask	DispatchTask DispatchTaskDeleted	Asset's tasks information.
dispatchTemplate	DispatchTemplate DispatchTemplateDeleted	Pre-set routes, lists of DispatchJobs, and driving directions.
File Hosting
document	Document DocumentDeleted	Hosted Document information.
formResult	FormResult FormResultDeleted	Filled out forms.
formTemplate	FormTemplate FormTemplateDeleted	Custom forms to be filled.
icon	Icon IconDeleted	Icon information.
picture	Picture PictureDeleted	Picture information.
Hours of Service
hosCarrier Deprecated	HosCarrier HosCarrierDeleted	Hours of Service Carriers. Feature retired.
hosEvent Deprecated	HosEvent	Driver's E-log event records. Feature retired.
hosInspection Deprecated	HosInspection HosInspectionDeleted	Driver vehicle inspection reports. Feature retired.
Maintenance
maintenanceJob	MaintenanceJob MaintenanceJobDeleted	Historical Vehicle and Trailer maintenance work.
maintenanceSchedule	MaintenanceSchedule MaintenanceScheduleDeleted	Recurring MaintenanceJobs for Vehicle and Trailer.
Places
placeGeneral	Place PlaceDeleted PlaceGeneral	Place information.
Providers and Configurations
providerAdvanced	ProviderAdvanced	Raw Provider data like GPS coordinates and parsed ODB-II values.
providerConfiguration	ProviderConfig ProviderConfigDeleted ProviderConfiguration ProviderConfigurationDeleted ProviderConfigurationType ProviderConfigurationTypeDeleted	Provider configurations.
providerGeneral	Provider ProviderDeleted ProviderGeneral ProviderSuspended	Provider information like name, notes, and selected asset.
providerScript	ProviderScript ProviderScriptDeleted	Allows access to Provider logic scripts.
Reports
reportResult	ReportResult ReportResultDeleted	Historical Asset details like breadcrumb trails.
reportSchedule	ReportSchedule ReportScheduleDeleted	ReportSchedules used to automatically create ReportResults overnight.
reportTemplate	ReportTemplate ReportTemplateDeleted	ReportTemplate configurations.
Users and Groups
machine	Machine MachineDeleted	Machine information and permissions.
session	Session SessionFull	Access to retrieve a list of active sessions and kill sessions.
userAdvanced	UserAdvanced	User information such as permissions and group membership.
userGeneral	UserDeleted UserGeneral	General user information such as name, contact information, and preferences.
userGroup	UserGroup UserGroupDeleted	UserGroup information for easy access control.

RespContactBatchDeleteBaseResponseobject

Response description

Property	Type	Description
contacts	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contacts": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactBatchMergeBaseResponseobject

Response description

Property	Type	Description
contacts	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contacts": [
		{
			"company": number,
			"id": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactDeleteBaseResponseobject

Response description

Property	Type	Description
contact	RespDeleted	An object which contains the Contact's id, owning Company id, and deleted status.
contact.company	uint64	Identifier of the Company to which this object belongs.
contact.deleted	boolean	Flag showing if the object is deleted.
contact.id	uint64?	Identifier given as input for the command.
contact.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contact": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactGetBaseResponseobject

Response description

Property	Type	Description
contact	Contact	The requested Contact.
contact.addresses	Object.<string, string>	Mailing addresses. Use the object key like a name of the address. Example keys: Home, Work, Park, etc.
contact.company	uint64 see: Company.id	The company to which this contact belongs
contact.dates	Object.<string, datetime>	Date information. Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc.
contact.emails	Object.<string, email> maximum-length of values: 254	Email addresses. Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc.
contact.id	uint64	Unique identifier of this contact.
contact.name	string maximum-length: 100	The person's name
contact.notes	string	Notes about this person.
contact.options	Object.<string, string>	Uncategorized information. Use the object keys and values however you'd like.
contact.otherNames	Object.<string, string> maximum-length of values: 254	A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc.
contact.phones	Object.<string, phone>	Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc.
contact.pictures	Array.<uint64> for values see: Picture.id	Pictures of this Contact.
contact.processedUtc	datetime	When the was change procesed.
contact.roles	Array.<string>	A list of roles they play in the Company.
contact.updated		by: login, from: monster
contact.urls	Object.<string, url> maximum-length of values: 254	Websites and other online resources. Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc.
contact.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contact": {
		"addresses": {
			string: string
		},
		"company": number,
		"dates": {
			string: string
		},
		"emails": {
			string: string
		},
		"id": number,
		"name": string,
		"notes": string,
		"options": {
			string: string
		},
		"otherNames": {
			string: string
		},
		"phones": {
			string: number
		},
		"pictures": [
			number
		],
		"processedUtc": string,
		"roles": [
			string
		],
		"updated": {
		},
		"urls": {
			string: string
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Contacts belong.
company.id	uint64?	Identifier given as input for the command.
contacts	Array.<Contact>	The list of requested Contacts.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"contacts": [
		{
			"addresses": {
				string: string
			},
			"company": number,
			"dates": {
				string: string
			},
			"emails": {
				string: string
			},
			"id": number,
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number
			},
			"pictures": [
				number
			],
			"processedUtc": string,
			"roles": [
				string
			],
			"updated": {
			},
			"urls": {
				string: string
			},
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactMergeBaseResponseobject

Response description

Property	Type	Description
contact	RespIdCompany	An object which contains the "id" and "company" keys when there is no error.
contact.company	uint64	Identifier of the Company to which this object belongs.
contact.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contact": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespContactRestoreBaseResponseobject

Response description

Property	Type	Description
contact	RespDeleted	An object which contains the Contact's id, owning Company id, and deleted status.
contact.company	uint64	Identifier of the Company to which this object belongs.
contact.deleted	boolean	Flag showing if the object is deleted.
contact.id	uint64?	Identifier given as input for the command.
contact.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"contact": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespMachineBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machines	Array.<RespKeyDeleted>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machines": [
		{
			"company": number,
			"deleted": boolean,
			"key": string,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMachineBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machines	Array.<RespKeyCompany>	Array or responses successfully processed by the sub-command.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machines": [
		{
			"company": number,
			"key": string
		}
	],
	"message": string,
	"reqId": number
}

RespMachineDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machine	RespKeyDeleted	An object which contains the Machine's key, owning Company id, and deleted status.
machine.company	uint64	Identifier of the Company to which the Machine belongs.
machine.deleted	boolean	Flag showing if the object is deleted.
machine.key	string	The Machine's key.
machine.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machine": {
		"company": number,
		"deleted": boolean,
		"key": string,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMachineGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machine	Machine	The requested Machine.
machine.company	uint64 see: Company.id	The company to which this user belongs.
machine.enabled	boolean	Indicates whether system access is disable.
machine.formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
machine.groups	Array.<uint64> see: UserGroup.id	A list of groups to which this machine account belongs.
machine.insecure	boolean	When true, no access restrictions (SelfMachine.secret, SelfMachine.referrers, or SelfMachine.ipRanges) are enforced.
machine.ipRanges	Array.<ipv4> maximum-length of values: 19	Restrict service access to only the provided IP ranges. Currently we only support IPv4 ranges using CIDR slash-notation.
machine.key	string maximum-length: 50	The unique idenifier used to access the system.
machine.language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
machine.measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
machine.nickname	string maximum-length: 100	Human friendly name for these credentials
machine.notAfter	datetime	An optional timestamp that restricts this machine account from being used after the given date.
machine.notBefore	datetime	An optional timestamp that restricts this machine account from being used before the given date.
machine.notes	string maximum-length: 8000	Notes about this machine.
machine.options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
machine.permissions	Array.<Permission>	Permission rules which override the group rules.
machine.processedUtc	datetime	When the was change procesed.
machine.referrers	Array.<url> maximum-length of values: 254	Optional list of your managed domains from which this machine account can be used.
machine.secret	string maximum-length: 1000	A token used to encode or validate requests.
machine.services	Array.<url> maximum-length of values: 254	List of system service URIs that this machine account is permitted to access.
machine.timezone	codified see: Timezone.code	The service account's local timezone.
machine.updated		by: login, from: monster
machine.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machine": {
		"company": number,
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			number
		],
		"insecure": boolean,
		"ipRanges": [
			string
		],
		"key": string,
		"language": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notAfter": string,
		"notBefore": string,
		"notes": string,
		"options": {
			string: string
		},
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string,
				"type": string
			}
		],
		"processedUtc": string,
		"referrers": [
			string
		],
		"secret": string,
		"services": [
			string
		],
		"timezone": string,
		"updated": {
		},
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespMachineListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Machines belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machines	Array.<Machine>	The list requested of Machines.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machines": [
		{
			"company": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"insecure": boolean,
			"ipRanges": [
				string
			],
			"key": string,
			"language": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notAfter": string,
			"notBefore": string,
			"notes": string,
			"options": {
				string: string
			},
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"referrers": [
				string
			],
			"secret": string,
			"services": [
				string
			],
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespMachineListByGroupBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machines	Array.<Machine>	The list requested of Machines.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	RespIdCompany	An object to contain the "id" of the UserGroup to which the array of Machines belong.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.id	uint64?	Identifier given as input for the command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machines": [
		{
			"company": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"insecure": boolean,
			"ipRanges": [
				string
			],
			"key": string,
			"language": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notAfter": string,
			"notBefore": string,
			"notes": string,
			"options": {
				string: string
			},
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"referrers": [
				string
			],
			"secret": string,
			"services": [
				string
			],
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"id": number
	}
}

RespMachineMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machine	RespKeyCompany	An object which contains the "key" and "company" keys when there is no error.
machine.company	uint64	Identifier of the Company to which the Machine belongs.
machine.key	string	The Machine's key.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machine": {
		"company": number,
		"key": string
	},
	"message": string,
	"reqId": number
}

RespMachineRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
machine	RespKeyDeleted	An object which contains the Machine's key, owning Company id, and deleted status.
machine.company	uint64	Identifier of the Company to which the Machine belongs.
machine.deleted	boolean	Flag showing if the object is deleted.
machine.key	string	The Machine's key.
machine.v	Array.<uint32>
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"machine": {
		"company": number,
		"deleted": boolean,
		"key": string,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespSelfSessionListBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
sessions	Array.<SessionFull>	The list of requested SessionFull.
user	RespLoginCompany	An object to contain the "login" of the User to which the array of SessionFulls belong.
user.company	uint64	Identifier of the Company to which the User belongs.
user.login	string	The User's login.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"sessions": [
		{
			"active": boolean,
			"company": number,
			"created": string,
			"expiry": string,
			"handle": string,
			"ipAddress": string,
			"lastActivity": string,
			"lastCommand": string,
			"login": string,
			"sockets": number,
			"status": string,
			"userAgent": string
		}
	],
	"user": {
		"company": number,
		"login": string
	}
}

RespSessionGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
session	SessionFull	The requested SessionFull.
session.active	boolean	Indicator that this SessionFull is using at least one WebSocket connection.
session.company	uint64? see: Company.id	Identifier of the Company to which this object belongs
session.created	datetime	The timestamp from the moment this SessionFull was created.
session.expiry	datetime	A timestamp for when the Session will expire.
session.handle	string	A "handle" identifying a resource.
session.ipAddress	ipv4	The (most recent) IP address that used this SessionFull to connect.
session.lastActivity	datetime	A timestamp from the last command or call to the system.
session.lastCommand	string	The name or path of the last command executed.
session.login	string see: User.login	The User to which the Session belongs.
session.sockets	int32	The number of current-active WebSocket connections.
session.status	SessionStatus	This SessionFull's current state.
session.userAgent	string	The (most recent) software being used by this SessionFull.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"session": {
		"active": boolean,
		"company": number,
		"created": string,
		"expiry": string,
		"handle": string,
		"ipAddress": string,
		"lastActivity": string,
		"lastCommand": string,
		"login": string,
		"sockets": number,
		"status": string,
		"userAgent": string
	}
}

RespSessionKillBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
session	Session	An object which contains the SessionFull's handle, related User login, and owning Company id.
session.company	uint64? see: Company.id	Identifier of the Company to which this object belongs
session.expiry	datetime	A timestamp for when the Session will expire.
session.handle	string	A "handle" identifying a resource.
session.login	string see: User.login	The User to which the Session belongs.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"session": {
		"company": number,
		"expiry": string,
		"handle": string,
		"login": string
	}
}

RespSessionListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of SessionFulls belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
sessions	Array.<SessionFull>	The list of requested SessionFull.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"sessions": [
		{
			"active": boolean,
			"company": number,
			"created": string,
			"expiry": string,
			"handle": string,
			"ipAddress": string,
			"lastActivity": string,
			"lastCommand": string,
			"login": string,
			"sockets": number,
			"status": string,
			"userAgent": string
		}
	]
}

RespSessionListByUserBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
sessions	Array.<SessionFull>	The list of requested SessionFull.
user	RespLoginCompany	An object to contain the "login" of the User to which the array of SessionFulls belong.
user.company	uint64	Identifier of the Company to which the User belongs.
user.login	string	The User's login.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"sessions": [
		{
			"active": boolean,
			"company": number,
			"created": string,
			"expiry": string,
			"handle": string,
			"ipAddress": string,
			"lastActivity": string,
			"lastCommand": string,
			"login": string,
			"sockets": number,
			"status": string,
			"userAgent": string
		}
	],
	"user": {
		"company": number,
		"login": string
	}
}

RespUserAdvancedListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Users belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userAdvanceds	Array.<UserAdvanced>	The list of requested Users.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userAdvanceds": [
		{
			"company": number,
			"groups": [
				number
			],
			"login": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	]
}

RespUserAdvancedListByGroupBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userAdvanceds	Array.<UserAdvanced>	The list of requested Users.
userGroup	RespIdCompany	An object to contain the "id" of the UserGroup to which the array of Users belong.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.id	uint64?	Identifier given as input for the command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userAdvanceds": [
		{
			"company": number,
			"groups": [
				number
			],
			"login": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"userGroup": {
		"company": number,
		"id": number
	}
}

RespUserBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
users	Array.<RespLoginDeleted>	Array or responses successfully processed by the sub-command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"users": [
		{
			"company": number,
			"deleted": boolean,
			"login": string,
			"v": [
				number
			]
		}
	]
}

RespUserBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
users	Array.<RespLoginCompany>	Array or responses successfully processed by the sub-command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"users": [
		{
			"company": number,
			"login": string
		}
	]
}

RespUserDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
user	RespLoginDeleted	An object which contains the User's login, owning Company id, and deleted status.
user.company	uint64	Identifier of the Company to which the User belongs.
user.deleted	boolean	Flag showing if the object is deleted.
user.login	string	The User's login.
user.v	Array.<uint32>

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"user": {
		"company": number,
		"deleted": boolean,
		"login": string,
		"v": [
			number
		]
	}
}

RespUserGeneralListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Users belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGenerals	Array.<UserGeneral>	The list of requested Users.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGenerals": [
		{
			"company": number,
			"contact": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"language": string,
			"login": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notify": [
				{
					"email": string,
					"enabled": boolean,
					"end": string,
					"name": string,
					"offline": [
						string
					],
					"online": [
						string
					],
					"sms": number,
					"start": string,
					"weekdays": [
						boolean
					]
				}
			],
			"options": {
				string: string
			},
			"passwordExpired": boolean,
			"processedUtc": string,
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	]
}

RespUserGeneralListByGroupBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGenerals	Array.<UserGeneral>	The list of requested Users.
userGroup	RespIdCompany	An object to contain the "id" of the UserGroup to which the array of Users belong.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.id	uint64?	Identifier given as input for the command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGenerals": [
		{
			"company": number,
			"contact": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"language": string,
			"login": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notify": [
				{
					"email": string,
					"enabled": boolean,
					"end": string,
					"name": string,
					"offline": [
						string
					],
					"online": [
						string
					],
					"sms": number,
					"start": string,
					"weekdays": [
						boolean
					]
				}
			],
			"options": {
				string: string
			},
			"passwordExpired": boolean,
			"processedUtc": string,
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	],
	"userGroup": {
		"company": number,
		"id": number
	}
}

RespUserGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
user	User	The requested User.
user.company	uint64 see: Company.id	The company to which this user belongs.
user.contact	uint64? see: Contact.id	Contact information for this user.
user.enabled	boolean	Indicates whether system access is disable.
user.formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
user.groups	Array.<uint64> see: UserGroup.id	A list of groups to which this user belongs.
user.language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
user.login	email maximum-length: 254 minimum-length: 6	Unique identifier of this user.
user.measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
user.nickname	string maximum-length: 100	Human friendly name for these credentials
user.notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
user.options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
user.passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
user.permissions	Array.<Permission>	Individual permission rules which override the group rules.
user.processedUtc	datetime	When the was change procesed.
user.timezone	codified see: Timezone.code	The user's local timezone.
user.updated		by: login, from: monster
user.v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
user.v[0]	int32	The first element is for the general properties
user.v[1]	int32	The second element is for the advanced properties

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"user": {
		"company": number,
		"contact": number,
		"enabled": boolean,
		"formats": {
			string: string
		},
		"groups": [
			number
		],
		"language": string,
		"login": string,
		"measurements": {
			string: string
		},
		"nickname": string,
		"notify": [
			{
				"email": string,
				"enabled": boolean,
				"end": string,
				"name": string,
				"offline": [
					string
				],
				"online": [
					string
				],
				"sms": number,
				"start": string,
				"weekdays": [
					boolean
				]
			}
		],
		"options": {
			string: string
		},
		"passwordExpired": boolean,
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string,
				"type": string
			}
		],
		"processedUtc": string,
		"timezone": string,
		"updated": {
		},
		"v": [
			number
		]
	}
}

RespUserGroupBatchDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroups	Array.<RespDeleted>	Array or responses successfully processed by the sub-command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroups": [
		{
			"company": number,
			"deleted": boolean,
			"id": number,
			"v": [
				number
			]
		}
	]
}

RespUserGroupBatchMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroups	Array.<RespIdCompany>	Array or responses successfully processed by the sub-command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroups": [
		{
			"company": number,
			"id": number
		}
	]
}

RespUserGroupDeleteBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	RespDeleted	An object which contains the "id" and "company" keys when there is no error.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.deleted	boolean	Flag showing if the object is deleted.
userGroup.id	uint64?	Identifier given as input for the command.
userGroup.v	Array.<uint32>

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	}
}

RespUserGroupGetBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	UserGroup	The requested UserGroup.
userGroup.company	uint64 see: Company.id	The company to which this group belongs.
userGroup.id	uint64	Unique identifier of this group.
userGroup.name	string maximum-length: 100	A name given to this group.
userGroup.notes	string	Notes about this group, and to whom this group should be applied.
userGroup.permissions	Array.<Permission>	Permissions for this group.
userGroup.processedUtc	datetime	When the was change procesed.
userGroup.updated		by: login, from: monster
userGroup.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"id": number,
		"name": string,
		"notes": string,
		"permissions": [
			{
				"company": number,
				"kind": string,
				"labels": [
					string
				],
				"level": string,
				"method": string,
				"type": string
			}
		],
		"processedUtc": string,
		"updated": {
		},
		"v": [
			number
		]
	}
}

RespUserGroupListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of contacts belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroups	Array.<UserGroup>	The requested list of UserGroups.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	]
}

RespUserGroupMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	RespIdCompany	An object which contains the "id" and "company".
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.id	uint64?	Identifier given as input for the command.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"id": number
	}
}

RespUserGroupRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	RespDeleted	An object which contains the "id" and "company" keys when there is no error.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.deleted	boolean	Flag showing if the object is deleted.
userGroup.id	uint64?	Identifier given as input for the command.
userGroup.v	Array.<uint32>

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	}
}

RespUserListByCompanyBaseResponseobject

Response description

Property	Type	Description
company	RespId	An object to contain the "id" of the Company to which the array of Users belong.
company.id	uint64?	Identifier given as input for the command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
users	Array.<User>	The list of requested Users.

Response structure

{
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"users": [
		{
			"company": number,
			"contact": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"language": string,
			"login": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notify": [
				{
					"email": string,
					"enabled": boolean,
					"end": string,
					"name": string,
					"offline": [
						string
					],
					"online": [
						string
					],
					"sms": number,
					"start": string,
					"weekdays": [
						boolean
					]
				}
			],
			"options": {
				string: string
			},
			"passwordExpired": boolean,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	]
}

RespUserListByGroupBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
userGroup	RespIdCompany	An object to contain the "id" of the UserGroup to which the array of Users belong.
userGroup.company	uint64	Identifier of the Company to which this object belongs.
userGroup.id	uint64?	Identifier given as input for the command.
users	Array.<User>	The list of requested Users.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"userGroup": {
		"company": number,
		"id": number
	},
	"users": [
		{
			"company": number,
			"contact": number,
			"enabled": boolean,
			"formats": {
				string: string
			},
			"groups": [
				number
			],
			"language": string,
			"login": string,
			"measurements": {
				string: string
			},
			"nickname": string,
			"notify": [
				{
					"email": string,
					"enabled": boolean,
					"end": string,
					"name": string,
					"offline": [
						string
					],
					"online": [
						string
					],
					"sms": number,
					"start": string,
					"weekdays": [
						boolean
					]
				}
			],
			"options": {
				string: string
			},
			"passwordExpired": boolean,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"processedUtc": string,
			"timezone": string,
			"updated": {
			},
			"v": [
				number
			]
		}
	]
}

RespUserMergeBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
user	RespLoginCompany
user.company	uint64	Identifier of the Company to which the User belongs.
user.login	string	The User's login.

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"user": {
		"company": number,
		"login": string
	}
}

RespUserRestoreBaseResponseobject

Response description

Property	Type	Description
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.
user	RespLoginDeleted	An object which contains the User's login, owning Company id, and deleted status.
user.company	uint64	Identifier of the Company to which the User belongs.
user.deleted	boolean	Flag showing if the object is deleted.
user.login	string	The User's login.
user.v	Array.<uint32>

Response structure

{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number,
	"user": {
		"company": number,
		"deleted": boolean,
		"login": string,
		"v": [
			number
		]
	}
}

Sessionobject

A container class used to house the "handle" identifying a resource. Used specifically to after a kill session command.

JSON description

Property	Type	Description
company	uint64? see: Company.id	Identifier of the Company to which this object belongs
expiry	datetime	A timestamp for when the Session will expire.
handle	string	A "handle" identifying a resource.
login	string see: User.login	The User to which the Session belongs.

JSON structure

{
	"company": number,
	"expiry": string,
	"handle": string,
	"login": string
}

SessionFullSessionobject

Container for a full session response. Used specifically to give session details.

JSON description

Property	Type	Description
active	boolean	Indicator that this SessionFull is using at least one WebSocket connection.
company	uint64? see: Company.id	Identifier of the Company to which this object belongs
created	datetime	The timestamp from the moment this SessionFull was created.
expiry	datetime	A timestamp for when the Session will expire.
handle	string	A "handle" identifying a resource.
ipAddress	ipv4	The (most recent) IP address that used this SessionFull to connect.
lastActivity	datetime	A timestamp from the last command or call to the system.
lastCommand	string	The name or path of the last command executed.
login	string see: User.login	The User to which the Session belongs.
sockets	int32	The number of current-active WebSocket connections.
status	SessionStatus	This SessionFull's current state.
userAgent	string	The (most recent) software being used by this SessionFull.

JSON structure

{
	"active": boolean,
	"company": number,
	"created": string,
	"expiry": string,
	"handle": string,
	"ipAddress": string,
	"lastActivity": string,
	"lastCommand": string,
	"login": string,
	"sockets": number,
	"status": string,
	"userAgent": string
}

SessionStatusstring

Current state of a session

Value	Description
active	User is logged-in and one or more WebSocket connections are open.
created	Session created but user hasn't logged-in yet.
expired	Session is being killed because it has expired.
idle	User is logged-in but no WebSocket connections are open.
notFound	Invalid session reference.
passwordExpired	User is logged-in and password is expired and needs to be changed before any commands can be processed.

SystemsOfUnitsstring

A type of measurement system

Value	Description
metric	Metric
standard	US Standard.

Userobject

A grouping of credentials, information, preferences, and permissions for a person or machine to login to the system and access its resources.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
contact	uint64? see: Contact.id	Contact information for this user.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
groups	Array.<uint64> see: UserGroup.id	A list of groups to which this user belongs.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
login	email maximum-length: 254 minimum-length: 6	Unique identifier of this user.
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
permissions	Array.<Permission>	Individual permission rules which override the group rules.
processedUtc	datetime	When the was change procesed.
timezone	codified see: Timezone.code	The user's local timezone.
updated		by: login, from: monster
v	Array.<int32> fixed count: 2	Object version keys used to validate synchronization for all object properties.
v[0]	int32	The first element is for the general properties
v[1]	int32	The second element is for the advanced properties

JSON structure

{
	"company": number,
	"contact": number,
	"enabled": boolean,
	"formats": {
		string: string
	},
	"groups": [
		number
	],
	"language": string,
	"login": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notify": [
		{
			"email": string,
			"enabled": boolean,
			"end": string,
			"name": string,
			"offline": [
				string
			],
			"online": [
				string
			],
			"sms": number,
			"start": string,
			"weekdays": [
				boolean
			]
		}
	],
	"options": {
		string: string
	},
	"passwordExpired": boolean,
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

UserAdvancedobject

Permissions and group membership defined for a user.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
groups	Array.<uint64> see: UserGroup.id	A list of groups to which this user belongs.
login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
permissions	Array.<Permission>	Individual permission rules which override the group rules.
processedUtc	datetime	When the was change procesed.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"groups": [
		number
	],
	"login": string,
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"updated": {
	},
	"v": [
		number
	]
}

UserDeletedobject

The message format for when a deleted User is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this user belongs.
deleted	boolean	`true`
login	email see: User.login maximum-length: 254 minimum-length: 6		The unique public email address used to access the system.
nickname	string maximum-length: 100		Human friendly name for these credentials
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"login": string,
	"nickname": string,
	"since": string,
	"v": [
		number
	]
}

UserGeneralobject

Credentials, information, and preferences about a user.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this user belongs.
contact	uint64? see: Contact.id	Contact information for this user.
enabled	boolean	Indicates whether system access is disable.
formats	Object.<codified, datetimetemplate> maximum-length of values: 20	The format strings defining the preferred way to display ambiguous values.
language	codified maximum-length: 5 minimum-length: 2	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
login	email see: User.login maximum-length: 254 minimum-length: 6	The unique public email address used to access the system.
measurements	Object.<codified, SystemsOfUnits>	Preferred way of displaying ambiguous numbers in the context of measurements.
nickname	string maximum-length: 100	Human friendly name for these credentials
notify	Array.<UserNotifications> maximum-count: 7	Definition of how and when to send alerts to the user.
options	Object.<codified, string> maximum-length of values: 20	Additional options which do not fit in with the formats or measurements preferences.
passwordExpired	boolean	Indicated whether the credentials have expired according to the company's policy.
processedUtc	datetime	When the was change procesed.
timezone	codified see: Timezone.code	The user's local timezone.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"contact": number,
	"enabled": boolean,
	"formats": {
		string: string
	},
	"language": string,
	"login": string,
	"measurements": {
		string: string
	},
	"nickname": string,
	"notify": [
		{
			"email": string,
			"enabled": boolean,
			"end": string,
			"name": string,
			"offline": [
				string
			],
			"online": [
				string
			],
			"sms": number,
			"start": string,
			"weekdays": [
				boolean
			]
		}
	],
	"options": {
		string: string
	},
	"passwordExpired": boolean,
	"processedUtc": string,
	"timezone": string,
	"updated": {
	},
	"v": [
		number
	]
}

UserGroupobject

A group of permissions that allow for easier user permission control.

JSON description

Property	Type	Description
company	uint64 see: Company.id	The company to which this group belongs.
id	uint64	Unique identifier of this group.
name	string maximum-length: 100	A name given to this group.
notes	string	Notes about this group, and to whom this group should be applied.
permissions	Array.<Permission>	Permissions for this group.
processedUtc	datetime	When the was change procesed.
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"id": number,
	"name": string,
	"notes": string,
	"permissions": [
		{
			"company": number,
			"kind": string,
			"labels": [
				string
			],
			"level": string,
			"method": string,
			"type": string
		}
	],
	"processedUtc": string,
	"updated": {
	},
	"v": [
		number
	]
}

UserGroupDeletedobject

The message format for when a deleted UserGroup is retrieved

JSON description

Property	Type	Value	Description
company	uint64 see: Company.id		The company to which this group belongs.
deleted	boolean	`true`
id	uint64		Unique identifier of this group.
name	string maximum-length: 100		A name given to this group.
notes	string		Notes about this group, and to whom this group should be applied.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"company": number,
	"deleted": boolean,
	"id": number,
	"name": string,
	"notes": string,
	"since": string,
	"v": [
		number
	]
}

UserNotificationsobject

Definition of how and when to send alerts to the user.

JSON description

Property	Type	Description
email	email maximum-length: 254 minimum-length: 6	Email address where the sent is sent. If not specified, the email address from the User's Contact is taken. If the contact has no email address, the alert is sent to the user's login.
enabled	boolean	A flag for whether or not this schedule is in use.
end	timespan see: UserGeneral.timezone	End time portion of the schedule that defines a period of the day when the user wants to receive alerts. The time value is defined in local time, not UTC.
name	string maximum-length: 100	A common name like "Weekdays" or "Off Hours".
offline	Array.<NotificationMethod>	A list of the types of methods to use to notify the user when they are not connected.
online	Array.<NotificationMethod>	A list of the types of methods to use to notify the user when they have an active WebSocket connection.
sms	uint64?	SMS address where the alert is sent. If not specified, the mobile phone number from the User's Contact is taken. If the contact has no mobile phone number, the alert is not sent.
start	timespan see: UserGeneral.timezone	Start time portion of the schedule that defines a period of the day when the user wants to receive alerts. The time value is defined in local time, not UTC.
weekdays	Array.<boolean> see: UserGeneral.timezone fixed count: 7	A 7 item, boolean array, determines if the user should be notified on that day of the week. The days of the week are defined in local time, not UTC.

JSON structure

{
	"email": string,
	"enabled": boolean,
	"end": string,
	"name": string,
	"offline": [
		string
	],
	"online": [
		string
	],
	"sms": number,
	"start": string,
	"weekdays": [
		boolean
	]
}

White-labelling

ColourStyleobject

Part of the White-labelling profile definitions.

JSON description

Property	Type	Description
fill	colour maximum-length: 22	The colour of the background.
stroke	colour maximum-length: 22	The colour of the text or outline.

JSON structure

{
	"fill": string,
	"stroke": string
}

CompanyResellerobject

Defines the seller company's details for white-labelling.

JSON description

Property	Type	Description
contactInfo	Object.<string, uint64> see: Contact.id maximum-count of keys: 100 for values see: Contact.id	A list of Contacts for company specific things like Technical Support, Billing, etc...
domain	string maximum-length: 100	The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
favourite	string maximum-length: 200	The name of the icon file used for browser bookmarks.
gamut	Object.<string, ColourStyle> maximum-length of keys: 25	Colours used as templates for status tags, labels, and places.
graphics	Object.<string, codified> maximum-length of keys: 25 maximum-length of values: 30	A list of symbol names and their corresponding FontAwesome icon names.
icon	string maximum-length: 200	The name of the image uploaded as the logo (used for collapsed/mobile view).
id	uint64 see: Company.id	Unique identifier of the Company.
languages	Array.<codified> maximum-length of values: 5	A list of supported languages for your customers.
logo	string maximum-length: 200	The name of the image uploaded as the logo (used for regular view).
notifyEmail	NotificationServerEmail	The server used for notification and conversational email messages sent and received by the system.
notifySms	NotificationServerSms	Definition for load-balanced outbound SMS numbers for the reseller.
parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
processedUtc	datetime	When the was change procesed.
recoverBody	string	The body of the email sent to a user requesting a password reset.
recoverIsHtml	boolean
recoverSubject	string	The subject of the email sent to a user requesting a password reset.
serviceName	string maximum-length: 150	The name of the branded service being provided to the seller's customers.
termsPreamble	string	A preamble to the general terms and conditions offered by Fleet Freedom.
termsUpdated	datetime	The date and time when the terms were updated. This will promt users who are logging-in to re-agree to the new terms
updated		by: login, from: monster
v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
website	Object.<string, colour> maximum-length of keys: 25 maximum-length of values: 22	Themed colours used in the web-based UI.

JSON structure

{
	"contactInfo": {
		string: number
	},
	"domain": string,
	"favourite": string,
	"gamut": {
		string: {
			"fill": string,
			"stroke": string
		}
	},
	"graphics": {
		string: string
	},
	"icon": string,
	"id": number,
	"languages": [
		string
	],
	"logo": string,
	"notifyEmail": {
		"incomingAddress": string,
		"incomingLogin": string,
		"incomingMessageNumber": number,
		"incomingPort": number,
		"incomingSecure": boolean,
		"incomingType": string,
		"outgoingAddress": string,
		"outgoingLogin": string,
		"outgoingPort": number,
		"outgoingReplyTo": string,
		"outgoingSecure": boolean,
		"outgoingType": string
	},
	"notifySms": {
		"notifyLimit": number,
		"phoneNumbers": {
			string: [
				number
			]
		}
	},
	"parent": number,
	"processedUtc": string,
	"recoverBody": string,
	"recoverIsHtml": boolean,
	"recoverSubject": string,
	"serviceName": string,
	"termsPreamble": string,
	"termsUpdated": string,
	"updated": {
	},
	"v": [
		number
	],
	"website": {
		string: string
	}
}

CompanyResellerDeletedobject

The message format for when a deleted CompanyReseller is retrieved

JSON description

Property	Type	Value	Description
deleted	boolean	`true`
id	uint64 see: Company.id		Unique identifier of the Company.
parent	uint64 see: Company.id		The unique identifier of this company's parent organization.
since	datetime		A timestamp from the moment the object was deleted.
v	Array.<uint32>		Object version keys used to validate synchronization for all object properties.

JSON structure

{
	"deleted": boolean,
	"id": number,
	"parent": number,
	"since": string,
	"v": [
		number
	]
}

NotificationServerEmailobject

The server used for notification and conversational email messages sent and received by the system.

JSON description

Property	Type	Description
incomingAddress	string	The domain or IP address of the incoming email server.
incomingLogin	string	The username used to login to the incoming email server.
incomingMessageNumber	uint32	IMAP message sequence number so only recent messages are retrieved.
incomingPort	uint16	The port number of the incoming email server.
incomingSecure	boolean	Is the incoming email server using a secure SSL/TLS connection (it should).
incomingType	string	The type of incoming protocol to use (IMAP or POP3).
outgoingAddress	string	The domain or IP address of the outgoing email server.
outgoingLogin	string	The username used to login to the outgoing email server.
outgoingPort	uint16	The port number of the outgoing email server.
outgoingReplyTo	email	An optional field which can be set as the "sent from" and/or "reply-to" address.
outgoingSecure	boolean	Is the outgoing email server using a secure SSL/TLS connection (it should).
outgoingType	string	The type of outgoing protocol to use (only SMTP).

JSON structure

{
	"incomingAddress": string,
	"incomingLogin": string,
	"incomingMessageNumber": number,
	"incomingPort": number,
	"incomingSecure": boolean,
	"incomingType": string,
	"outgoingAddress": string,
	"outgoingLogin": string,
	"outgoingPort": number,
	"outgoingReplyTo": string,
	"outgoingSecure": boolean,
	"outgoingType": string
}

NotificationServerSmsobject

Definition for load-balanced outbound SMS numbers for the White-labelling profile.

JSON description

Property	Type	Description
notifyLimit	uint16	A per-number/per-day limit on the amount of Notifications sent.
phoneNumbers	Object.<string, Array.<phone>> fixed length of keys: 2	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.

JSON structure

{
	"notifyLimit": number,
	"phoneNumbers": {
		string: [
			number
		]
	}
}

ParamCompanyDirectoryGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyGeneralGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyLabelsGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyPoliciesGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyResellerBatchDeleteBaseParametersobject

Request description

Property	Type	Required	Description
companyResellers	Array.<ParamId>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"companyResellers": [
		{
			"id": number
		}
	],
	"reqId": number
}

ParamCompanyResellerBatchMergeBaseParametersobject

Request description

Property	Type	Required	Description
companyResellers	Array.<ParameterContent>	optional	Array of parameters successfully parsed by the sub-command.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"companyResellers": [
		{
			"contactInfo": {
				string: number
			},
			"domain": string,
			"favourite": string,
			"gamut": {
				string: {
					"fill": string,
					"stroke": string
				}
			},
			"graphics": {
				string: string
			},
			"icon": string,
			"id": number,
			"languages": [
				string
			],
			"logo": string,
			"notifyEmail": {
				"incomingAddress": string,
				"incomingLogin": string,
				"incomingMessageNumber": number,
				"incomingPassword": string,
				"incomingPort": number,
				"incomingSecure": boolean,
				"incomingType": string,
				"outgoingAddress": string,
				"outgoingLogin": string,
				"outgoingPassword": string,
				"outgoingPort": number,
				"outgoingReplyTo": string,
				"outgoingSecure": boolean
			},
			"notifySms": {
				"notifyLimit": number,
				"phoneNumbers": {
					string: [
						number
					]
				}
			},
			"recoverBody": string,
			"recoverIsHtml": boolean,
			"recoverSubject": string,
			"serviceName": string,
			"termsPreamble": string,
			"termsUpdated": string,
			"v": [
				number
			],
			"website": {
				string: string
			}
		}
	],
	"reqId": number
}

ParamCompanyResellerDeleteBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyResellerGetBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamCompanyResellerListByParentBaseParametersobject

Request description

Property	Type	Required	Default	Description
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
limit	uint16?	optional		Maximum number of objects in this response.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"limit": number,
	"reqId": number
}

ParamCompanyResellerListByRefPairsBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always
company.id	uint64	always		Identifier given as input for the command.
highest	uint64?	optional
includeArchive	boolean	optional	`false`	When true, the command will also return archived objects.
includeDeleted	boolean	optional	`false`	When true, the command will also return deleted objects.
includeParent	boolean	optional
limit	uint16?	optional		Maximum number of objects in this response.
lowest	uint64?	optional
references	Object.<string, string> see: CompanyGeneral.references	optional		Case-insensitive reference pairs used to match Companys.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.
tree	boolean	optional

Request structure

{
	"company": {
		"id": number
	},
	"highest": number,
	"includeArchive": boolean,
	"includeDeleted": boolean,
	"includeParent": boolean,
	"limit": number,
	"lowest": number,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyResellerMergeBaseParametersobject

Request description

Property	Type	Required	Description
companyReseller	Object.<string, ?>	always	A simple object to contain the CompanyReseller parameters.
companyReseller.contactInfo	Object.<string, uint64?> maximum-count of keys: 100 for values see: Contact.id	optional	A list of Contacts for company specific things like Technical Support, Billing, etc...
companyReseller.domain	string maximum-length: 100	create	The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
companyReseller.favourite	string maximum-length: 200	optional	The name of the icon file used for browser bookmarks.
companyReseller.gamut	Object.<string, ColourStyle> maximum-length of keys: 25	create	Colours used as templates for status tags, labels, and places.
companyReseller.graphics	Object.<string, codified> maximum-length of keys: 25 maximum-length of values: 30	create	A list of symbol names and their corresponding FontAwesome icon names.
companyReseller.icon	string maximum-length: 200	create	The name of the image uploaded as the logo (used for collapsed/mobile view).
companyReseller.id	uint64	always	The unique identifier of the company you want to update.
companyReseller.languages	Array.<codified> maximum-length of values: 5	optional	A list of supported languages for your customers.
companyReseller.logo	string maximum-length: 200	create	The name of the image uploaded as the logo (used for regular view).
companyReseller.notifyEmail	Object.<string, ?>	create	Settings for sending and receiving email notifcations and asset messages.
companyReseller.notifyEmail.incomingAddress	string	optional	The domain or IP address of the incoming email server.
companyReseller.notifyEmail.incomingLogin	string	optional	The username used to login to the incoming email server.
companyReseller.notifyEmail.incomingMessageNumber	uint32?	optional	IMAP message sequence number so only recent messages are retrieved.
companyReseller.notifyEmail.incomingPassword	string	optional	The password used to login to the incoming email server.
companyReseller.notifyEmail.incomingPort	uint16?	optional	The port number of the incoming email server.
companyReseller.notifyEmail.incomingSecure	boolean	optional	Is the incoming email server using a secure SSL/TLS connection (it should).
companyReseller.notifyEmail.incomingType	string	optional	The type of incoming protocol to use (IMAP or POP3).
companyReseller.notifyEmail.outgoingAddress	string	optional	The domain or IP address of the outgoing email server.
companyReseller.notifyEmail.outgoingLogin	string	optional	The username used to login to the outgoing email server.
companyReseller.notifyEmail.outgoingPassword	string	optional	The password used to login to the outgoing email server.
companyReseller.notifyEmail.outgoingPort	uint16?	optional	The port number of the outgoing email server.
companyReseller.notifyEmail.outgoingReplyTo	email	optional	An optional field which can be set as the "sent from" and/or "reply-to" address.
companyReseller.notifyEmail.outgoingSecure	boolean	optional	Is the outgoing email server using a secure SSL/TLS connection (it should).
companyReseller.notifySms	Object.<string, ?>	create	Settings for sending and receiving SMS notifcations and asset messages.
companyReseller.notifySms.notifyLimit	uint16?	optional	A per-number/per-day limit on the amount of Notifications sent.
companyReseller.notifySms.phoneNumbers	Object.<string, Array.<phone>> fixed length of keys: 2	optional	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
companyReseller.recoverBody	string	create	The body of the email sent to a user requesting a password reset.
companyReseller.recoverIsHtml	boolean	optional
companyReseller.recoverSubject	string	optional	The subject of the email sent to a user requesting a password reset.
companyReseller.serviceName	string maximum-length: 150	create	The name of the branded service being provided to the seller's customers.
companyReseller.termsPreamble	string	optional	A small body of text added as a preamble for the Trak-iT Wireless Inc. terms of service.
companyReseller.termsUpdated	datetime	optional	A timestamp from when the preamble was changed.
companyReseller.v	Array.<int32>	optional
companyReseller.website	Object.<string, colour> maximum-length of keys: 25 maximum-length of values: 22	create	Themed colours used in the web-based UI.
reqId	int32?	optional	Identifier used by external system to correlate requests to responses.

Request structure

{
	"companyReseller": {
		"contactInfo": {
			string: number
		},
		"domain": string,
		"favourite": string,
		"gamut": {
			string: {
				"fill": string,
				"stroke": string
			}
		},
		"graphics": {
			string: string
		},
		"icon": string,
		"id": number,
		"languages": [
			string
		],
		"logo": string,
		"notifyEmail": {
			"incomingAddress": string,
			"incomingLogin": string,
			"incomingMessageNumber": number,
			"incomingPassword": string,
			"incomingPort": number,
			"incomingSecure": boolean,
			"incomingType": string,
			"outgoingAddress": string,
			"outgoingLogin": string,
			"outgoingPassword": string,
			"outgoingPort": number,
			"outgoingReplyTo": string,
			"outgoingSecure": boolean
		},
		"notifySms": {
			"notifyLimit": number,
			"phoneNumbers": {
				string: [
					number
				]
			}
		},
		"recoverBody": string,
		"recoverIsHtml": boolean,
		"recoverSubject": string,
		"serviceName": string,
		"termsPreamble": string,
		"termsUpdated": string,
		"v": [
			number
		],
		"website": {
			string: string
		}
	},
	"reqId": number
}

ParamCompanyResellerRestoreBaseParametersobject

Request description

Property	Type	Required	Default	Description
company	ParamId	always		An object to contain the "id" key.
company.id	uint64	always		Identifier given as input for the command.
includeDeleted	boolean	optional	`false`	When true, the command will also return a deleted Company.
reqId	int32?	optional		Identifier used by external system to correlate requests to responses.

Request structure

{
	"company": {
		"id": number
	},
	"includeDeleted": boolean,
	"reqId": number
}

ParamEmailServerobject

The server used for notification and conversational email messages sent and received by the system.

JSON description

Property	Type	Description
incomingAddress	string	The domain or IP address of the incoming email server.
incomingLogin	string	The username used to login to the incoming email server.
incomingMessageNumber	uint32?	IMAP message sequence number so only recent messages are retrieved.
incomingPassword	string	The password used to login to the incoming email server.
incomingPort	uint16?	The port number of the incoming email server.
incomingSecure	boolean	Is the incoming email server using a secure SSL/TLS connection (it should).
incomingType	string	The type of incoming protocol to use (IMAP or POP3).
outgoingAddress	string	The domain or IP address of the outgoing email server.
outgoingLogin	string	The username used to login to the outgoing email server.
outgoingPassword	string	The password used to login to the outgoing email server.
outgoingPort	uint16?	The port number of the outgoing email server.
outgoingReplyTo	email	An optional field which can be set as the "sent from" and/or "reply-to" address.
outgoingSecure	boolean	Is the outgoing email server using a secure SSL/TLS connection (it should).

JSON structure

{
	"incomingAddress": string,
	"incomingLogin": string,
	"incomingMessageNumber": number,
	"incomingPassword": string,
	"incomingPort": number,
	"incomingSecure": boolean,
	"incomingType": string,
	"outgoingAddress": string,
	"outgoingLogin": string,
	"outgoingPassword": string,
	"outgoingPort": number,
	"outgoingReplyTo": string,
	"outgoingSecure": boolean
}

ParamSmsServerobject

Definition for load-balanced outbound SMS numbers for the White-labelling profile.

JSON description

Property	Type	Description
notifyLimit	uint16?	A per-number/per-day limit on the amount of Notifications sent.
phoneNumbers	Object.<string, Array.<phone>> fixed length of keys: 2	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.

JSON structure

{
	"notifyLimit": number,
	"phoneNumbers": {
		string: [
			number
		]
	}
}

RespCompanyDirectoryGetBaseResponseobject

Response description

Property	Type	Description
companyDirectory		The requested CompanyDirectory.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyDirectory": {
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyGeneralGetBaseResponseobject

Response description

Property	Type	Description
companyGeneral	CompanyGeneral	The requested CompanyGeneral.
companyGeneral.id	uint64 see: Company.id	Unique identifier of the Company.
companyGeneral.name	string maximum-length: 100	The organizational name.
companyGeneral.notes	string	Notes.
companyGeneral.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
companyGeneral.processedUtc	datetime	When the was change procesed.
companyGeneral.references	Object.<string, string> maximum-count: 10 maximum-length of keys: 20 maximum-length of values: 100	Name/value collections of custom fields used to refer to external systems.
companyGeneral.updated		by: login, from: monster
companyGeneral.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyGeneral": {
		"id": number,
		"name": string,
		"notes": string,
		"parent": number,
		"processedUtc": string,
		"references": {
			string: string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyLabelsGetBaseResponseobject

Response description

Property	Type	Description
companyLabels	CompanyStyles	The requested CompanyStyles.
companyLabels.id	uint64 see: Company.id	Unique identifier of the Company.
companyLabels.labels	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for labels added to Assets, Places, and other things.
companyLabels.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
companyLabels.processedUtc	datetime	When the was change procesed.
companyLabels.tags	Object.<codified, LabelStyle> for keys see: LabelStyle.code	The styles for status tags added to Assets.
companyLabels.updated		by: login, from: monster
companyLabels.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyLabels": {
		"id": number,
		"labels": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"parent": number,
		"processedUtc": string,
		"tags": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyPoliciesGetBaseResponseobject

Response description

Property	Type	Description
companyPolicies	CompanyPolicies	The requested CompanyPolicies.
companyPolicies.id	uint64 see: Company.id	Unique identifier of the Company.
companyPolicies.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
companyPolicies.passwordPolicy	PasswordPolicy	The password complexity and expiry policy.
companyPolicies.passwordPolicy.expireMode	PasswordExpiryMode	Defines how passwords expire.
companyPolicies.passwordPolicy.expireThreshold	byte	The threshold for expiry.
companyPolicies.passwordPolicy.includeLetters	boolean	Do passwords require alphabetical characters.
companyPolicies.passwordPolicy.includeNumbers	boolean	Do passwords require numeric characters.
companyPolicies.passwordPolicy.includeSpecial	boolean	Do passwords require non-alphanumeric characters.
companyPolicies.passwordPolicy.includeUpperLower	boolean	Do passwords require upper-case and lower-case letters.
companyPolicies.passwordPolicy.minimumLength	byte	The minimum number of characters required.
companyPolicies.processedUtc	datetime	When the was change procesed.
companyPolicies.sessionPolicy	SessionPolicy	The session lifetime policy.
companyPolicies.sessionPolicy.applications	Array.<string>	The list of applications users are allowed to use to create sessions.
companyPolicies.sessionPolicy.expireTimeout	uint16	The lifetime duration of a session in minutes.
companyPolicies.sessionPolicy.idleAllowed	boolean	Defines whether a session should be automatically killed when the connection breaks.
companyPolicies.sessionPolicy.ipv4Ranges	Array.<ipv4> maximum-length of values: 19	Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
companyPolicies.sessionPolicy.maxSessions	byte	The maximum number of sessions allowed per user.
companyPolicies.sessionPolicy.multiUser	SessionMultiUser	Defines the behaviour of the system when a user creates multiple sessions.
companyPolicies.updated		by: login, from: monster
companyPolicies.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyPolicies": {
		"id": number,
		"parent": number,
		"passwordPolicy": {
			"expireMode": string,
			"expireThreshold": number,
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number
		},
		"processedUtc": string,
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string
			],
			"maxSessions": number,
			"multiUser": string
		},
		"updated": {
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerBatchDeleteBaseResponseobject

Response description

Property	Type	Description
companyResellers	Array.<RespParentDeleted>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyResellers": [
		{
			"deleted": boolean,
			"id": number,
			"parent": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerBatchMergeBaseResponseobject

Response description

Property	Type	Description
companyResellers	Array.<RespIdParent>	Array or responses successfully processed by the sub-command.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyResellers": [
		{
			"id": number,
			"parent": number
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerDeleteBaseResponseobject

Response description

Property	Type	Description
companyReseller	RespParentDeleted	An object which contains the company's unique identifier and deleted status.
companyReseller.deleted	boolean	Flag showing if the object is deleted.
companyReseller.id	uint64?	Identifier given as input for the command.
companyReseller.parent	uint64	Identifier of the parent to which the Company is a child.
companyReseller.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyReseller": {
		"deleted": boolean,
		"id": number,
		"parent": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerGetBaseResponseobject

Response description

Property	Type	Description
companyReseller	CompanyReseller	The requested CompanyReseller.
companyReseller.contactInfo	Object.<string, uint64> see: Contact.id maximum-count of keys: 100 for values see: Contact.id	A list of Contacts for company specific things like Technical Support, Billing, etc...
companyReseller.domain	string maximum-length: 100	The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
companyReseller.favourite	string maximum-length: 200	The name of the icon file used for browser bookmarks.
companyReseller.gamut	Object.<string, ColourStyle> maximum-length of keys: 25	Colours used as templates for status tags, labels, and places.
companyReseller.graphics	Object.<string, codified> maximum-length of keys: 25 maximum-length of values: 30	A list of symbol names and their corresponding FontAwesome icon names.
companyReseller.icon	string maximum-length: 200	The name of the image uploaded as the logo (used for collapsed/mobile view).
companyReseller.id	uint64 see: Company.id	Unique identifier of the Company.
companyReseller.languages	Array.<codified> maximum-length of values: 5	A list of supported languages for your customers.
companyReseller.logo	string maximum-length: 200	The name of the image uploaded as the logo (used for regular view).
companyReseller.notifyEmail	NotificationServerEmail	The server used for notification and conversational email messages sent and received by the system.
companyReseller.notifyEmail.incomingAddress	string	The domain or IP address of the incoming email server.
companyReseller.notifyEmail.incomingLogin	string	The username used to login to the incoming email server.
companyReseller.notifyEmail.incomingMessageNumber	uint32	IMAP message sequence number so only recent messages are retrieved.
companyReseller.notifyEmail.incomingPort	uint16	The port number of the incoming email server.
companyReseller.notifyEmail.incomingSecure	boolean	Is the incoming email server using a secure SSL/TLS connection (it should).
companyReseller.notifyEmail.incomingType	string	The type of incoming protocol to use (IMAP or POP3).
companyReseller.notifyEmail.outgoingAddress	string	The domain or IP address of the outgoing email server.
companyReseller.notifyEmail.outgoingLogin	string	The username used to login to the outgoing email server.
companyReseller.notifyEmail.outgoingPort	uint16	The port number of the outgoing email server.
companyReseller.notifyEmail.outgoingReplyTo	email	An optional field which can be set as the "sent from" and/or "reply-to" address.
companyReseller.notifyEmail.outgoingSecure	boolean	Is the outgoing email server using a secure SSL/TLS connection (it should).
companyReseller.notifyEmail.outgoingType	string	The type of outgoing protocol to use (only SMTP).
companyReseller.notifySms	NotificationServerSms	Definition for load-balanced outbound SMS numbers for the reseller.
companyReseller.notifySms.notifyLimit	uint16	A per-number/per-day limit on the amount of Notifications sent.
companyReseller.notifySms.phoneNumbers	Object.<string, Array.<phone>> fixed length of keys: 2	All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
companyReseller.parent	uint64 see: Company.id	The unique identifier of this company's parent organization.
companyReseller.processedUtc	datetime	When the was change procesed.
companyReseller.recoverBody	string	The body of the email sent to a user requesting a password reset.
companyReseller.recoverIsHtml	boolean
companyReseller.recoverSubject	string	The subject of the email sent to a user requesting a password reset.
companyReseller.serviceName	string maximum-length: 150	The name of the branded service being provided to the seller's customers.
companyReseller.termsPreamble	string	A preamble to the general terms and conditions offered by Fleet Freedom.
companyReseller.termsUpdated	datetime	The date and time when the terms were updated. This will promt users who are logging-in to re-agree to the new terms
companyReseller.updated		by: login, from: monster
companyReseller.v	Array.<uint32>	Object version keys used to validate synchronization for all object properties.
companyReseller.website	Object.<string, colour> maximum-length of keys: 25 maximum-length of values: 22	Themed colours used in the web-based UI.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyReseller": {
		"contactInfo": {
			string: number
		},
		"domain": string,
		"favourite": string,
		"gamut": {
			string: {
				"fill": string,
				"stroke": string
			}
		},
		"graphics": {
			string: string
		},
		"icon": string,
		"id": number,
		"languages": [
			string
		],
		"logo": string,
		"notifyEmail": {
			"incomingAddress": string,
			"incomingLogin": string,
			"incomingMessageNumber": number,
			"incomingPort": number,
			"incomingSecure": boolean,
			"incomingType": string,
			"outgoingAddress": string,
			"outgoingLogin": string,
			"outgoingPort": number,
			"outgoingReplyTo": string,
			"outgoingSecure": boolean,
			"outgoingType": string
		},
		"notifySms": {
			"notifyLimit": number,
			"phoneNumbers": {
				string: [
					number
				]
			}
		},
		"parent": number,
		"processedUtc": string,
		"recoverBody": string,
		"recoverIsHtml": boolean,
		"recoverSubject": string,
		"serviceName": string,
		"termsPreamble": string,
		"termsUpdated": string,
		"updated": {
		},
		"v": [
			number
		],
		"website": {
			string: string
		}
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerListByParentBaseResponseobject

Response description

Property	Type	Description
companyResellers	Array.<CompanyReseller>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyResellers": [
		{
			"contactInfo": {
				string: number
			},
			"domain": string,
			"favourite": string,
			"gamut": {
				string: {
					"fill": string,
					"stroke": string
				}
			},
			"graphics": {
				string: string
			},
			"icon": string,
			"id": number,
			"languages": [
				string
			],
			"logo": string,
			"notifyEmail": {
				"incomingAddress": string,
				"incomingLogin": string,
				"incomingMessageNumber": number,
				"incomingPort": number,
				"incomingSecure": boolean,
				"incomingType": string,
				"outgoingAddress": string,
				"outgoingLogin": string,
				"outgoingPort": number,
				"outgoingReplyTo": string,
				"outgoingSecure": boolean,
				"outgoingType": string
			},
			"notifySms": {
				"notifyLimit": number,
				"phoneNumbers": {
					string: [
						number
					]
				}
			},
			"parent": number,
			"processedUtc": string,
			"recoverBody": string,
			"recoverIsHtml": boolean,
			"recoverSubject": string,
			"serviceName": string,
			"termsPreamble": string,
			"termsUpdated": string,
			"updated": {
			},
			"v": [
				number
			],
			"website": {
				string: string
			}
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerListByRefPairsBaseResponseobject

Response description

Property	Type	Description
companyResellers	Array.<CompanyReseller>	The list of requested companies.
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
references	Object.<string, string>	The reference string given as input.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyResellers": [
		{
			"contactInfo": {
				string: number
			},
			"domain": string,
			"favourite": string,
			"gamut": {
				string: {
					"fill": string,
					"stroke": string
				}
			},
			"graphics": {
				string: string
			},
			"icon": string,
			"id": number,
			"languages": [
				string
			],
			"logo": string,
			"notifyEmail": {
				"incomingAddress": string,
				"incomingLogin": string,
				"incomingMessageNumber": number,
				"incomingPort": number,
				"incomingSecure": boolean,
				"incomingType": string,
				"outgoingAddress": string,
				"outgoingLogin": string,
				"outgoingPort": number,
				"outgoingReplyTo": string,
				"outgoingSecure": boolean,
				"outgoingType": string
			},
			"notifySms": {
				"notifyLimit": number,
				"phoneNumbers": {
					string: [
						number
					]
				}
			},
			"parent": number,
			"processedUtc": string,
			"recoverBody": string,
			"recoverIsHtml": boolean,
			"recoverSubject": string,
			"serviceName": string,
			"termsPreamble": string,
			"termsUpdated": string,
			"updated": {
			},
			"v": [
				number
			],
			"website": {
				string: string
			}
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespCompanyResellerMergeBaseResponseobject

Response description

Property	Type	Description
companyReseller	RespIdParent	An object which contains the "id" and "company" keys.
companyReseller.id	uint64?	Identifier given as input for the command.
companyReseller.parent	uint64?	Identifier of the parent to which this company belongs
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyReseller": {
		"id": number,
		"parent": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyResellerRestoreBaseResponseobject

Response description

Property	Type	Description
companyReseller	RespParentDeleted	An object which contains the company's unique identifier and deleted status.
companyReseller.deleted	boolean	Flag showing if the object is deleted.
companyReseller.id	uint64?	Identifier given as input for the command.
companyReseller.parent	uint64	Identifier of the parent to which the Company is a child.
companyReseller.v	Array.<uint32>
errorCode	ErrorCode	The unique, numeric error code when processing this request.
errorDetails	ErrorDetail	An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
message	string	An English description of the error.
reqId	int32?	Identifier used by external system to correlate requests to responses.

Response structure

{
	"companyReseller": {
		"deleted": boolean,
		"id": number,
		"parent": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}