Call our help line: 1 866-787-2548

JSON Reference

Assets

Behaviours

Billing

Dispatch

File Hosting

Hours of Service

Maintenance

Messaging

Providers and Configurations

Reports

Users and Groups

API Definitions

bytenumber

8bit unsigned integer
Format
Value range:
0
to
255

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
InputOutput
Trucktruck
Truck 13truck-13
Truck #19truck-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.
Read more: CSS Colours
Pattern
FormatDescription
#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.
Legend
FlagMeaning
RRed
GGreen
BBlue
AAlpha (transparency)
HHue
SSaturation
LLightness
VValue

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
FlagMeaning
yyyyFour digit year.
MMTwo digit month.
ddTwo digit day of the month.
TSeparator between date and time.
HHTwo digit hours ranging from 00 to 23.
mmTwo digit minute.
ssTwo digit second.
fffOptional three digit millisecond.
ZA terminator representing the UTC timezone.

datetimetemplatestring

Date and Time formatting
These formats define the text representation of dates and times.
Legend
FlagMeaning
yyTwo digit year.
yyyyFour digit year.
MOne or two digit month.
MMTwo digit month.
MMMAbbreviated month name (ie: Jan).
MMMMMonth name.
dOne or two digit day of the month.
ddTwo digit day of the month.
dddAbbreviated day name (ie: Mon).
ddddDay name (ie: Monday).
hOne or two digit hour ranging from 1 to 12.
HOne or two digit hour ranging from 0 to 23.
hhTwo digit hour ranging from 01 to 12.
HHTwo digit hours ranging from 00 to 23.
mOne or two digit minute.
mmTwo digit minute.
sOne or two digit second
ssTwo digit second.
fOne digit millisecond.
ffTwo digit millisecond.
fffThree digit millisecond.
tFirst letter of meridium (ie: a or p).
TFirst letter of meridium (ie: A or P).
ttMeridium (ie: am or pm).
TTMeridium (ie: AM or PM).
\Escape the next character.
Examples
InputOutput
ddd MMM d, yyyyTue Oct 19, 2021
h:mm:ss tt1:42:15 pm
H\h m\m13h 42m
yyyy-MM-dd\THH:mm:ss.fffZ2021-10-19T17:42:15.843Z

doublenumber

Double-precision floating point number
Format
Value range:
-1.7976931348623157e+308
to
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.
Read more: RFC 2822
Format
user@domain.tld

ErrorCodeuint16number

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

It's easiest to look at a few examples. Given the following...

Asset 1
{
	"id": 1234,
	"name": "Truck",
	"kind": "vehicle",
	"labels": [
		"east-coast",
		"head-office"
	]
}
Asset 2
{
	"id": 4567,
	"name": "Alex",
	"kind": "person",
	"labels": [
		"drivers",
		"head-office"
	]
}
Asset 3
{
	"id": 7890,
	"name": "Mike",
	"kind": "person",
	"labels": [
		"east-coast",
		"service"
	]
}
InputOutput
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.
Read more: Guid Struct
Format
xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx

int16number

16bit integer
Format
Value range:
-32768
to
32767

int32number

32bit integer
Format
Value range:
-2147483648
to
2147483647

int64number

64bit integer
Format
Value range:
-9223372036854775808
to
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
FlagMeaning
n A number ranging from 0 to 255.
rCIDR notation to indicate a range of IPv4 addresses. The number ranges from 32 to 0.

LatLngobject

A coordinate on the globe
JSON description
PropertyTypeDescription
latdoubleLatitude
lngdoubleLongitude
JSON structure
{
	"lat": number,
	"lng": number
}

LatLngBoundsobject

A boundary on the globe
JSON description
PropertyTypeDescription
eastdoubleEastern longitude
northdoubleNorthern latitude
southdoubleSouthern latitude
westdoubleWestern longitude
JSON structure
{
	"east": number,
	"north": number,
	"south": number,
	"west": number
}

ParamNoOperationBaseParametersobject

Request description
PropertyTypeRequiredDescription
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"reqId": number
}

ParamTimezoneGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
timezoneParamCodealwaysAn object to contain the "code" of the Timezone.
timezone.codestringalwaysA "code" identifying a resource.
Request structure
{
	"reqId": number,
	"timezone": {
		"code": string
	}
}

ParamTimezoneListBaseParametersobject

Request description
PropertyTypeRequiredDescription
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"reqId": number
}

ParamUnknownBaseParametersobject

Request description
PropertyTypeRequiredDescription
reqIdint32?optionalIdentifier 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
FlagMeaning
1Prefix
AAAArea Code
LLLLocal switch number
SSSSSubscriber number (Line number)

Pointobject

A coordinate on a flat surface
JSON description
PropertyTypeDescription
xdoubleHorizontal coordinate
ydoubleVertical 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
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespTimezoneGetBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
timezoneTimezoneThe requested Timezone.
timezone.codecodifiedUnique timezone code
timezone.dstbooleanIndicates whether this timezone abides by daylight savings
timezone.namestringCommon timezone name
timezone.offsetint16Minutes 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
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
timezonesArray.<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
PropertyTypeDescription
commandNamestringName of the command you attempted to execute.
datastringThe first 100 characters of data sent with the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
to
127

singlenumber

Single-precision floating point number
Format
Value range:
-3.40282347E+38F
to
3.40282347E+38F

Sizeobject

Dimensions on a flat surface
JSON description
PropertyTypeDescription
heightdoubleHeight
widthdoubleWidth
JSON structure
{
	"height": number,
	"width": number
}

Squareobject

A boundary on a flat surface
JSON description
PropertyTypeDescription
bottomdoubleLowest vertical coordinate
leftdoubleLeft-most horizontal coordinate
rightdoubleRight-most horizontal coordinate
topdoubleHighest 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
FlagMeaning
-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.
mmTwo digit minute
ssOptional 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
PropertyTypeDescription
codecodifiedUnique timezone code
dstbooleanIndicates whether this timezone abides by daylight savings
namestringCommon timezone name
offsetint16Minutes offset from GMT
JSON structure
{
	"code": string,
	"dst": boolean,
	"name": string,
	"offset": number
}

uint16number

16bit unsigned integer
Format
Value range:
0
to
65535

uint32number

32bit unsigned integer
Format
Value range:
0
to
4294967295

uint64number

64bit unsigned integer
Format
Value range:
0
to
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.
Read more: RFC 1738
Format
http[s]://domain.tld/path?query#fragment
protocol:path?query

API Definitions - Errors

ErrorDetailobject Abstract

An object which contains details about the error.
JSON description
PropertyTypeDescription
kindstringA hint for deserializing the error's details.
JSON structure
{
	"kind": string
}

ErrorDetailBadIdsErrorDetailobject

These details contain unique identifiers that caused the failure.
JSON description
PropertyTypeValueDescription
invalidArray.<uint64>
kindstring"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
PropertyTypeValueDescription
invalidArray.<int32>
kindstring"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
PropertyTypeValueDescription
invalidArray.<string>
kindstring"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
PropertyTypeValueDescription
errorsArray.<ErrorDetailBatchInner>Index-presevered list of sub-command errors.
kindstring"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
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn 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
PropertyTypeValueDescription
assetsArray.<uint64>
for values see: Asset.id
A list of Assets currently being referenced.
kindstring"contactInUse"A hint for deserializing the error's details.
usersArray.<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
PropertyTypeValueDescription
countint32The number of items that failed, or number of items preventing success
kindstring"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
PropertyTypeValueDescription
inputstringThe given input which caused the error.
kindstring"enum"A hint for deserializing the error's details.
validArray.<string>This is a list of possible values the input should have been.
JSON structure
{
	"input": string,
	"kind": string,
	"valid": [
		string
	]
}

ErrorDetailEscalatedLabelsErrorDetailobject

Details of a permission escallation error thrown when modifying a labelled resource that would grant aditional permissions.
JSON description
PropertyTypeValueDescription
escalationsObject.<uint64, Array.<string>>
for keys see: Company.id
for values see: LabelStyle.code
This is a dictionary of company id and list of LabelStyle.codes.
kindstring"escalatedLabels"A hint for deserializing the error's details.
JSON structure
{
	"escalations": {
		string: [
			string
		]
	},
	"kind": string
}

ErrorDetailEscalationErrorDetailobject

Details of a permission escallation error thrown when modifying a resource or user that would grant the following extra permissions.
JSON description
PropertyTypeValueDescription
escalationsObject.<uint64, Array.<PermissionType>>
for keys see: Company.id
This is a dictionary of company id and list of PermissionTypes.
kindstring"escalation"A hint for deserializing the error's details.
JSON structure
{
	"escalations": {
		string: [
			string
		]
	},
	"kind": string
}

ErrorDetailExternalsErrorDetailobject

These are the errors/warnings taken from the output of some other system.
JSON description
PropertyTypeValueDescription
errorsArray.<string>List of errors.
kindstring"externals"A hint for deserializing the error's details.
messagesArray.<string>List of messages.
warningsArray.<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
PropertyTypeValueDescription
formResultsArray.<uint64>
for values see: FormResult.id
A list of FormResults currently being referenced.
kindstring"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
PropertyTypeValueDescription
inputstringThe given input which caused the error.
kindstring"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
PropertyTypeValueDescription
kindstring"locked"A hint for deserializing the error's details.
timeouttimespanThe amount of time the resource is locked, or you are prevented from issuing the command.
untildatetimeThis timestamp represents the moment the resource becomes available again.
JSON structure
{
	"kind": string,
	"timeout": string,
	"until": string
}

ErrorDetailMinMaxErrorDetailobject

These are the details of when a value needed to be within a certain range, and was not.
JSON description
PropertyTypeValueDescription
kindstring"minMax"A hint for deserializing the error's details.
maxdouble?Maximum possible value.
mindouble?Minimum possible value.
JSON structure
{
	"kind": string,
	"max": number,
	"min": number
}

ErrorDetailParentErrorDetailobject

Details for how a circular company tree would have been created.
JSON description
PropertyTypeValueDescription
descendantuint64ID of the child Company that would cause a circular reference.
kindstring"parent"A hint for deserializing the error's details.
parentuint64The 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
PropertyTypeValueDescription
afterstringThe last sucessfully parsed object.
columnint32The character on which the failure occurred.
kindstring"parse"A hint for deserializing the error's details.
lineint32The 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
PropertyTypeValueDescription
inputstringThe given input which caused the error.
kindstring"phone"A hint for deserializing the error's details.
numberuint64The number that was parsed from the input.
usablestringThe 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
PropertyTypeValueDescription
kindstring"stack"A hint for deserializing the error's details.
messagestringException message.
stackstringThe 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
PropertyTypeValueDescription
commandstringThe name of the WebSocket command, or the RESTful route.
countint32How 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).
ghostIdguidThe session identifier being throttled.
ipipv4The client IP address.
kindstring"throttled"A hint for deserializing the error's details.
loginemailThe User being throttled.
timeouttimespanThe 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
PropertyTypeValueDescription
kindstring"userGroupInUse"A hint for deserializing the error's details.
usersArray.<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
PropertyTypeDescription
reqIdint32?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
PropertyTypeRequiredDescription
codestringalwaysA "code" identifying a resource.
JSON structure
{
	"code": string
}

ParamGuidobject

A container class used to house the guid identifying a resource.
JSON description
PropertyTypeRequiredDescription
guidguidalwaysThe global unique identifier.
JSON structure
{
	"guid": string
}

ParamHandleobject

A container class used to house the "handle" identifying a session.
JSON description
PropertyTypeRequiredDescription
handlestringalwaysA "handle" identifying a session.
JSON structure
{
	"handle": string
}

ParamIdobject

A container class used to house the id of the object requested.
JSON description
PropertyTypeRequiredDescription
iduint64alwaysIdentifier given as input for the command.
JSON structure
{
	"id": number
}

ParamIdentifierobject

A container class used to house the string identifying a Provider.
JSON description
PropertyTypeRequiredDescription
idstringalwaysThe Provider's identifier.
JSON structure
{
	"id": string
}

ParamKeyobject

