JSON Reference

Download JSDoc Helper
© 2021 Trak-iT Wireless Inc.
Updated Wednesday August 21, 2024 09:50AM
Version 4.37.13

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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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		Takes the value of Parameters.includeDeleted when not specified. 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
}