A container class used to house the key identifying a Machine.
JSON description
PropertyTypeRequiredDescription
keystringalwaysThe 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
PropertyTypeRequiredDescription
loginemailalwaysThe 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
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
assetuint64Identifier of the Asset to which this object belongs.
companyuint64Identifier of the Company to which this object belongs.
deletedbooleanFlag showing if the object is deleted.
iduint64?Identifier given as input for the command.
vArray.<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
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
deletedbooleanFlag showing if the object is deleted.
iduint64?Identifier given as input for the command.
vArray.<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
PropertyTypeDescription
iduint64?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
PropertyTypeDescription
assetuint64Identifier of the Asset to which this object belongs
companyuint64Identifier of the Company to which this object belongs.
iduint64?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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
iduint64?Identifier given as input for the command.
profileuint64Identifier 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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
iduint64?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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
iduint64?Identifier given as input for the command.
templateuint64?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
PropertyTypeDescription
idstringIdentifier 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
PropertyTypeDescription
assetuint64?Identifier of the Asset to which this object belongs.
companyuint64Identifier of the Company to which this object belongs.
idstringIdentifier 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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
idstringIdentifier 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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
deletedbooleanFlag showing if the object is deleted.
idstringIdentifier given as input for the command.
vArray.<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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
idstringIdentifier given as input for the command.
suspendedbooleanFlag showing if the object is suspended.
vArray.<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
PropertyTypeDescription
iduint64?Identifier given as input for the command.
parentuint64?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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
iduint64?Identifier given as input for the command.
scriptuint64Identifier 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
PropertyTypeDescription
keystringThe 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
PropertyTypeDescription
companyuint64Identifier of the Company to which the Machine belongs.
keystringThe 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
PropertyTypeDescription
companyuint64Identifier of the Company to which the Machine belongs.
deletedbooleanFlag showing if the object is deleted.
keystringThe Machine's key.
vArray.<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
PropertyTypeDescription
loginstringThe 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
PropertyTypeDescription
companyuint64Identifier of the Company to which the User belongs.
loginstringThe 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
PropertyTypeDescription
companyuint64Identifier of the Company to which the User belongs.
deletedbooleanFlag showing if the object is deleted.
loginstringThe User's login.
vArray.<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
PropertyTypeDescription
deletedbooleanFlag showing if the object is deleted.
iduint64?Identifier given as input for the command.
parentuint64Identifier of the parent to which the Company is a child.
vArray.<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
PropertyTypeDescription
companyuint64Identifier of the Company to which this object belongs.
iduint64?Identifier given as input for the command.
suspendedbooleanFlag showing if the object is suspended.
vArray.<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
PropertyTypeDescription
attributesObject.<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.
companyuint64The company to which this asset belongs.
dispatchAssetDispatchCurrent jobs dispatched and driving directions.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
messagesArray.<AssetMessage>A list of messages sent to or from this asset.
messagingAddressstring
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.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
odometerdoubleThe cumulative distance travelled in kilometres.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<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.
referencesObject.<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.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<int32>
fixed count: 3
Object version keys used to validate synchronization for all object properties.
v[0]int32The first element is for the AssetGeneral properties.
v[1]int32The second element is for the AssetAdvanced properties.
v[2]int32The 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,
		"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,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"v": [
					number
				]
			}
		],
		"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,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"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
		}
	},
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"v": [
		number
	]
}

AssetAdvancedobject

Often changing details about a thing.
JSON description
PropertyTypeDescription
attributesObject.<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.
companyuint64The company to which this asset belongs.
iduint64Unique identifier of this asset.
odometerdoubleThe cumulative distance travelled in kilometres.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<string>
for values see: Provider.id
The list of devices providing events for this asset.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<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
		}
	},
	"providers": [
		string
	],
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"v": [
		number
	]
}

AssetAttributeobject

An attribute given to an asset by a behaviour script.
JSON description
PropertyTypeDescription
assetuint64The related asset which provided this attribute.
complexstringParse-able/formatted string for complex display. May contain HTML.
dtsdatetimeDate/time stamp from when this attribute was recorded (or reported) by the device.
globalbooleanWhen false, indicates that this attribute is used by an internal system and should be left untouched.
namestring
maximum-length: 100
Display name of the attribute.
providerstringThe device which provided this attribute.
rawObjectRaw value like 3.76 (volts) or true (on).
simplestringComputed/contextual value from the behaviour. Like "3.76 volts" or "on".
unitstringText 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
PropertyTypeValueDescription
companyuint64The company to which this asset belongs.
deletedbooleantrueIndicates whether this Asset is deleted.
iduint64Unique identifier of this asset.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

AssetGeneralobject

Seldom changing details about a thing.
JSON description
PropertyTypeDescription
companyuint64The company to which this asset belongs.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
messagingAddressstring
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.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
reference
Deprecated
string
maximum-length: 100
A custom field used to refer to an external system.
Use asset.references[AssetGeneral.REFERENCE] instead.
referencesObject.<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.
vArray.<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
	],
	"reference": string,
	"references": {
		string: string
	},
	"v": [
		number
	]
}

AssetPlaceStatusobject

A simple status for each place an Asset visits.
JSON description
PropertyTypeDescription
enterdatetimeThe date/time stamp for when the Asset first began interacting with the Place.
kindAssetPlaceStatusTypeThe kind of interaction.
latestdatetimeThe 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.
ValueDescription
enterOccurs when an asset is outside a Place, then goes inside the boundary.
exitOccurs when an asset was inside the boundary of a Place, but then moves outside the boundary.
insideOccurs 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
PropertyTypeValueDescription
companyuint64The company to which this asset belongs.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
sincedatetimeA timestamp from the moment the object was suspended.
suspendedbooleantrueIndicates whether this Asset is suspended from event processing.
vArray.<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.
ValueDescription
assetGeneric thing.
personHuman (or alien) Person.
trailerA towed vehicle without an engine.
vehicleA vehicle that moves with its own power.

ParamAssetDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetGetBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
includeDispatchbooleanoptionalfalseWhen true, the command will also return the AssetDispatch for the asset.
includeMessagesbooleanoptionalfalseWhen true, the command will also return AssetMessages for the asset.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"includeDispatch": boolean,
	"includeMessages": boolean,
	"reqId": number
}

ParamAssetListByCompanyBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeMessagesbooleanoptionalfalseWhen true, the command will also return AssetMessages for the asset.
includeTasksbooleanoptionalfalseWhen true, the command will also return DispatchTasks for the asset.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"includeMessages": boolean,
	"includeTasks": boolean,
	"reqId": number
}

ParamAssetListByCompanyAndLabelsBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeMessagesbooleanoptionalfalseWhen true, the command will also return AssetMessages for the asset.
includeTasksbooleanoptionalfalseWhen true, the command will also return DispatchTasks for the asset.
labelsArray.<string>optionalA list of label codes used to match Assets. All labels must match to include an Asset in the result.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"includeMessages": boolean,
	"includeTasks": boolean,
	"labels": [
		string
	],
	"reqId": number
}

ParamAssetListByRefBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeMessagesbooleanoptionalfalseWhen true, the command will also return AssetMessages for the asset.
includeTasksbooleanoptionalfalseWhen true, the command will also return DispatchTasks for the asset.
referencestringoptionalCase-insensitive reference used to match Assets.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"includeMessages": boolean,
	"includeTasks": boolean,
	"reference": string,
	"reqId": number
}

ParamAssetListByRefPairsBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeMessagesbooleanoptionalfalseWhen true, the command will also return AssetMessages for the asset.
includeTasksbooleanoptionalfalseWhen true, the command will also return DispatchTasks for the asset.
referencesObject.<string, string>optionalCase-insensitive reference pairs used to match Assets.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"includeMessages": boolean,
	"includeTasks": boolean,
	"references": {
		string: string
	},
	"reqId": number
}

ParamAssetMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetObject.<string, ?>alwaysA simple object to contain the Asset parameters.
asset.attributesObject.<string, AssetAttribute>optionalAllows 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.colourcolour
maximum-length: 22
optionalThe pretty-pretty colour of this Vehicle or Trailer. Only applicable if asset.kind is AssetType.vehicle or AssetType.trailer.
asset.companyuint64?createThe identifier of the Company to which this Asset belongs. After creation, this value is read-only.
asset.contactuint64?create (for person)The contact card details for this Asset. Only applicable if asset.kind is AssetType.person.
asset.engineHoursdouble?optionalThe number of hours the engine has been running for this Vehicle. Only applicable if asset.kind is AssetType.vehicle.
asset.iconuint64?
see: Icon.id
createThe identifier of the Icon used to represent this Asset in the UI.
asset.iduint64?updateThe unique identifier of the Asset you want to update.
asset.kindAssetType?createThe kind of Asset being created. After creation, this value is read-only.
asset.labelsArray.<codified>
for values see: LabelStyle.code
optionalA list of codified label names to categorize/organize this Asset.
asset.makestringoptionalThe manufacturer of this Vehicle or Trailer. Only applicable if asset.kind is AssetType.vehicle or AssetType.trailer.
asset.messagingAddressstringoptionalThe 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.modelstringoptionalThe model of this Vehicle or Trailer. Only applicable if asset.kind is AssetType.vehicle or AssetType.trailer.
asset.namestring
maximum-length: 100
createName for the Asset.
asset.notesstringoptionalNotes for the Asset.
asset.odometerdouble?optionalThe distance travelled by this Asset. Can be a GPS odometer, OBD-II odometer, or other depending on scripts.
asset.picturesArray.<uint64>
for values see: Picture.id
optionalThe identifiers of Pictures of this Asset.
asset.platestringoptionalThe license plate of this Vehicle or Trailer. Only applicable if asset.kind is AssetType.vehicle or AssetType.trailer.
asset.referencesObject.<string, string>optionalName/value collections of custom fields used to refer to external systems. If the value is null, the references are removed from the Asset.
asset.relationshipsArray.<uint64>
for values see: Asset.id
optionalA list of related asset identifiers like a driver for a Vehicle, or Trailer for a truck.
asset.serialstringoptionalThe manufacturer's identification number of this Trailer. Only applicable if asset.kind is AssetType.vehicle.
asset.tagsArray.<string>optionalReplaces the Asset's status tags with the given list of codified tags.
asset.vArray.<int32>optional
asset.vinstringoptionalThe Vehicle Identification Number of this Vehicle. Only applicable if asset.kind is AssetType.trailer.
asset.yearuint16?optionalThe year this Vehicle or Trailer was built. Only applicable if asset.kind is AssetType.vehicle or AssetType.trailer.
reqIdint32?optionalIdentifier 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
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetReviveBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamAssetSuspendBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier 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
PropertyTypeDescription
attributesObject.<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.
companyuint64The company to which this asset belongs.
contactuint64A reference to their Company's Contact information.
dispatchAssetDispatchCurrent jobs dispatched and driving directions.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
messagesArray.<AssetMessage>A list of messages sent to or from this asset.
messagingAddressstring
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.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
odometerdoubleThe cumulative distance travelled in kilometres.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<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.
referencesObject.<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.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<int32>
fixed count: 3
Object version keys used to validate synchronization for all object properties.
v[0]int32The first element is for the AssetGeneral properties.
v[1]int32The second element is for the AssetAdvanced properties.
v[2]int32The 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,
		"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,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"v": [
					number
				]
			}
		],
		"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,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"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
		}
	},
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"v": [
		number
	]
}

PersonGeneralAssetGeneralobject

Seldom changing details about a person.
JSON description
PropertyTypeDescription
companyuint64The company to which this asset belongs.
contactuint64A reference to their Company's Contact information.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
messagingAddressstring
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.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
reference
Deprecated
string
maximum-length: 100
A custom field used to refer to an external system.
Use asset.references[AssetGeneral.REFERENCE] instead.
referencesObject.<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.
vArray.<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
	],
	"reference": string,
	"references": {
		string: string
	},
	"v": [
		number
	]
}

Positionobject

GPS position information
JSON description
PropertyTypeDescription
accuracyuint32?Threshold in meters for the accuracy of a position
addressstringThe road segment description
altitudedouble?Distance in meters from the sea level
bearinguint16?Direction of travel
dtsdatetimeThe Date/Time of the GPS reading
latdouble?Latitude
lngdouble?Longitude
originstringProvider Identifier
speeddouble?Speed
speedLimitdouble?The posted speed limit for the road segment
streetAddressStreetAddressA 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
	}
}

RespAssetDeleteBaseResponseobject

Response description
PropertyTypeDescription
assetRespDeletedAn object which contains the Asset's id, owning Company id, and deleted status.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.deletedbooleanFlag showing if the object is deleted.
asset.iduint64?Identifier given as input for the command.
asset.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
}

RespAssetGetBaseResponseobject

Response description
PropertyTypeDescription
assetAssetThe requested Asset.
asset.attributesObject.<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.companyuint64The company to which this asset belongs.
asset.dispatchAssetDispatchCurrent jobs dispatched and driving directions.
asset.dispatch.companyuint64The company to which this asset belongs.
asset.dispatch.directionsArray.<DispatchDirection>Driving directions and route path details.
asset.dispatch.iduint64Unique identifier of this asset.
asset.dispatch.jobsArray.<uint64>The current list of DispatchJobs assigned to the asset.
asset.dispatch.lastDispatcheddatetimeTimestamp from the last update to this AssetDispatch by a User, Machine, Asset, or an assigned DispatchJob.
asset.dispatch.tasks
Deprecated
Array.<DispatchTask>The current list of tasks assigned to this asset.
asset.dispatch.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
asset.iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
asset.iduint64Unique identifier of this asset.
asset.kindAssetTypeType of asset.
asset.labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
asset.messagesArray.<AssetMessage>A list of messages sent to or from this asset.
asset.messagingAddressstring
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.namestring
maximum-length: 100
This thing's name.
asset.notesstringNotes about it.
asset.odometerdoubleThe cumulative distance travelled in kilometres.
asset.picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
asset.placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
asset.positionPositionThe things GPS coordinates including speed, bearing, and street information.
asset.position.accuracyuint32?Threshold in meters for the accuracy of a position
asset.position.addressstringThe road segment description
asset.position.altitudedouble?Distance in meters from the sea level
asset.position.bearinguint16?Direction of travel
asset.position.dtsdatetimeThe Date/Time of the GPS reading
asset.position.latdouble?Latitude
asset.position.lngdouble?Longitude
asset.position.originstringProvider Identifier
asset.position.speeddouble?Speed
asset.position.speedLimitdouble?The posted speed limit for the road segment
asset.position.streetAddressStreetAddressA better description of the current road-segment
asset.position.streetAddress.citystringCity name.
asset.position.streetAddress.countrystring
fixed length: 2
Country code. Codes should be a value from ISO 3166-1 alpha-2.
asset.position.streetAddress.isTollbooleanIndicates that there is a toll for the current road segment.
asset.position.streetAddress.numberstringHouse number.
asset.position.streetAddress.postalstringPostal or zip code.
asset.position.streetAddress.provincestring
fixed length: 2
Province or state code. Codes should be a value from ISO 3166-2.
asset.position.streetAddress.regionstringRegion name.
asset.position.streetAddress.streetstringFull street name.
asset.providersArray.<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.referencesObject.<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.relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
asset.tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
asset.vArray.<int32>
fixed count: 3
Object version keys used to validate synchronization for all object properties.
asset.v[0]int32The first element is for the AssetGeneral properties.
asset.v[1]int32The second element is for the AssetAdvanced properties.
asset.v[2]int32The third element is for the Asset.dispatch properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"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,
					"reference": string,
					"references": {
						string: string
					},
					"signatory": string,
					"signature": boolean,
					"status": string,
					"v": [
						number
					]
				}
			],
			"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,
				"readBy": string,
				"status": string,
				"subject": string,
				"to": string,
				"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
			}
		},
		"providers": [
			string
		],
		"reference": string,
		"references": {
			string: string
		},
		"relationships": [
			number
		],
		"tags": [
			string
		],
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetListByCompanyBaseResponseobject

Response description
PropertyTypeDescription
assetsArray.<Asset>The list of requested Assets.
companyRespIdAn object to contain the "id" of the Company to which the array of Assets belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
				"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,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"v": [
							number
						]
					}
				],
				"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,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"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
				}
			},
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespAssetListByCompanyAndLabelsBaseResponseobject

Response description
PropertyTypeDescription
assetsArray.<Asset>The list of requested Assets.
companyRespIdAn object to contain the "id" of the Company to which the array of Assets belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
labelsArray.<string>The labels given as input.
messagestringAn English description of the error.
reqIdint32?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,
				"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,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"v": [
							number
						]
					}
				],
				"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,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"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
				}
			},
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"labels": [
		string
	],
	"message": string,
	"reqId": number
}

RespAssetListByRefBaseResponseobject

Response description
PropertyTypeDescription
assetsArray.<Asset>The list of requested Assets.
companyRespIdAn object to contain the "id" of the Company to which the array of Assets belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
referencestringThe reference string given as input.
reqIdint32?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,
				"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,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"v": [
							number
						]
					}
				],
				"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,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"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
				}
			},
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reference": string,
	"reqId": number
}

RespAssetListByRefPairsBaseResponseobject

Response description
PropertyTypeDescription
assetsArray.<Asset>The list of requested Assets.
companyRespIdAn object to contain the "id" of the Company to which the array of Assets belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
referencesObject.<string, string>The reference string given as input.
reqIdint32?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,
				"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,
						"reference": string,
						"references": {
							string: string
						},
						"signatory": string,
						"signature": boolean,
						"status": string,
						"v": [
							number
						]
					}
				],
				"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,
					"readBy": string,
					"status": string,
					"subject": string,
					"to": string,
					"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
				}
			},
			"providers": [
				string
			],
			"reference": string,
			"references": {
				string: string
			},
			"relationships": [
				number
			],
			"tags": [
				string
			],
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"references": {
		string: string
	},
	"reqId": number
}

RespAssetMergeBaseResponseobject

Response description
PropertyTypeDescription
assetRespIdCompanyAn object which contains the "id" and "company" keys.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
assetRespDeletedAn object which contains the Asset's id, owning Company id, and deleted status.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.deletedbooleanFlag showing if the object is deleted.
asset.iduint64?Identifier given as input for the command.
asset.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
assetRespSuspendedAn object which contains the Asset's unique identifier and suspended status.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.iduint64?Identifier given as input for the command.
asset.suspendedbooleanFlag showing if the object is suspended.
asset.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
assetRespSuspendedAn object which contains the Asset's unique identifier and suspended status.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.iduint64?Identifier given as input for the command.
asset.suspendedbooleanFlag showing if the object is suspended.
asset.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
citystringCity name.
countrystring
fixed length: 2
Country code. Codes should be a value from ISO 3166-1 alpha-2.
isTollbooleanIndicates that there is a toll for the current road segment.
numberstringHouse number.
postalstringPostal or zip code.
provincestring
fixed length: 2
Province or state code. Codes should be a value from ISO 3166-2.
regionstringRegion name.
streetstringFull 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
PropertyTypeDescription
attributesObject.<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.
colourcolour
maximum-length: 22
Primary colour of the trailer (given in 24bit hex; #RRGGBB)
companyuint64The company to which this asset belongs.
dispatchAssetDispatchCurrent jobs dispatched and driving directions.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
makestring
maximum-length: 50
Manufacturer's name.
messagesArray.<AssetMessage>A list of messages sent to or from this asset.
messagingAddressstring
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.
modelstring
maximum-length: 50
Manufacturer's model name/number.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
odometerdoubleThe cumulative distance travelled in kilometres.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
platestring
maximum-length: 50
The license plate.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<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.
referencesObject.<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.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
serialstring
maximum-length: 50
Manufacturer's unique identification number for this trailer.
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<int32>
fixed count: 3
Object version keys used to validate synchronization for all object properties.
v[0]int32The first element is for the AssetGeneral properties.
v[1]int32The second element is for the AssetAdvanced properties.
v[2]int32The third element is for the Asset.dispatch properties.
yearuint16Year 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,
		"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,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"v": [
					number
				]
			}
		],
		"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,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"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
		}
	},
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"serial": string,
	"tags": [
		string
	],
	"v": [
		number
	],
	"year": number
}

TrailerGeneralAssetGeneralobject

Seldom changing details about a trailer.
JSON description
PropertyTypeDescription
colourcolour
maximum-length: 22
Primary colour of the trailer (given in 24bit hex; #RRGGBB)
companyuint64The company to which this asset belongs.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
makestring
maximum-length: 50
Manufacturer's name.
messagingAddressstring
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.
modelstring
maximum-length: 50
Manufacturer's model name/number.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
platestring
maximum-length: 50
The license plate.
reference
Deprecated
string
maximum-length: 100
A custom field used to refer to an external system.
Use asset.references[AssetGeneral.REFERENCE] instead.
referencesObject.<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.
serialstring
maximum-length: 50
Manufacturer's unique identification number for this trailer.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
yearuint16Year 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,
	"reference": string,
	"references": {
		string: string
	},
	"serial": string,
	"v": [
		number
	],
	"year": number
}

VehicleAssetobject

The full details of a Vehicle, containing all the properties from the VehicleGeneral and VehicleAdvanced objects.
JSON description
PropertyTypeDescription
attributesObject.<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.
colourcolour
maximum-length: 22
Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
companyuint64The company to which this asset belongs.
dispatchAssetDispatchCurrent jobs dispatched and driving directions.
engineHoursdoubleThe cumulative duration that the vehicle's engine has been running (in decimal hours).
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
makestring
maximum-length: 50
Manufacturer's name.
messagesArray.<AssetMessage>A list of messages sent to or from this asset.
messagingAddressstring
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.
modelstring
maximum-length: 50
Manufacturer's model name/number.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
odometerdoubleThe cumulative distance travelled in kilometres.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
platestring
maximum-length: 50
The license plate.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<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.
referencesObject.<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.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<int32>
fixed count: 3
Object version keys used to validate synchronization for all object properties.
v[0]int32The first element is for the AssetGeneral properties.
v[1]int32The second element is for the AssetAdvanced properties.
v[2]int32The third element is for the Asset.dispatch properties.
vinstring
maximum-length: 50
Manufacturer's unique identification number (Vehicle Identification Number).
yearuint16Year 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,
		"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,
				"reference": string,
				"references": {
					string: string
				},
				"signatory": string,
				"signature": boolean,
				"status": string,
				"v": [
					number
				]
			}
		],
		"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,
			"readBy": string,
			"status": string,
			"subject": string,
			"to": string,
			"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
		}
	},
	"providers": [
		string
	],
	"reference": string,
	"references": {
		string: string
	},
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"v": [
		number
	],
	"vin": string,
	"year": number
}

VehicleAdvancedAssetAdvancedobject

Often changing details about a vehicle.
JSON description
PropertyTypeDescription
attributesObject.<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.
companyuint64The company to which this asset belongs.
engineHoursdoubleThe cumulative duration that the vehicle's engine has been running (in decimal hours).
iduint64Unique identifier of this asset.
odometerdoubleThe cumulative distance travelled in kilometres.
placesObject.<uint64, AssetPlaceStatus>
for keys see: Place.id
The current state of this asset's interaction with known Places.
positionPositionThe things GPS coordinates including speed, bearing, and street information.
providersArray.<string>
for values see: Provider.id
The list of devices providing events for this asset.
relationshipsArray.<uint64>
for values see: Asset.id
A list of assets related to this one; like a Person for a Vehicle (driver).
tagsArray.<codified>
for values see: LabelStyle.code
The codified status tag names.
vArray.<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
		}
	},
	"providers": [
		string
	],
	"relationships": [
		number
	],
	"tags": [
		string
	],
	"v": [
		number
	]
}

VehicleGeneralAssetGeneralobject

Seldom changing details about a vehicle.
JSON description
PropertyTypeDescription
colourcolour
maximum-length: 22
Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
companyuint64The company to which this asset belongs.
iconuint64
see: Icon.id
The icon that represents this asset on the map and in lists.
iduint64Unique identifier of this asset.
kindAssetTypeType of asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
makestring
maximum-length: 50
Manufacturer's name.
messagingAddressstring
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.
modelstring
maximum-length: 50
Manufacturer's model name/number.
namestring
maximum-length: 100
This thing's name.
notesstringNotes about it.
picturesArray.<uint64>
for values see: Picture.id
A list of photos of this thing.
platestring
maximum-length: 50
The license plate.
reference
Deprecated
string
maximum-length: 100
A custom field used to refer to an external system.
Use asset.references[AssetGeneral.REFERENCE] instead.
referencesObject.<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.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
vinstring
maximum-length: 50
Manufacturer's unique identification number (Vehicle Identification Number).
yearuint16Year 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,
	"reference": string,
	"references": {
		string: string
	},
	"v": [
		number
	],
	"vin": string,
	"year": number
}

Behaviours

Behaviourobject

The applied behaviour which includes all parameters and targets specific assets.
JSON description
PropertyTypeDescription
companyuint64The company to which this behaviour belongs.
filtersexpressionA search pattern used to filter the providers which can implement this behaviour.
iduint64Unique identifier of this behaviour.
namestring
maximum-length: 100
The name of this behaviour.
notesstringNotes.
parametersObject.<string, BehaviourParameter>The list of defined variable name/value pairs for the script requires.
prioritybyteThe priority flag allows you to define an execution order for all behaviours for a provider.
scriptuint64The script which this behaviour implements.
targetsexpressionThe search pattern used to target the assets which will embed this behaviour in their execution context.
vArray.<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,
	"script": number,
	"targets": string,
	"v": [
		number
	]
}

BehaviourDeletedobject

The message format for when a deleted Behaviour is retrieved
JSON description
PropertyTypeValueDescription
companyuint64The company to which this behaviour belongs.
deletedbooleantrue
iduint64Unique identifier of this behaviour.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

BehaviourLogobject

A debug message available to script writers to help debug and trace output from a BehaviourScript.
JSON description
PropertyTypeDescription
assetuint64The asset which whose behaviours created this log entry.
behaviouruint64?The behaviour to which this log message belongs.
characteruint32?The character column where the error was generated.
companyuint64The company to which this log message belongs.
dtsdatetimeWhen the log entry was generated by the script.
iduint64Unique identifier of this log message.
kindBehaviourLogTypeThe category of message.
lineuint32The line number of the script which generated this message.
messagestringThe body of the message.
scriptuint64The script which generated this log message.
vArray.<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,
	"script": number,
	"v": [
		number
	]
}

BehaviourLogDeletedobject

The message format for when a deleted BehaviourLog is retrieved
JSON description
PropertyTypeValueDescription
assetuint64The asset which whose behaviours created this log entry.
companyuint64The company to which this log message belongs.
deletedbooleantrue
iduint64Unique identifier of this log message.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"asset": number,
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

BehaviourLogTypestring

The type of logged message.
ValueDescription
errUsed for errors.
infoUsed for more important messages.
logUsed for general information messages.
warnUsed for warnings.

BehaviourParameterobject

Definition of an argument passed to a Behaviour Script.
JSON description
PropertyTypeDescription
contextstringGives 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.
notesstringUsage notes.
typeBehaviourParameterTypeSimple type information for the compiler.
valuestringThe 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.
ValueDescription
booleanTrue or false.
jsonObject or array literal.
numberNumeric value (signed double-precision floating point number).
stringText.

BehaviourScriptobject

Business logic run by the system to react to GPS events and device information.
JSON description
PropertyTypeDescription
companyuint64The company to which this script belongs.
compilesbooleanFlag set by the compiler if this code compiles
fillcolour
maximum-length: 22
The background colour given to this script for easy visual identification.
filtersexpressionA list of targeting expressions. These expressions are defaults for derived Behaviours.
globalbooleanIndicates whether this script is available to child companies.
graphiccodified
maximum-length: 22
The codified graphic name given to this script for easy visual identification.
iduint64Unique identifier of this script.
namestring
maximum-length: 100
The nickname given to this script.
notesstringUsage notes and instructions for users on how best to setup this script.
parametersObject.<string, BehaviourParameter>Listed parameters for the Behaviour function.
sourcestring
maximum-length: 8060
The source code.
strokecolour
maximum-length: 22
The text/graphic colour given to this script for easy visual identification.
vArray.<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
		}
	},
	"source": string,
	"stroke": string,
	"v": [
		number
	]
}

BehaviourScriptDeletedobject

The message format for when a deleted BehaviourScript is retrieved
JSON description
PropertyTypeValueDescription
companyuint64The company to which this script belongs.
deletedbooleantrue
iduint64Unique identifier of this script.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

ParamBehaviourDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourParamIdalwaysAn object to contain the "id" key.
behaviour.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourParamIdalwaysAn object to contain the "id" key.
behaviour.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourListByCompanyBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourListByScriptBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" of the Company.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogClearByAssetBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogClearByBehaviourBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourParamIdalwaysAn object to contain the "id" of the Behaviour.
behaviour.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogClearByScriptBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" of the BehaviourScript.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogListByAssetBaseParametersobject

Request description
PropertyTypeRequiredDescription
assetParamIdalwaysAn object to contain the "id" of the Asset.
asset.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"asset": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogListByBehaviourBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourParamIdalwaysAn object to contain the "id" of the Behaviour.
behaviour.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourLogListByScriptBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" of the BehaviourScript.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourObject.<string, ?>alwaysA simple object to contain the Behaviour parameters.
behaviour.companyuint64?create
behaviour.filtersexpressionoptionalA search pattern used to select the assets which will embed this Behaviour in their execution context.
behaviour.iduint64?updateThe unique identifier of the Behaviour you want to update.
behaviour.namestring
maximum-length: 100
createName for the Behaviour.
behaviour.notesstringoptionalNotes for the Behaviour.
behaviour.parametersObject.<string, BehaviourParameter>optionalThe values needed to implement the script. Each key in this object is the name of a required script argument.
behaviour.prioritybyte?optionalThe order in which this Behaviour is executed.
behaviour.scriptuint64?createIdentifier of the BehaviourScript to which this Behaviour belongs. After creation, this value is read-only.
behaviour.targetsexpressionoptionalA search pattern used to select the providers which can implement this Behaviour.
behaviour.vArray.<int32>optional
reqIdint32?optionalIdentifier 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
PropertyTypeRequiredDescription
behaviourParamIdalwaysAn object to contain the "id" key.
behaviour.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviour": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourScriptDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" key.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourScriptGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" key.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

ParamBehaviourScriptListByCompanyBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
treebooleanoptionalWhen 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
	},
	"reqId": number,
	"tree": boolean
}

ParamBehaviourScriptMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
behaviourScriptObject.<string, ?>alwaysA simple object to contain the BehaviourScript parameters.
behaviourScript.companyuint64?createIdentifier of the Company to which this BehaviourScript belongs. After creation, this value is read-only.
behaviourScript.fillstringoptionalBackground and fill colour in the UI.
behaviourScript.filtersexpressionoptionalA search pattern used to select the providers.
behaviourScript.globalbooleanoptionalWhen set to true, this Company as well as all child companies will be able to implement this BehaviourScript for that companies assets.
behaviourScript.graphicstringoptionalThe name of the symbol shown in the UI.
behaviourScript.iduint64?updateThe unique identifier of the BehaviourScript you want to update.
behaviourScript.namestring
maximum-length: 100
createName for the BehaviourScript.
behaviourScript.notesstringoptionalNotes for the BehaviourScript.
behaviourScript.parametersObject.<string, BehaviourParameter>optionalThe defined arguments for this BehaviourScript. Each key in the object is the name of an argument.
behaviourScript.sourcestringcreateSource code of the BehaviourScript.
behaviourScript.strokestringoptionalText and outline colour in the UI.
behaviourScript.vArray.<int32>optional
reqIdint32?optionalIdentifier 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
PropertyTypeRequiredDescription
behaviourScriptParamIdalwaysAn object to contain the "id" key.
behaviourScript.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"behaviourScript": {
		"id": number
	},
	"reqId": number
}

RespBehaviourDeleteBaseResponseobject

Response description
PropertyTypeDescription
behaviourRespDeletedAn object which contains the Behaviour's id, owning Company id, and deleted status.
behaviour.companyuint64Identifier of the Company to which this object belongs.
behaviour.deletedbooleanFlag showing if the object is deleted.
behaviour.iduint64?Identifier given as input for the command.
behaviour.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourBehaviourThe requested Behaviour.
behaviour.companyuint64The company to which this behaviour belongs.
behaviour.filtersexpressionA search pattern used to filter the providers which can implement this behaviour.
behaviour.iduint64Unique identifier of this behaviour.
behaviour.namestring
maximum-length: 100
The name of this behaviour.
behaviour.notesstringNotes.
behaviour.parametersObject.<string, BehaviourParameter>The list of defined variable name/value pairs for the script requires.
behaviour.prioritybyteThe priority flag allows you to define an execution order for all behaviours for a provider.
behaviour.scriptuint64The script which this behaviour implements.
behaviour.targetsexpressionThe search pattern used to target the assets which will embed this behaviour in their execution context.
behaviour.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
		"script": number,
		"targets": string,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourListByCompanyBaseResponseobject

Response description
PropertyTypeDescription
behavioursArray.<Behaviour>The list of reqested Behaviours.
companyRespIdAn object to contain the "id" of the Company to which the array of Behaviours belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"script": number,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourListByScriptBaseResponseobject

Response description
PropertyTypeDescription
behavioursArray.<Behaviour>The list of reqested Behaviours.
behaviourScriptRespIdCompanyAn object to contain the "id" of the Company to which the array of Behaviours belong.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"script": number,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogClearByAssetBaseResponseobject

Response description
PropertyTypeDescription
assetRespIdCompanyAn object to contain the "id" of the Asset to which the array of BehaviourLogs relates.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.iduint64?Identifier given as input for the command.
countint32The total number of behaviour logs cleared.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourRespIdScriptAn object to contain the "id" of the Behaviour to which the array of BehaviourLogs belong.
behaviour.companyuint64Identifier of the Company to which this object belongs.
behaviour.iduint64?Identifier given as input for the command.
behaviour.scriptuint64Identifier of the script to which this object belongs.
countint32The total number of behaviour logs cleared.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourScriptRespIdCompanyAn object to contain the "id" of the BehaviourScript to which the array of BehaviourLogs belong.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.iduint64?Identifier given as input for the command.
countint32The total number of behaviour logs cleared.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
assetRespIdCompanyAn object to contain the "id" of the Asset to which the array of BehaviourLogs relates.
asset.companyuint64Identifier of the Company to which this object belongs.
asset.iduint64?Identifier given as input for the command.
behaviourLogsArray.<BehaviourLog>The list of requested BehaviourLogs.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"script": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogListByBehaviourBaseResponseobject

Response description
PropertyTypeDescription
behaviourRespIdScriptAn object to contain the "id" of the Behaviour to which the array of BehaviourLogs belong.
behaviour.companyuint64Identifier of the Company to which this object belongs.
behaviour.iduint64?Identifier given as input for the command.
behaviour.scriptuint64Identifier of the script to which this object belongs.
behaviourLogsArray.<BehaviourLog>The list of requested BehaviourLogs.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"script": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourLogListByScriptBaseResponseobject

Response description
PropertyTypeDescription
behaviourLogsArray.<BehaviourLog>The list of requested BehaviourLogs.
behaviourScriptRespIdCompanyAn object to contain the "id" of the BehaviourScript to which the array of BehaviourLogs belong.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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,
			"script": number,
			"v": [
				number
			]
		}
	],
	"behaviourScript": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourMergeBaseResponseobject

Response description
PropertyTypeDescription
behaviourRespIdScriptAn object which contains the "id", "company", and "script" keys when there is no error.
behaviour.companyuint64Identifier of the Company to which this object belongs.
behaviour.iduint64?Identifier given as input for the command.
behaviour.scriptuint64Identifier of the script to which this object belongs.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourRespDeletedAn object which contains the Behaviour's id, owning Company id, and deleted status.
behaviour.companyuint64Identifier of the Company to which this object belongs.
behaviour.deletedbooleanFlag showing if the object is deleted.
behaviour.iduint64?Identifier given as input for the command.
behaviour.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
}

RespBehaviourScriptDeleteBaseResponseobject

Response description
PropertyTypeDescription
behaviourScriptRespDeletedAn object which contains the BehaviourScript's id, owning Company id, and deleted status.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.deletedbooleanFlag showing if the object is deleted.
behaviourScript.iduint64?Identifier given as input for the command.
behaviourScript.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourScriptBehaviourScriptThe requested BehaviourScript.
behaviourScript.companyuint64The company to which this script belongs.
behaviourScript.compilesbooleanFlag set by the compiler if this code compiles
behaviourScript.fillcolour
maximum-length: 22
The background colour given to this script for easy visual identification.
behaviourScript.filtersexpressionA list of targeting expressions. These expressions are defaults for derived Behaviours.
behaviourScript.globalbooleanIndicates whether this script is available to child companies.
behaviourScript.graphiccodified
maximum-length: 22
The codified graphic name given to this script for easy visual identification.
behaviourScript.iduint64Unique identifier of this script.
behaviourScript.namestring
maximum-length: 100
The nickname given to this script.
behaviourScript.notesstringUsage notes and instructions for users on how best to setup this script.
behaviourScript.parametersObject.<string, BehaviourParameter>Listed parameters for the Behaviour function.
behaviourScript.sourcestring
maximum-length: 8060
The source code.
behaviourScript.strokecolour
maximum-length: 22
The text/graphic colour given to this script for easy visual identification.
behaviourScript.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
			}
		},
		"source": string,
		"stroke": string,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptListByCompanyBaseResponseobject

Response description
PropertyTypeDescription
behaviourScriptsArray.<BehaviourScript>The list of requested BehaviourScripts.
companyRespIdAn object to contain the "id" of the Company to which the array of BehaviourScripts belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
				}
			},
			"source": string,
			"stroke": string,
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBehaviourScriptMergeBaseResponseobject

Response description
PropertyTypeDescription
behaviourScriptRespIdCompanyAn object which contains the "id" and "company" keys when there is no error.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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
PropertyTypeDescription
behaviourScriptRespDeletedAn object which contains the BehaviourScript's id, owning Company id, and deleted status.
behaviourScript.companyuint64Identifier of the Company to which this object belongs.
behaviourScript.deletedbooleanFlag showing if the object is deleted.
behaviourScript.iduint64?Identifier given as input for the command.
behaviourScript.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?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

BillableHostingDiscountobject

A discount rule for assets
JSON description
PropertyTypeDescription
amountdoubleCost per cycle for this plan
companyuint64Unique identifier of the Company that owns this hosting rule.
enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
iduint64Unique identifier of this hosting rule.
limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
namestring
maximum-length: 254
The name of this billing rule.
notesstringNotes about billing this rule.
percentagebooleanWhen true, the amount is used as a percentage value instead of a currency values.
profileuint64Unique identifier of this rule's billing profile.
referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
servicesArray.<BillableHostingType>The type of services being discounted.
startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
suspendedbooleanDoes this hosting rule apply to suspended resources
targetsexpressionWhich assets are targetted by this hosting rule
vArray.<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,
	"percentage": boolean,
	"profile": number,
	"reference": string,
	"services": [
		string
	],
	"start": string,
	"suspended": boolean,
	"targets": string,
	"v": [
		number
	]
}

BillableHostingDiscountDeletedobject

The message format for when a deleted BillableHostingDiscount is retrieved
JSON description
PropertyTypeValueDescription
companyuint64Unique identifier of the Company that owns this hosting rule.
deletedbooleantrue
iduint64Unique identifier of this hosting rule.
profileuint64Unique identifier of this rule's billing profile.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillableHostingLicenseobject

A hardware license for providers
JSON description
PropertyTypeDescription
amountdoubleCost per cycle for this plan
companyuint64Unique identifier of the Company that owns this hosting rule.
enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
iduint64Unique identifier of this hosting rule.
kindBillableLicenseTypeThe type of hardware license
limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
namestring
maximum-length: 254
The name of this billing rule.
notesstringNotes about billing this rule.
profileuint64Unique identifier of this rule's billing profile.
referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
suspendedbooleanDoes this hosting rule apply to suspended resources
targetsexpressionWhich assets are targetted by this hosting rule
vArray.<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,
	"profile": number,
	"reference": string,
	"start": string,
	"suspended": boolean,
	"targets": string,
	"v": [
		number
	]
}

BillableHostingLicenseDeletedobject

The message format for when a deleted BillableHostingLicense is retrieved
JSON description
PropertyTypeValueDescription
companyuint64Unique identifier of the Company that owns this hosting rule.
deletedbooleantrue
iduint64Unique identifier of this hosting rule.
profileuint64Unique identifier of this rule's billing profile.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillableHostingRuleobject

A billing rule for assets
JSON description
PropertyTypeDescription
amountdoubleCost per cycle for this plan
companyuint64Unique identifier of the Company that owns this hosting rule.
enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
iduint64Unique identifier of this hosting rule.
limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
namestring
maximum-length: 254
The name of this billing rule.
notesstringNotes about billing this rule.
profileuint64Unique identifier of this rule's billing profile.
referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
serviceBillableHostingTypeThe type of service being billed.
startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
suspendedbooleanDoes this hosting rule apply to suspended resources
targetsexpressionWhich assets are targetted by this hosting rule
vArray.<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,
	"profile": number,
	"reference": string,
	"service": string,
	"start": string,
	"suspended": boolean,
	"targets": string,
	"v": [
		number
	]
}

BillableHostingRuleDeletedobject

The message format for when a deleted BillableHostingRule is retrieved
JSON description
PropertyTypeValueDescription
companyuint64Unique identifier of the Company that owns this hosting rule.
deletedbooleantrue
iduint64Unique identifier of this hosting rule.
profileuint64Unique identifier of this rule's billing profile.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillableHostingTypestring

The kind of service being billed.
ValueDescription
assetGeneric dot-on-a-map tracking
dispatchTasks assignable to vehicles or persons
elogsFMCSA compliant E-Logs and Hours of Service
mobileEmployee/driver tracking
vehicleVehicle tracking (includes VBus data, and engine hours)

BillableLicenseTypestring

The kind of license being billed.
ValueDescription
bewhereBeWhere license fee
calampCalAmp PULS fee
smartwitnessSmartWitness data hosting fee

BillableSmsProfileobject

Description of a tiered SMS messaging limit
JSON description
PropertyTypeDescription
amountdoubleCost per SMS message sent. Received messages are free.
limituint32The maximum number of messages sent per cycle
JSON structure
{
	"amount": number,
	"limit": number
}

BillingCurrencystring

Used for invoices.
ValueDescription
CADCanadian dollars
EUROEurozone currency
USDAmerican dollars

BillingCyclestring

The type of repeating cycle used for generating bills.
ValueDescription
annuallyOnce per year
monthlyOnce a month
quarterlyEvery three months

BillingProfileobject

A profile used to generate billable orders for a customer.
JSON description
PropertyTypeDescription
billeeuint64Unique identifier of the Company receiving the bill. Most of the time, this value is the same as the target.
companyuint64Unique identifier of the Company that owns this profile and is sending the bill.
currencyBillingCurrencykind of money
cycleBillingCycleRepeating cycle used for generating bills
cycleEnddatetimeWhen should the cycle end (customer cancelled)
cyclePostDatedbooleanPro-rated, or post-dated.
cycleStartdatetimeWhen is the first day of the billing cycle
googleServicesEnabledbooleanAre the Google services available to be proxied by the service?
iduint64Unique identifier of this billing profile
messagesArray.<BillableSmsProfile>SMS messaging tiers
namestring
maximum-length: 254
The name for this profile
notesstring
maximum-length: 1000
Notes about the billing profile for the billee or target.
targetuint64Unique identifier of the Company to which this rule pertains.
vArray.<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,
	"target": number,
	"v": [
		number
	]
}

BillingProfileDeletedobject

The message format for when a deleted BillingProfile is retrieved
JSON description
PropertyTypeValueDescription
companyuint64Unique identifier of the Company that owns this profile and is sending the bill.
deletedbooleantrue
iduint64Unique identifier of this billing profile
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"since": string,
	"v": [
		number
	]
}

BillingReportobject

Report generated per billee company.
JSON description
PropertyTypeDescription
billeeuint64Unique identifier of the Company receiving the bill.
companyuint64The company to which this report belongs and is sending the bill.
currencyBillingCurrencyCurrency being billed in
endDatedatetimeLast day of the billing cycle
errorstring
maximum-length: 250
A field which contains report error details if the BillingReport.status is BillingReportStatus.failed.
hostingBreakdownObject.<uint64, Array.<BillingReportHostingBreakdown>>
for keys see: Asset.id
Individual amounts per targeted assets used to calculate the results of the report.
iduint64Unique identifier
namestring
maximum-length: 100
Name of this report.
notesstringNotes about this report.
profileuint64The profile to which this report belongs
startDatedatetimeFirst day of the billing cycle
statusBillingReportStatusThe processing status of this report.
summaryArray.<BillingReportSummary>Summary contains totals per target for this billee
totaldoubleTotal amount being billed.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"billee": number,
	"company": number,
	"currency": string,
	"endDate": string,
	"error": string,
	"hostingBreakdown": {
		string: [
			{
				"asset": number,
				"billableDays": number,
				"cost": number,
				"created": string,
				"deleted": string,
				"discount": number,
				"labels": [
					string
				],
				"name": string,
				"notes": string,
				"phoneNumbers": [
					number
				],
				"providers": [
					string
				],
				"suspended": string,
				"suspendedCost": number,
				"suspendedDays": number,
				"suspendedDiscount": number,
				"total": number,
				"updatedDts": string
			}
		]
	},
	"id": number,
	"name": string,
	"notes": string,
	"profile": number,
	"startDate": string,
	"status": string,
	"summary": [
		{
			"hostingSummary": [
				{
					"count": number,
					"kind": string,
					"total": number
				}
			],
			"name": string,
			"notes": string,
			"parent": number,
			"target": number
		}
	],
	"total": number,
	"v": [
		number
	]
}

BillingReportDeletedobject

The message format for when a deleted BillingReport is retrieved
JSON description
PropertyTypeValueDescription
companyuint64The company to which this report belongs and is sending the bill.
deletedbooleantrueIndicates whether this report is deleted.
iduint64Unique identifier
profileuint64The profile to which this report belongs
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"company": number,
	"deleted": boolean,
	"id": number,
	"profile": number,
	"since": string,
	"v": [
		number
	]
}

BillingReportHostingBreakdownobject

Full breakdown of billable details per targeted asset.
JSON description
PropertyTypeDescription
assetuint64The asset to which this breakdown instance belongs.
billableDaysdoubleNumber of days this Asset is being billed for.
costdoubleCost per billing cycle for this asset.
createddatetimeIndicates when this Asset was created.
deleteddatetimeIndicates when this Asset was deleted.
discountdoubleDiscount applied per billing cycle for this asset.
labelsArray.<codified>
for values see: LabelStyle.code
Codified label names.
namestring
maximum-length: 100
Asset's name.
notesstringNotes about the asset.
phoneNumbersArray.<phone>The list of phone numbers for this asset.
providersArray.<string>The list of devices providing events for this asset.
suspendeddatetimeIndicates when this Asset wass suspended from event processing.
suspendedCostdoubleCost per billing cycle for suspended asset.
suspendedDaysdoubleNumber of days this Asset was suspended.
suspendedDiscountdoubleDiscount applied per billing cycle for suspended asset.
totaldoubleTotal amount being billed for this asset.
updatedDtsdatetimeIndicates when this Asset was last updated.
JSON structure
{
	"asset": number,
	"billableDays": number,
	"cost": number,
	"created": string,
	"deleted": string,
	"discount": number,
	"labels": [
		string
	],
	"name": string,
	"notes": string,
	"phoneNumbers": [
		number
	],
	"providers": [
		string
	],
	"suspended": string,
	"suspendedCost": number,
	"suspendedDays": number,
	"suspendedDiscount": number,
	"total": number,
	"updatedDts": string
}

BillingReportHostingSummaryobject

Summarized bill per targeted asset.
JSON description
PropertyTypeDescription
countdoubleNumber of items for this service.
kindBillableHostingTypeService being billed
totaldoubleTotal amount being billed for this service.
JSON structure
{
	"count": number,
	"kind": string,
	"total": number
}

BillingReportStatusstring

The lifetime of building a BillingReport.
ValueDescription
completedThe BillingReport is available for retrieval.
createdThe BillingReport has been requested, but not yet begun processing.
failedThere was an error processing the BillingReport; see the BillingReport.error for a description.
queuedThe BillingReport is waiting for required resources to begin processing.
runningThe BillingReport is currently being processed.

BillingReportSummaryobject

Summarized bill per target.
JSON description
PropertyTypeDescription
hostingSummaryArray.<BillingReportHostingSummary>Summary contains totals per type of hosting for this target
namestring
maximum-length: 100
Target's name.
notesstringNotes about the target.
parentuint64The target company's parent.
targetuint64The target company to which this summary instance belongs.
JSON structure
{
	"hostingSummary": [
		{
			"count": number,
			"kind": string,
			"total": number
		}
	],
	"name": string,
	"notes": string,
	"parent": number,
	"target": number
}

ParamBillingProfileDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingProfileGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingProfileListByCompanyBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamBillingProfileMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileObject.<string, ?>alwaysA simple object to contain the BillingProfile parameters.
billingProfile.billeeuint64?optionalUnique identifier of the Company receiving the bill.
billingProfile.companyuint64?optionalUnique identifier of the Company that owns this BillingProfile and is sending the bill.
billingProfile.currencyBillingCurrency?optionalKind of money.
billingProfile.cycleBillingCycle?optionalRepeating cycle used for generating bills.
billingProfile.cycleEnddatetimeoptionalWhen should the cycle end (customer cancelled); null means it never ends.
billingProfile.cyclePostDatedbooleanoptionalPro-rated, or post-dated.
billingProfile.cycleStartdatetimeoptionalWhen is the first day of the billing cycle.
billingProfile.googleServicesEnabledbooleanoptionalAre the Google services available to be proxied by the service?
billingProfile.iduint64?optionalUnique identifier of the BillingProfile you want to update.
billingProfile.messagesArray.<BillableSmsProfile>optionalSMS messaging tiers.
billingProfile.namestringoptionalName for the BillingProfile
billingProfile.notesstringoptionalNotes about the BillingProfile for the billee or target.
billingProfile.targetuint64?optionalUnique identifier of the Company to which this rule pertains.
billingProfile.vArray.<int32>optional
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"billee": number,
		"company": number,
		"currency": string,
		"cycle": string,
		"cycleEnd": string,
		"cyclePostDated": boolean,
		"cycleStart": string,
		"googleServicesEnabled": boolean,
		"id": number,
		"messages": [
			{
				"amount": number,
				"limit": number
			}
		],
		"name": string,
		"notes": string,
		"target": number,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamBillingProfileRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingReportParamIdalwaysAn object to contain the "id" of the BillingReport.
billingReport.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingReport": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingReportParamIdalwaysAn object to contain the "id" of the BillingReport.
billingReport.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingReport": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportListByBillingProfileBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportListByCompanyBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamBillingReportRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingReportParamIdalwaysAn object to contain the "id" of the BillingReport.
billingReport.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingReport": {
		"id": number
	},
	"reqId": number
}

ParamHostingDiscountDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingDiscountParamIdalwaysAn object to contain the "id" of the BillableHostingDiscount.
hostingDiscount.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingDiscount": {
		"id": number
	},
	"reqId": number
}

ParamHostingDiscountGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingDiscountParamIdalwaysAn object to contain the "id" of the BillableHostingDiscount.
hostingDiscount.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingDiscount": {
		"id": number
	},
	"reqId": number
}

ParamHostingDiscountListByBillingProfileBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamHostingDiscountMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingDiscountObject.<string, ?>alwaysA simple object to contain the BillableHostingDiscount parameters.
hostingDiscount.amountdouble?optionalCost per cycle for this plan
hostingDiscount.enddatetimecreateDate this billing discount is applied until; null means it never ends.
hostingDiscount.iduint64?updateUnique identifier of the BillableHostingDiscount you want to update.
hostingDiscount.limituint32?optionalThe number of units to which this billing discount applies. Should be a non-zero value; null means unlimited.
hostingDiscount.namestringcreateName for the BillableHostingDiscount
hostingDiscount.notesstringoptionalNotes about the BillableHostingDiscount.
hostingDiscount.percentagebooleanoptionalWhen true, the amount is used as a percentage value instead of a currency values.
hostingDiscount.profileuint64?createUnique identifier of this discount's billing BillingProfile.
hostingDiscount.referencestringoptionalA custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingDiscount.servicesArray.<BillableHostingType>createThe types of service being discounted.
hostingDiscount.startdatetimecreateDate this billing discount takes effect.
hostingDiscount.suspendedbooleanoptionalDoes this BillableHostingDiscount apply to suspended resources.
hostingDiscount.targetsexpressionoptionalWhich assets are targetted by this BillableHostingDiscount.
hostingDiscount.vArray.<int32>optional
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingDiscount": {
		"amount": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"percentage": boolean,
		"profile": number,
		"reference": string,
		"services": [
			string
		],
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamHostingDiscountRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingDiscountParamIdalwaysAn object to contain the "id" of the BillableHostingDiscount.
hostingDiscount.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingDiscount": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingLicenseParamIdalwaysAn object to contain the "id" of the BillableHostingLicense.
hostingLicense.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingLicense": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingLicenseParamIdalwaysAn object to contain the "id" of the BillableHostingLicense.
hostingLicense.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingLicense": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseListByBillingProfileBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamHostingLicenseMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingLicenseObject.<string, ?>alwaysA simple object to contain the BillableHostingLicense parameters.
hostingLicense.amountdouble?optionalCost per cycle for this plan
hostingLicense.enddatetimeoptionalDate this BillableHostingLicense is applied until; null means it never ends.
hostingLicense.iduint64?updateUnique identifier of the BillableHostingLicense you want to update.
hostingLicense.kindBillableLicenseType?createThe type of hardware BillableLicenseType.
hostingLicense.limituint32?optionalThe number of units to which this BillableHostingLicense applies. Should be a non-zero value; null means unlimited
hostingLicense.namestringcreateName for the BillableHostingLicense
hostingLicense.notesstringoptionalNotes about the BillableHostingLicense.
hostingLicense.profileuint64?createUnique identifier of this BillableHostingLicense's BillingProfile.
hostingLicense.referencestringoptionalA custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingLicense.startdatetimeoptionalDate this BillableHostingLicense takes effect.
hostingLicense.suspendedbooleanoptionalDoes this BillableHostingLicense apply to suspended resources
hostingLicense.targetsexpressionoptionalWhich assets are targetted by this BillableHostingLicense
hostingLicense.vArray.<int32>optional
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingLicense": {
		"amount": number,
		"end": string,
		"id": number,
		"kind": string,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamHostingLicenseRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingLicenseParamIdalwaysAn object to contain the "id" of the BillableHostingLicense.
hostingLicense.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingLicense": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingRuleParamIdalwaysAn object to contain the "id" of the BillableHostingRule.
hostingRule.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingRule": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingRuleParamIdalwaysAn object to contain the "id" of the BillableHostingRule.
hostingRule.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingRule": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleListByBillingProfileBaseParametersobject

Request description
PropertyTypeRequiredDescription
billingProfileParamIdalwaysAn object to contain the "id" of the BillingProfile.
billingProfile.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"billingProfile": {
		"id": number
	},
	"reqId": number
}

ParamHostingRuleMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingRuleObject.<string, ?>alwaysA simple object to contain the BillableHostingRule parameters.
hostingRule.amountdouble?optionalCost per cycle for this plan
hostingRule.enddatetimecreateDate this BillableHostingRule is applied until; null means it never ends.
hostingRule.iduint64?updateUnique identifier of the BillableHostingRule you want to update.
hostingRule.limituint32?optionalThe number of units to which this BillableHostingRule applies. Should be a non-zero value; null means unlimited
hostingRule.namestringcreateName for the BillableHostingRule
hostingRule.notesstringoptionalNotes about the BillableHostingRule.
hostingRule.profileuint64?createUnique identifier of this BillableHostingRule's BillingProfile.
hostingRule.referencestringoptionalA custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingRule.serviceBillableHostingType?createThe type of service being billed.
hostingRule.startdatetimecreateDate this BillableHostingRule takes effect.
hostingRule.suspendedbooleanoptionalDoes this BillableHostingRule apply to suspended resources
hostingRule.targetsexpressionoptionalWhich assets are targetted by this BillableHostingRule
hostingRule.vArray.<int32>optional
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingRule": {
		"amount": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"service": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"reqId": number
}

ParamHostingRuleRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
hostingRuleParamIdalwaysAn object to contain the "id" of the BillableHostingRule.
hostingRule.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"hostingRule": {
		"id": number
	},
	"reqId": number
}

RespBillingProfileDeleteBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespDeletedAn object which contains the BillingProfile's unique identifier and deleted status.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.deletedbooleanFlag showing if the object is deleted.
billingProfile.iduint64?Identifier given as input for the command.
billingProfile.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileGetBaseResponseobject

Response description
PropertyTypeDescription
billingProfileBillingProfileThe requested BillingProfile.
billingProfile.billeeuint64Unique identifier of the Company receiving the bill. Most of the time, this value is the same as the target.
billingProfile.companyuint64Unique identifier of the Company that owns this profile and is sending the bill.
billingProfile.currencyBillingCurrencykind of money
billingProfile.cycleBillingCycleRepeating cycle used for generating bills
billingProfile.cycleEnddatetimeWhen should the cycle end (customer cancelled)
billingProfile.cyclePostDatedbooleanPro-rated, or post-dated.
billingProfile.cycleStartdatetimeWhen is the first day of the billing cycle
billingProfile.googleServicesEnabledbooleanAre the Google services available to be proxied by the service?
billingProfile.iduint64Unique identifier of this billing profile
billingProfile.messagesArray.<BillableSmsProfile>SMS messaging tiers
billingProfile.namestring
maximum-length: 254
The name for this profile
billingProfile.notesstring
maximum-length: 1000
Notes about the billing profile for the billee or target.
billingProfile.targetuint64Unique identifier of the Company to which this rule pertains.
billingProfile.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"billee": number,
		"company": number,
		"currency": string,
		"cycle": string,
		"cycleEnd": string,
		"cyclePostDated": boolean,
		"cycleStart": string,
		"googleServicesEnabled": boolean,
		"id": number,
		"messages": [
			{
				"amount": number,
				"limit": number
			}
		],
		"name": string,
		"notes": string,
		"target": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileListByCompanyBaseResponseobject

Response description
PropertyTypeDescription
billingProfilesArray.<BillingProfile>The list of requested BillingProfiles.
companyRespIdAn object to contain the "id" of the Company to which the array of BillingProfiles belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfiles": [
		{
			"billee": number,
			"company": number,
			"currency": string,
			"cycle": string,
			"cycleEnd": string,
			"cyclePostDated": boolean,
			"cycleStart": string,
			"googleServicesEnabled": boolean,
			"id": number,
			"messages": [
				{
					"amount": number,
					"limit": number
				}
			],
			"name": string,
			"notes": string,
			"target": number,
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileMergeBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespIdCompanyAn object which contains the "id", "company", and "profile" keys.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingProfileRestoreBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespDeletedAn object which contains the BillingProfile's unique identifier and deleted status.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.deletedbooleanFlag showing if the object is deleted.
billingProfile.iduint64?Identifier given as input for the command.
billingProfile.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportDeleteBaseResponseobject

Response description
PropertyTypeDescription
billingReportRespDeletedAn object which contains the BillingReport's unique identifier and deleted status.
billingReport.companyuint64Identifier of the Company to which this object belongs.
billingReport.deletedbooleanFlag showing if the object is deleted.
billingReport.iduint64?Identifier given as input for the command.
billingReport.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingReport": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportGetBaseResponseobject

Response description
PropertyTypeDescription
billingReportBillingReportThe requested BillingReport.
billingReport.billeeuint64Unique identifier of the Company receiving the bill.
billingReport.companyuint64The company to which this report belongs and is sending the bill.
billingReport.currencyBillingCurrencyCurrency being billed in
billingReport.endDatedatetimeLast day of the billing cycle
billingReport.errorstring
maximum-length: 250
A field which contains report error details if the BillingReport.status is BillingReportStatus.failed.
billingReport.hostingBreakdownObject.<uint64, Array.<BillingReportHostingBreakdown>>
for keys see: Asset.id
Individual amounts per targeted assets used to calculate the results of the report.
billingReport.iduint64Unique identifier
billingReport.namestring
maximum-length: 100
Name of this report.
billingReport.notesstringNotes about this report.
billingReport.profileuint64The profile to which this report belongs
billingReport.startDatedatetimeFirst day of the billing cycle
billingReport.statusBillingReportStatusThe processing status of this report.
billingReport.summaryArray.<BillingReportSummary>Summary contains totals per target for this billee
billingReport.totaldoubleTotal amount being billed.
billingReport.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingReport": {
		"billee": number,
		"company": number,
		"currency": string,
		"endDate": string,
		"error": string,
		"hostingBreakdown": {
			string: [
				{
					"asset": number,
					"billableDays": number,
					"cost": number,
					"created": string,
					"deleted": string,
					"discount": number,
					"labels": [
						string
					],
					"name": string,
					"notes": string,
					"phoneNumbers": [
						number
					],
					"providers": [
						string
					],
					"suspended": string,
					"suspendedCost": number,
					"suspendedDays": number,
					"suspendedDiscount": number,
					"total": number,
					"updatedDts": string
				}
			]
		},
		"id": number,
		"name": string,
		"notes": string,
		"profile": number,
		"startDate": string,
		"status": string,
		"summary": [
			{
				"hostingSummary": [
					{
						"count": number,
						"kind": string,
						"total": number
					}
				],
				"name": string,
				"notes": string,
				"parent": number,
				"target": number
			}
		],
		"total": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportListByBillingProfileBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespIdCompanyAn object to contain the "id" of the BillingProfile to which the array of BillableHostingRules belong.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.iduint64?Identifier given as input for the command.
billingReportsArray.<BillingReport>The list of requested BillingReports.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"billingReports": [
		{
			"billee": number,
			"company": number,
			"currency": string,
			"endDate": string,
			"error": string,
			"hostingBreakdown": {
				string: [
					{
						"asset": number,
						"billableDays": number,
						"cost": number,
						"created": string,
						"deleted": string,
						"discount": number,
						"labels": [
							string
						],
						"name": string,
						"notes": string,
						"phoneNumbers": [
							number
						],
						"providers": [
							string
						],
						"suspended": string,
						"suspendedCost": number,
						"suspendedDays": number,
						"suspendedDiscount": number,
						"total": number,
						"updatedDts": string
					}
				]
			},
			"id": number,
			"name": string,
			"notes": string,
			"profile": number,
			"startDate": string,
			"status": string,
			"summary": [
				{
					"hostingSummary": [
						{
							"count": number,
							"kind": string,
							"total": number
						}
					],
					"name": string,
					"notes": string,
					"parent": number,
					"target": number
				}
			],
			"total": number,
			"v": [
				number
			]
		}
	],
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportListByCompanyBaseResponseobject

Response description
PropertyTypeDescription
billingReportsArray.<BillingReport>The list of requested BillingReports.
companyRespIdAn object to contain the "id" of the Company to which the array of BillingReports belong.
company.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingReports": [
		{
			"billee": number,
			"company": number,
			"currency": string,
			"endDate": string,
			"error": string,
			"hostingBreakdown": {
				string: [
					{
						"asset": number,
						"billableDays": number,
						"cost": number,
						"created": string,
						"deleted": string,
						"discount": number,
						"labels": [
							string
						],
						"name": string,
						"notes": string,
						"phoneNumbers": [
							number
						],
						"providers": [
							string
						],
						"suspended": string,
						"suspendedCost": number,
						"suspendedDays": number,
						"suspendedDiscount": number,
						"total": number,
						"updatedDts": string
					}
				]
			},
			"id": number,
			"name": string,
			"notes": string,
			"profile": number,
			"startDate": string,
			"status": string,
			"summary": [
				{
					"hostingSummary": [
						{
							"count": number,
							"kind": string,
							"total": number
						}
					],
					"name": string,
					"notes": string,
					"parent": number,
					"target": number
				}
			],
			"total": number,
			"v": [
				number
			]
		}
	],
	"company": {
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespBillingReportRestoreBaseResponseobject

Response description
PropertyTypeDescription
billingReportRespDeletedAn object which contains the BillingReport's unique identifier and deleted status.
billingReport.companyuint64Identifier of the Company to which this object belongs.
billingReport.deletedbooleanFlag showing if the object is deleted.
billingReport.iduint64?Identifier given as input for the command.
billingReport.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingReport": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespHostingDiscountDeleteBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingDiscountRespDeletedAn object which contains the BillableHostingDiscount's unique identifier and deleted status.
hostingDiscount.companyuint64Identifier of the Company to which this object belongs.
hostingDiscount.deletedbooleanFlag showing if the object is deleted.
hostingDiscount.iduint64?Identifier given as input for the command.
hostingDiscount.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingDiscount": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingDiscountGetBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingDiscountBillableHostingDiscountThe requested BillableHostingDiscount.
hostingDiscount.amountdoubleCost per cycle for this plan
hostingDiscount.companyuint64Unique identifier of the Company that owns this hosting rule.
hostingDiscount.enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
hostingDiscount.iduint64Unique identifier of this hosting rule.
hostingDiscount.limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
hostingDiscount.namestring
maximum-length: 254
The name of this billing rule.
hostingDiscount.notesstringNotes about billing this rule.
hostingDiscount.percentagebooleanWhen true, the amount is used as a percentage value instead of a currency values.
hostingDiscount.profileuint64Unique identifier of this rule's billing profile.
hostingDiscount.referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingDiscount.servicesArray.<BillableHostingType>The type of services being discounted.
hostingDiscount.startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
hostingDiscount.suspendedbooleanDoes this hosting rule apply to suspended resources
hostingDiscount.targetsexpressionWhich assets are targetted by this hosting rule
hostingDiscount.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingDiscount": {
		"amount": number,
		"company": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"percentage": boolean,
		"profile": number,
		"reference": string,
		"services": [
			string
		],
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingDiscountListByBillingProfileBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespIdCompanyAn object to contain the "id" of the BillingProfile to which the array of BillableHostingDiscounts belong.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingDiscountsArray.<BillableHostingDiscount>The list of requested BillableHostingDiscounts.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingDiscounts": [
		{
			"amount": number,
			"company": number,
			"end": string,
			"id": number,
			"limit": number,
			"name": string,
			"notes": string,
			"percentage": boolean,
			"profile": number,
			"reference": string,
			"services": [
				string
			],
			"start": string,
			"suspended": boolean,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingDiscountMergeBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingDiscountRespIdBillingProfileAn object which contains the "id", "company", and "profile" keys.
hostingDiscount.companyuint64Identifier of the Company to which this object belongs.
hostingDiscount.iduint64?Identifier given as input for the command.
hostingDiscount.profileuint64Identifier of the BillingProfile to which this object belongs
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingDiscount": {
		"company": number,
		"id": number,
		"profile": number
	},
	"message": string,
	"reqId": number
}

RespHostingDiscountRestoreBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingDiscountRespDeletedAn object which contains the BillableHostingDiscount's unique identifier and deleted status.
hostingDiscount.companyuint64Identifier of the Company to which this object belongs.
hostingDiscount.deletedbooleanFlag showing if the object is deleted.
hostingDiscount.iduint64?Identifier given as input for the command.
hostingDiscount.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingDiscount": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseDeleteBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenseRespDeletedAn object which contains the BillableHostingLicense's unique identifier and deleted status.
hostingLicense.companyuint64Identifier of the Company to which this object belongs.
hostingLicense.deletedbooleanFlag showing if the object is deleted.
hostingLicense.iduint64?Identifier given as input for the command.
hostingLicense.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseGetBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenseBillableHostingLicenseThe requested BillableHostingLicense.
hostingLicense.amountdoubleCost per cycle for this plan
hostingLicense.companyuint64Unique identifier of the Company that owns this hosting rule.
hostingLicense.enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
hostingLicense.iduint64Unique identifier of this hosting rule.
hostingLicense.kindBillableLicenseTypeThe type of hardware license
hostingLicense.limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
hostingLicense.namestring
maximum-length: 254
The name of this billing rule.
hostingLicense.notesstringNotes about billing this rule.
hostingLicense.profileuint64Unique identifier of this rule's billing profile.
hostingLicense.referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingLicense.startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
hostingLicense.suspendedbooleanDoes this hosting rule apply to suspended resources
hostingLicense.targetsexpressionWhich assets are targetted by this hosting rule
hostingLicense.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"amount": number,
		"company": number,
		"end": string,
		"id": number,
		"kind": string,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseListByBillingProfileBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespIdCompanyAn object to contain the "id" of the BillingProfile to which the array of BillableHostingLicenses belong.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicensesArray.<BillableHostingLicense>The list of BillableHostingLicenses.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicenses": [
		{
			"amount": number,
			"company": number,
			"end": string,
			"id": number,
			"kind": string,
			"limit": number,
			"name": string,
			"notes": string,
			"profile": number,
			"reference": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingLicenseMergeBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenseRespIdBillingProfileAn object which contains the "id", "company", and "profile" keys.
hostingLicense.companyuint64Identifier of the Company to which this object belongs.
hostingLicense.iduint64?Identifier given as input for the command.
hostingLicense.profileuint64Identifier of the BillingProfile to which this object belongs
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"id": number,
		"profile": number
	},
	"message": string,
	"reqId": number
}

RespHostingLicenseRestoreBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingLicenseRespDeletedAn object which contains the BillableHostingLicense's unique identifier and deleted status.
hostingLicense.companyuint64Identifier of the Company to which this object belongs.
hostingLicense.deletedbooleanFlag showing if the object is deleted.
hostingLicense.iduint64?Identifier given as input for the command.
hostingLicense.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingLicense": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleDeleteBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRuleRespDeletedAn object which contains the BillableHostingRule's unique identifier and deleted status.
hostingRule.companyuint64Identifier of the Company to which this object belongs.
hostingRule.deletedbooleanFlag showing if the object is deleted.
hostingRule.iduint64?Identifier given as input for the command.
hostingRule.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleGetBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRuleBillableHostingRuleThe requested BillableHostingRule.
hostingRule.amountdoubleCost per cycle for this plan
hostingRule.companyuint64Unique identifier of the Company that owns this hosting rule.
hostingRule.enddatetimeDate this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed.
hostingRule.iduint64Unique identifier of this hosting rule.
hostingRule.limituint32?The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited
hostingRule.namestring
maximum-length: 254
The name of this billing rule.
hostingRule.notesstringNotes about billing this rule.
hostingRule.profileuint64Unique identifier of this rule's billing profile.
hostingRule.referencestring
maximum-length: 100
A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingRule.serviceBillableHostingTypeThe type of service being billed.
hostingRule.startdatetimeDate this billing rule takes effect. These dates are used to determine how much of the cycle is billed.
hostingRule.suspendedbooleanDoes this hosting rule apply to suspended resources
hostingRule.targetsexpressionWhich assets are targetted by this hosting rule
hostingRule.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"amount": number,
		"company": number,
		"end": string,
		"id": number,
		"limit": number,
		"name": string,
		"notes": string,
		"profile": number,
		"reference": string,
		"service": string,
		"start": string,
		"suspended": boolean,
		"targets": string,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

RespHostingRuleListByBillingProfileBaseResponseobject

Response description
PropertyTypeDescription
billingProfileRespIdCompanyAn object to contain the "id" of the BillingProfile to which the array of BillableHostingRules belong.
billingProfile.companyuint64Identifier of the Company to which this object belongs.
billingProfile.iduint64?Identifier given as input for the command.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRulesArray.<BillableHostingRule>The list of requested BillableHostingRules.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"billingProfile": {
		"company": number,
		"id": number
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRules": [
		{
			"amount": number,
			"company": number,
			"end": string,
			"id": number,
			"limit": number,
			"name": string,
			"notes": string,
			"profile": number,
			"reference": string,
			"service": string,
			"start": string,
			"suspended": boolean,
			"targets": string,
			"v": [
				number
			]
		}
	],
	"message": string,
	"reqId": number
}

RespHostingRuleMergeBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRuleRespIdBillingProfileAn object which contains the "id", "company", and "profile" keys.
hostingRule.companyuint64Identifier of the Company to which this object belongs.
hostingRule.iduint64?Identifier given as input for the command.
hostingRule.profileuint64Identifier of the BillingProfile to which this object belongs
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"id": number,
		"profile": number
	},
	"message": string,
	"reqId": number
}

RespHostingRuleRestoreBaseResponseobject

Response description
PropertyTypeDescription
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
hostingRuleRespDeletedAn object which contains the BillableHostingRule's unique identifier and deleted status.
hostingRule.companyuint64Identifier of the Company to which this object belongs.
hostingRule.deletedbooleanFlag showing if the object is deleted.
hostingRule.iduint64?Identifier given as input for the command.
hostingRule.vArray.<uint32>
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"hostingRule": {
		"company": number,
		"deleted": boolean,
		"id": number,
		"v": [
			number
		]
	},
	"message": string,
	"reqId": number
}

Companies

Companyobject

The full company object which contains all fields.
JSON description
PropertyTypeDescription
directoryObject.<string, Array.<uint64>>
for value-values see: Contact.id
The list of Contacts from this and other companies broken down by contact role.
iduint64Unique identifier of the Company.
labelsObject.<codified, LabelStyle>
for keys see: LabelStyle.code
The styles for labels added to Assets, Places, and other things.
namestring
maximum-length: 100
The organizational name.
notesstringNotes.
parentuint64The unique identifier of this company's parent organization.
passwordPolicyPasswordPolicyThe password complexity and expiry policy.
referencesObject.<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.
resellerCompanyResellerIf this company is a reseller, then they have their own theme, support and billing information.
sessionPolicySessionPolicyThe session lifetime policy.
tagsObject.<codified, LabelStyle>
for keys see: LabelStyle.code
The styles for status tags added to Assets.
userGroupsArray.<UserGroup>A list of user groups that belong to this company. A user can only belong to groups from their own company.
vArray.<int32>
fixed count: 6
Object version keys used to validate synchronization for all object properties.
v[0]int32The first element is for the general properties
v[1]int32The second element is not used (yet)
v[2]int32The third element is not used (yet)
v[3]int32The fourth element is for the style properties
v[4]int32The fifth element is for the policy properties
v[5]int32The sixth element is for the reseller properties
JSON structure
{
	"directory": {
		string: [
			number
		]
	},
	"id": number,
	"labels": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"name": string,
	"notes": string,
	"parent": number,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"references": {
		string: string
	},
	"reseller": {
		"contactInfo": {
			string: number
		},
		"domain": string,
		"favourite": string,
		"gamut": {
			string: {
				"fill": string,
				"stroke": string
			}
		},
		"graphics": {
			string: string
		},
		"icon": string,
		"id": number,
		"languages": [
			string
		],
		"logo": string,
		"notifyEmail": {
			"incomingAddress": string,
			"incomingLogin": string,
			"incomingMessageNumber": number,
			"incomingPort": number,
			"incomingSecure": boolean,
			"incomingType": string,
			"outgoingAddress": string,
			"outgoingLogin": string,
			"outgoingPort": number,
			"outgoingReplyTo": string,
			"outgoingSecure": boolean,
			"outgoingType": string
		},
		"notifySms": {
			"notifyLimit": number,
			"phoneNumbers": {
				string: [
					number
				]
			}
		},
		"parent": number,
		"recoverBody": string,
		"recoverIsHtml": boolean,
		"recoverSubject": string,
		"serviceName": string,
		"termsPreamble": string,
		"termsUpdated": string,
		"v": [
			number
		],
		"website": {
			string: string
		}
	},
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string
		],
		"maxSessions": number,
		"multiUser": string
	},
	"tags": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"userGroups": [
		{
			"company": number,
			"id": number,
			"name": string,
			"notes": string,
			"permissions": [
				{
					"company": number,
					"kind": string,
					"labels": [
						string
					],
					"level": string,
					"method": string,
					"type": string
				}
			],
			"v": [
				number
			]
		}
	],
	"v": [
		number
	]
}

CompanyDeletedobject

The message format for when a deleted Company is retrieved
JSON description
PropertyTypeValueDescription
deletedbooleantrue
iduint64Unique identifier of the Company.
parentuint64The unique identifier of this company's parent organization.
sincedatetimeA timestamp from the moment the object was deleted.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"deleted": boolean,
	"id": number,
	"parent": number,
	"since": string,
	"v": [
		number
	]
}

CompanyGeneralobject

General details about a company.
JSON description
PropertyTypeDescription
iduint64Unique identifier of the Company.
namestring
maximum-length: 100
The organizational name.
notesstringNotes.
parentuint64The unique identifier of this company's parent organization.
referencesObject.<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.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"id": number,
	"name": string,
	"notes": string,
	"parent": number,
	"references": {
		string: string
	},
	"v": [
		number
	]
}

CompanyPoliciesobject

The password and session lifetime policies for this Company.
JSON description
PropertyTypeDescription
iduint64Unique identifier of the Company.
parentuint64The unique identifier of this company's parent organization.
passwordPolicyPasswordPolicyThe password complexity and expiry policy.
sessionPolicySessionPolicyThe session lifetime policy.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"id": number,
	"parent": number,
	"passwordPolicy": {
		"expireMode": string,
		"expireThreshold": number,
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number
	},
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string
		],
		"maxSessions": number,
		"multiUser": string
	},
	"v": [
		number
	]
}

CompanyStylesobject

The colours and styles used by this company to tag and label Assets, Places, and other things.
JSON description
PropertyTypeDescription
iduint64Unique identifier of the Company.
labelsObject.<codified, LabelStyle>
for keys see: LabelStyle.code
The styles for labels added to Assets, Places, and other things.
parentuint64The unique identifier of this company's parent organization.
tagsObject.<codified, LabelStyle>
for keys see: LabelStyle.code
The styles for status tags added to Assets.
vArray.<uint32>Object version keys used to validate synchronization for all object properties.
JSON structure
{
	"id": number,
	"labels": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"parent": number,
	"tags": {
		string: {
			"code": string,
			"fill": string,
			"graphic": string,
			"name": string,
			"notes": string,
			"stroke": string
		}
	},
	"v": [
		number
	]
}

LabelStyleobject

Visual style identification helper.
JSON description
PropertyTypeDescription
codecodifiedThe codified name of this style
fillcolour
maximum-length: 22
The background colour given to this style for easy visual identification.
graphiccodified
maximum-length: 22
The codified graphic name given to this script for easy visual identification.
namestring
maximum-length: 100
The name of this visual style.
notesstringNotes!
strokecolour
maximum-length: 22
The text/graphic colour given to this style for easy visual identification.
JSON structure
{
	"code": string,
	"fill": string,
	"graphic": string,
	"name": string,
	"notes": string,
	"stroke": string
}

ParamCompanyDeleteBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" key.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamCompanyGeneralGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalways
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamCompanyGetBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" key.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamCompanyListByParentBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeParentbooleanoptionalfalseWhen set to true, the parent Company is included in the results.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
treebooleanoptionaltrueWhen set to true, the full tree of companies is returned. Otherwise, only the first-level child-companies are included.
Request structure
{
	"company": {
		"id": number
	},
	"includeParent": boolean,
	"reqId": number,
	"tree": boolean
}

ParamCompanyListByRefPairsBaseParametersobject

Request description
PropertyTypeRequiredDefaultDescription
companyParamIdalwaysAn object to contain the "id" of the Company.
company.iduint64alwaysIdentifier given as input for the command.
includeParentbooleanoptionalfalseWhen set to true, the parent Company is included in the results.
referencesObject.<string, string>optionalCase-insensitive reference pairs used to match Companys.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
treebooleanoptionaltrueWhen set to true, the full tree of companies is returned. Otherwise, only the first-level child-companies are included.
Request structure
{
	"company": {
		"id": number
	},
	"includeParent": boolean,
	"references": {
		string: string
	},
	"reqId": number,
	"tree": boolean
}

ParamCompanyMergeBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyObject.<string, ?>alwaysA simple object to contain the company parameters.
company.directoryObject.<string, Array.<uint64>>
for value-values see: Contact.id
optionalThe list of Contacts from this and other companies broken down by contact role.
company.iduint64?updateUnique identifier of the Company.
company.labelsObject.<string, LabelStyle>optionalThe styles for labels added to Assets, Places, and other things.
company.namestring
maximum-length: 100
createThe organizational name.
company.notesstringoptionalNotes.
company.parentuint64?createThe unique identifier of this company's parent organization.
company.passwordPolicyObject.<string, ?>alwaysThe password complexity and expiry policy.
company.passwordPolicy.expireModePasswordExpiryMode?optionalDefines how passwords expire.
company.passwordPolicy.expireThresholdbyte?optionalThe threshold for expiry (in days).
company.passwordPolicy.includeLettersbooleanoptionalDo passwords require alphabetical characters.
company.passwordPolicy.includeNumbersbooleanoptionalDo passwords require numeric characters.
company.passwordPolicy.includeSpecialbooleanoptionalDo passwords require non-alphanumeric characters.
company.passwordPolicy.includeUpperLowerbooleanoptionalDo passwords require upper-case and lower-case letters.
company.passwordPolicy.minimumLengthbyte?optionalThe minimum number of characters required.
company.referencesObject.<string, string>optionalName/value collections of custom fields used to refer to external systems. If the value is null, the references are removed from the Company.
company.sessionPolicyObject.<string, ?>alwaysThe session lifetime policy.
company.sessionPolicy.applicationsArray.<string>optionalThe list of applications users are allowed to use to create sessions.
company.sessionPolicy.expireTimeoutuint16?optionalThe lifetime duration of a session in minutes.
company.sessionPolicy.idleAllowedbooleanoptionalDefines whether a session should be automatically killed when the connection breaks.
company.sessionPolicy.ipv4RangesArray.<ipv4>
maximum-length of values: 19
optionalRestrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
company.sessionPolicy.maxSessionsbyte?optionalThe maximum number of sessions allowed per user.
company.sessionPolicy.multiUserSessionMultiUser?optionalDefines the behaviour of the system when a user creates multiple sessions.
company.tagsObject.<string, LabelStyle>optionalThe styles for status tags added to Assets.
company.vArray.<int32>optional
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"directory": {
			string: [
				number
			]
		},
		"id": number,
		"labels": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"name": string,
		"notes": string,
		"parent": number,
		"passwordPolicy": {
			"expireMode": string,
			"expireThreshold": number,
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number
		},
		"references": {
			string: string
		},
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string
			],
			"maxSessions": number,
			"multiUser": string
		},
		"tags": {
			string: {
				"code": string,
				"fill": string,
				"graphic": string,
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"v": [
			number
		]
	},
	"reqId": number
}

ParamCompanyRestoreBaseParametersobject

Request description
PropertyTypeRequiredDescription
companyParamIdalwaysAn object to contain the "id" key.
company.iduint64alwaysIdentifier given as input for the command.
reqIdint32?optionalIdentifier used by external system to correlate requests to responses.
Request structure
{
	"company": {
		"id": number
	},
	"reqId": number
}

ParamPasswordPolicyobject

Parameter values for creating a new or updating an existing PasswordPolicy.
JSON description
PropertyTypeDescription
expireModePasswordExpiryMode?Defines how passwords expire.
expireThresholdbyte?The threshold for expiry (in days).
includeLettersbooleanDo passwords require alphabetical characters.
includeNumbersbooleanDo passwords require numeric characters.
includeSpecialbooleanDo passwords require non-alphanumeric characters.
includeUpperLowerbooleanDo passwords require upper-case and lower-case letters.
minimumLengthbyte?The minimum number of characters required.
JSON structure
{
	"expireMode": string,
	"expireThreshold": number,
	"includeLetters": boolean,
	"includeNumbers": boolean,
	"includeSpecial": boolean,
	"includeUpperLower": boolean,
	"minimumLength": number
}

ParamSessionPolicyobject

Parameter values for creating a new or updating an existing SessionPolicy.
JSON description
PropertyTypeDescription
applicationsArray.<string>The list of applications users are allowed to use to create sessions.
expireTimeoutuint16?The lifetime duration of a session in minutes.
idleAllowedbooleanDefines whether a session should be automatically killed when the connection breaks.
ipv4RangesArray.<ipv4>
maximum-length of values: 19
Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access.
maxSessionsbyte?The maximum number of sessions allowed per user.
multiUserSessionMultiUser?Defines the behaviour of the system when a user creates multiple sessions.
JSON structure
{
	"applications": [
		string
	],
	"expireTimeout": number,
	"idleAllowed": boolean,
	"ipv4Ranges": [
		string
	],
	"maxSessions": number,
	"multiUser": string
}

PasswordExpiryModestring

Defines how User passwords expire.
ValueDescription
daysPasswords expire after a defined number of days.
neverPasswords never expire.
sessionsPasswords expire after a defined number of successful logins.

PasswordPolicyobject

The password complexity and expiry policy.
JSON description
PropertyTypeDescription
expireModePasswordExpiryModeDefines how passwords expire.
expireThresholdbyteThe threshold for expiry.
includeLettersbooleanDo passwords require alphabetical characters.
includeNumbersbooleanDo passwords require numeric characters.
includeSpecialbooleanDo passwords require non-alphanumeric characters.
includeUpperLowerbooleanDo passwords require upper-case and lower-case letters.
minimumLengthbyteThe minimum number of characters required.
JSON structure
{
	"expireMode": string,
	"expireThreshold": number,
	"includeLetters": boolean,
	"includeNumbers": boolean,
	"includeSpecial": boolean,
	"includeUpperLower": boolean,
	"minimumLength": number
}

RespCompanyDeleteBaseResponseobject

Response description
PropertyTypeDescription
companyRespParentDeletedAn object which contains the Company's unique identifier and deleted status.
company.deletedbooleanFlag showing if the object is deleted.
company.iduint64?Identifier given as input for the command.
company.parentuint64Identifier of the parent to which the Company is a child.
company.vArray.<uint32>
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"company": {
		"deleted": boolean,
		"id": number,
		"parent": number,
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyGeneralGetBaseResponseobject

Response description
PropertyTypeDescription
companyCompanyGeneral
company.iduint64Unique identifier of the Company.
company.namestring
maximum-length: 100
The organizational name.
company.notesstringNotes.
company.parentuint64The unique identifier of this company's parent organization.
company.referencesObject.<string, string>
maximum-count: 10
maximum-length of keys: 20
maximum-length of values: 100
Name/value collections of custom fields used to refer to external systems.
company.vArray.<uint32>Object version keys used to validate synchronization for all object properties.
errorCodeErrorCodeThe unique, numeric error code when processing this request.
errorDetailsErrorDetailAn object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors.
messagestringAn English description of the error.
reqIdint32?Identifier used by external system to correlate requests to responses.
Response structure
{
	"company": {
		"id": number,
		"name": string,
		"notes": string,
		"parent": number,
		"references": {
			string: string
		},
		"v": [
			number
		]
	},
	"errorCode": number,
	"errorDetails": {
		"kind": string
	},
	"message": string,
	"reqId": number
}

RespCompanyGetBaseResponseobject

Response description
PropertyTypeDescription
companyCompanyThe requested Company.
company.directoryObject.<string, Array.<uint64>>
for value-values see: Contact.id
The list of Contacts from this and other companies broken down by contact role.
company.iduint64Unique identifier of the Company.
company.labelsObject.<codified, LabelStyle>
for keys see: LabelStyle.code
The styles for labels added to Assets, Places, and other things.
company.namestring
maximum-length: 100
The organizational name.
company.notesstringNotes.
company.parentuint64The unique identifier of this company's parent organization.
company.passwordPolicyPasswordPolicyThe password complexity and expiry policy.
company.passwordPolicy.expireModePasswordExpiryModeDefines how passwords expire.
company.passwordPolicy.expireThresholdbyteThe threshold for expiry.
company.passwordPolicy.includeLettersbooleanDo passwords require alphabetical characters.
company.passwordPolicy.includeNumbersbooleanDo passwords require numeric characters.
company.passwordPolicy.includeSpecialbooleanDo passwords require non-alphanumeric characters.
company.passwordPolicy.includeUpperLowerbooleanDo passwords require upper-case and lower-case letters.
company.passwordPolicy.minimumLengthbyteThe minimum number of characters required.
company.referencesObject.<string, string>
maximum-count: 10
maximum-length of keys: 20
maximum-length of values: 100
Name/value collections of custom fields used to refer to external systems.
company.resellerCompanyResellerIf this company is a reseller, then they have their own theme, support and billing information.
company.reseller.contactInfoObject.<string, uint64>
maximum-count of keys: 100
for values see: Contact.id
A list of Contacts for company specific things like Technical Support, Billing, etc...
company.reseller.domainstring
maximum-length: 100
The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS.
company.reseller.favouritestring
maximum-length: 200
The name of the icon file used for browser bookmarks.
company.reseller.gamutObject.<string, ColourStyle>
maximum-length of keys: 25
Colours used as templates for status tags, labels, and places.
company.reseller.graphicsObject.<string, codified>
maximum-length of keys: 25
maximum-length of values: 30
A list of symbol names and their corresponding FontAwesome icon names.
company.reseller.iconstring
maximum-length: 200
The name of the image uploaded as the logo (used for collapsed/mobile view).
company.reseller.iduint64Unique identifier of the Company.
company.reseller.languagesArray.<codified>
maximum-length of values: 5
A list of supported languages for your customers.
company.reseller.notifyEmailNotificationServerEmailThe server used for notification and conversational email messages sent and received by the system.
company.reseller.notifyEmail.incomingAddressstringThe domain or IP address of the incoming email server.
company.reseller.notifyEmail.incomingLoginstringThe username used to login to the incoming email server.
company.reseller.notifyEmail.incomingMessageNumberuint32IMAP message sequence number so only recent messages are retrieved.
company.reseller.notifyEmail.incomingPortuint16The port number of the incoming email server.
company.reseller.notifyEmail.incomingSecurebooleanIs the incoming email server using a secure SSL/TLS connection (it should).
company.reseller.notifyEmail.incomingTypestringThe type of incoming protocol to use (IMAP or POP3).
company.reseller.notifyEmail.outgoingAddressstringThe domain or IP address of the outgoing email server.
company.reseller.notifyEmail.outgoingLoginstringThe username used to login to the outgoing email server.
company.reseller.notifyEmail.outgoingPortuint16The port number of the outgoing email server.
company.reseller.notifyEmail.outgoingReplyToemailAn optional field which can be set as the "sent from" and/or "reply-to" address.
company.reseller.notifyEmail.outgoingSecurebooleanIs the outgoing email server using a secure SSL/TLS connection (it should).
company.reseller.notifyEmail.outgoingTypestringThe type of outgoing protocol to use (only SMTP).
company.reseller.notifySmsNotificationServerSmsDefinition for load-balanced outbound SMS numbers for the reseller.
company.reseller.notifySms.notifyLimituint16A per-number/per-day limit on the amount of Notifications sent.
company.reseller.notifySms.phoneNumbersObject.<string, Array.<phone>>
fixed length of keys: 2
All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
company.reseller.parentuint64The unique identifier of this company's parent organization.
company.reseller.recoverBodystringThe body of the email sent to a user requesting a password reset.
company.reseller.recoverIsHtmlboolean
company.reseller.recoverSubjectstringThe subject of the email sent to a user requesting a password reset.
company.reseller.serviceNamestring
maximum-length: 150
The name of the branded service being provided to