WebSocket Reference | Developers

Service Commands

API Definitions

connection

This is the first message sent after a connection has been initialized. If you begin sending messages before receiving the connectionResponse, your socket may be closed abruptly.

JSON request message structure

connection {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

connectionResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"expiry": string,		/* datetime format */
	"ghostId": string,
	"message": string,
	"passwordPolicy": {
		"expireMode": string,		/* one of the ExpiryModePolicy values */
		"expireThreshold": number,		/* uint8 format */
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number		/* uint8 format */
	},
	"reqId": number,		/* uint32 format */
	"serverTime": string,		/* datetime format */
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,		/* uint16 format */
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string		/* ipv4 format */
		],
		"maxSessions": number,		/* uint8 format */
		"multiUser": string		/* one of the MultiUserPolicy values */
	},
	"user": {
		"company": number,		/* uint64 format, see Company.id */
		"contact": {
			"addresses": {
				string: string		/* email format */
			},
			"company": number,		/* uint64 format, see Company.id */
			"dates": {
				string: string		/* datetime format */
			},
			"emails": {
				string: string		/* email format */
			},
			"id": number,		/* uint64 format */
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number		/* uint64 format */
			},
			"pictures": [
				number		/* uint64 format */
			],
			"roles": [
				string		/* codified format */
			],
			"urls": {
				string: string
			},
			"v": [
				number		/* uint32 format */
			]
		},
		"enabled": boolean,
		"formats": {
			string /* codified format */ : string
		},
		"groups": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"id": number,		/* uint64 format */
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,		/* uint64 format, see Company.id */
						"labels": [
							string		/* see LabelStyle.code */
						],
						"level": string,		/* one of the PermissionLevel values */
						"method": string,		/* one of the PermissionMethod values */
						"type": string		/* one of the PermissionType values */
					}
				],
				"v": [
					number		/* uint32 format */
				]
			}
		],
		"language": string,
		"login": string,		/* email format, see User.login */
		"measurements": {
			string /* codified format */ : string		/* one of the SystemsOfUnits values */
		},
		"nickname": string,
		"notify": [
			{
				"email": string,		/* email format */
				"enabled": boolean,
				"end": string,		/* duration format, see UserGeneral.timezone */
				"name": string,
				"offline": [
					string		/* one of the NotificationsMethod values */
				],
				"online": [
					string		/* one of the NotificationsMethod values */
				],
				"sms": number,		/* uint64 format */
				"start": string,		/* duration format, see UserGeneral.timezone */
				"weekdays": [
					boolean		/* see UserGeneral.timezone */
				]
			}
		],
		"options": {
			string /* codified format */ : string
		},
		"passwordExpired": boolean,
		"passwordPolicy": {
			"expireMode": string,		/* one of the ExpiryModePolicy values */
			"expireThreshold": number,		/* uint8 format */
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number		/* uint8 format */
		},
		"permissions": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"labels": [
					string		/* see LabelStyle.code */
				],
				"level": string,		/* one of the PermissionLevel values */
				"method": string,		/* one of the PermissionMethod values */
				"type": string		/* one of the PermissionType values */
			}
		],
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,		/* uint16 format */
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string		/* ipv4 format */
			],
			"maxSessions": number,		/* uint8 format */
			"multiUser": string		/* one of the MultiUserPolicy values */
		},
		"timezone": string,		/* see Timezone.code */
		"v": [
			number		/* uint32 format */
		]
	}
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
expiry	string(datetime)	if no error	The date/time when this UserSession expires.
ghostId	string	if no error	Your session identifier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
passwordPolicy	PasswordPolicy	if no error	The company's password policy. Needed if the user's password is expired.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
serverTime	string(datetime)	if no error	The UTC date/time of the server hosting the connection.
sessionPolicy	SessionPolicy	if no error	The company's session policy.
user	Session	if no error	All the details about your user.

getProviderConfigType

Gets details of the specified Provider Configuration Type.

JSON request message structure

getProviderConfigType {
	"providerConfigType": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfigType	object	true	An object to contain the "id" key.
providerConfigType.id	number(uint64)	true	Unique identifier of the configuration logic type.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigTypeResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfigType": {
		"geofenceTypes": [
			
		],
		"id": number,		/* uint64 format */
		"maxGeofenceCount": number,		/* uint32 format */
		"minGeofenceCount": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"providerType": string,		/* one of the ProviderType values */
		"scriptOptions": {
			string: {
				"id": string,
				"isAdvanced": boolean,
				"max": object,
				"min": object,
				"nodes": {
					string: { /* recursive ProviderConfigurationNode objects */ }
				},
				"notes": string,
				"type": string,
				"unit": string,		/* one of the ProviderDataUnits values */
				"value": object
			}
		},
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfigType	ProviderConfigurationType	if no error	The requested ProviderConfigurationType.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderConfigTypesList

Gets a list of Provider Configuration Types.

JSON request message structure

getProviderConfigTypesList {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigTypesListResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfigTypes": [
		{ /* see ProviderConfigurationType for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfigTypes	array[ProviderConfigurationType]	if no error	The list of ProviderConfigurationTypes.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getTimezone

Gets details of the specified Time Zone.

JSON request message structure

getTimezone {
	"reqId": number,		/* uint32 format */
	"timezone": {
		"code": string
	}
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
timezone	object	true	An object to contain the "code" key.
timezone.code	string	true	The system identifier of the timezone.

JSON response message structure

getTimezoneResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number,		/* uint32 format */
	"timezone": {
		"code": string,
	}
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
timezone	Timezone	if no error	The requested Timezone

getTimezonesList

Gets a list of Time Zones.

JSON request message structure

getTimezonesList {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getTimezonesListResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number,		/* uint32 format */
	"timezones": [
		{ /* see Timezone for details */ }
	]
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
timezones	array[Timezone]	if no error	The list of timezones.

noop

Does nothing, but keeps the WebSocket connection open in case an idle TCP connections get killed by a network appliance.

JSON request message structure

noop {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

noopResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Assets

getAsset

Gets details of the specified Asset.

JSON request message structure

getAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetResponse {
	"asset": {
		"attributes": {
			string /* codified format */ : {
				"asset": number,		/* uint64 format, see Asset.id */
				"complex": string,
				"dts": string,		/* datetime format */
				"global": boolean,
				"name": string,
				"provider": string,		/* see Provider.id */
				"raw": object,
				"simple": string,
				"unit": string		/* see Units */
			}
		},
		"colour": string,
		"company": number,		/* uint64 format, see Company.id */
		"contact": number,		/* uint64 format, see Contact.id */
		"engineHours": number,		/* double format */
		"icon": number,		/* uint64 format, see Icon.id */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the AssetType values */
		"labels": [
			string
		],
		"make": string,
		"messagingAddress": string,
		"model": string,
		"name": string,
		"notes": string,
		"odometer": number,		/* double format */
		"pictures": [
			number		/* uint64 format */
		],
		"places": {
			string /* uint64 format */ : {
				"enter": string,		/* datetime format */
				"kind": string,		/* one of the AssetPlaceStatusType values */
				"latest": string		/* datetime format */
			}
		},
		"plate": string,
		"position": {
			"accuracy": number,		/* uint32 format */
			"address": string,
			"altitude": number,		/* double format */
			"bearing": number,		/* uint16 format */
			"dts": string,		/* datetime format */
			"lat": number,		/* double format */
			"lng": number,		/* double format */
			"origin": string,
			"speed": number,		/* double format */
			"speedLimit": number,		/* double format */
			"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		/* uint64 format */
		],
		"serial": string,
		"tags": [
			string
		],
		"v": [
			number		/* uint32 format */
		],
		"v[0]": uint32,
		"v[1]": uint32,
		"vin": string,
		"year": number		/* uint16 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	Asset	if no error	The requested asset.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAssetsList

Gets the list of Assets for the specified Company.

JSON request message structure

getAssetsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetsListResponse {
	"assets": [
		{ /* see Asset for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assets	array[Asset]	if no error	The list of assets.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAssetsListByReference

Gets the list of Assets for the specified Company only if one of the Asset reference fields is a match.

JSON request message structure

getAssetsListByReference {
	"company": {
		"id": number		/* uint64 format */
	},
	"reference": string,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reference	string	true	Case-insensitive reference used to match assets.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetsListByReferenceResponse {
	"assets": [
		{ /* see Asset for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reference": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assets	array[Asset]	if no error	The list of assets.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reference	string	if no error	Case-insensitive reference used to match assets.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAssetsListByReferences

Gets the list of Assets for the specified Company only if the specified Asset reference fields match. If no references are specified, it will match any Asset with no references. If a reference value is null, it will match any Asset without that reference key.

JSON request message structure

getAssetsListByReferences {
	"company": {
		"id": number		/* uint64 format */
	},
	"references": {
		string: string,
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
references	object{string:string}	true	An object to contain the references as name/value pairs. All references must match.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetsListByReferencesResponse {
	"assets": [
		{ /* see Asset for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"references": {stringstring,},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assets	array[Asset]	if no error	The list of assets.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
references	object{string:string}	if no error	The pairs of names/values as interpreted by the system for the search.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeAsset

Creates a new or updates an existing Asset.

JSON request message structure

mergeAsset {
	"asset": {
		"attributes": {
			string /* codified format */ : {
				"asset": number,		/* uint64 format, see Asset.id */
				"complex": string,
				"dts": string,		/* datetime format */
				"global": boolean,
				"name": string,
				"provider": string,		/* see Provider.id */
				"raw": object,
				"simple": string,
				"unit": string		/* see Units */
			},
		},
		"colour": string,
		"company": number,		/* uint64 format */
		"contact": number,		/* uint64 format */
		"engineHours": number,		/* double format */
		"icon": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the AssetType values */
		"labels": [
			string		/* codified format */
		],
		"make": string,
		"messagingAddress": string,
		"model": string,
		"name": string,
		"notes": string,
		"odometer": number,		/* double format */
		"pictures": [
			number		/* uint64 format */
		],
		"plate": string,
		"providers": [
			string
		],
		"reference": string,
		"references": {
			string /* codified format */ : string,
		},
		"relationships": [
			number		/* uint64 format */
		],
		"serial": string,
		"tags": [
			string		/* codified format */
		],
		"v": [
			number		/* uint32 format */
		],
		"vin": string,
		"year": number
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	always	A simple object to contain the asset parameters.
asset.attributes	object{string(codified):AssetAttribute}	optional	Allows you to add, remove, and replace attributes. For each AssetAttribute in the attributes object, the value will be replaced on the asset. If value is null, the attribute is removed from the asset. If the key in the attributes object is different from the codified AssetAttribute.name in the object, the attribute of the key is removed from the asset, and one of the codified name is added to the asset. If a new value or null is not provided for a current attribute, no change is made.
asset.colour	string	optional	The pretty-pretty colour of this vehicle or trailer. Only applicable if asset.type is vehicle or trailer.
asset.company	number(uint64)	create	The company to which this asset belongs.
asset.contact	number(uint64)	create	Only applicable if asset.type is person.
asset.engineHours	number(double)	optional	The number of hours the engine has been running for this vehicle. Only applicable if asset.type is vehicle.
asset.icon	number(uint64)	optional	The identifier of the icon used to represent this asset in the UI.
asset.id	number(uint64)	update	The unique identifier of the asset you want to update.
asset.kind	string(AssetType)	create	The kind of thing being created. After creation, this value is read-only.
asset.labels	array[string(codified)]	optional	A list of codified label names to categorize/organize this asset.
asset.make	string	optional	The manufacturer of this vehicle or trailer. Only applicable if asset.type is vehicle or trailer.
asset.messagingAddress	string	optional	The email address or phone number of this asset when a person's contact card is blank, or the provider's PND is not installed.
asset.model	string	optional	The model of this vehicle or trailer. Only applicable if asset.type is vehicle or trailer.
asset.name	string	create	Name for the asset.
asset.notes	string	optional	Notes for the asset.
asset.odometer	number(double)	optional	The distance travelled by this asset. Can be a GPS odometer, OBD-II odometer, or other depending on scripts.
asset.pictures	array[number(uint64)]	optional	The identifiers of pictures of this asset.
asset.plate	string	optional	The license plate of this vehicle or trailer. Only applicable if asset.type is vehicle or trailer.
asset.providers	array[string]	optional	A list of provider identifiers which are providing event data for this asset.
asset.reference Deprecated since v4.12. Use asset.references["Reference"] instead.	string	deprecated	A custom field used to refer this asset an external system.
asset.references	object{string(codified):string}	optional	Name/value collections of custom fields used to refer to external systems.
asset.relationships	array[number(uint64)]	optional	A list of related asset identifiers like a driver for a vehicle, or truck for a person.
asset.serial	string	optional	The manufacturer's identification number of this trailer. Only applicable if asset.type is trailer.
asset.tags	array[string(codified)]	optional	Replaces the asset's status tags with the given list of codified tags.
asset.v	array[number(uint32)]	update	The asset version keys used to validate synchronization.
asset.vin	string	optional	The Vehicle Identification Number of this vehicle. Only applicable if asset.type is vehicle.
asset.year	number	optional	The year this vehicle or trailer was built. Only applicable if asset.type is vehicle or trailer.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	The unique identifier of the asset. When creating, this is the id of the asset created.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeAsset

Deletes an existing Asset.

JSON request message structure

removeAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the keys "id" and "deleted" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
asset.id	number(uint64)	if no error	The unique identifier of the asset.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreAsset

Restores the specified Asset to its previous version.

JSON request message structure

restoreAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the keys "id" and "deleted" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
asset.id	number(uint64)	if no error	The unique identifier of the asset.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

reviveAsset

Revives an Asset from suspended state so that new events are processed (data sent while suspended is ignored).

JSON request message structure

reviveAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

reviveAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"suspended": boolean,
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the keys "id" and "suspended" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	The unique identifier of the asset.
asset.suspended	boolean	if no error	Indicates whether the object is suspended. Value is always false
asset.v	array[number(uint32)]	if no error	The asset version keys at the time of suspension.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

suspendAsset

Suspends an Asset so that no further events are processed for it, but it remains available for historical reports.

JSON request message structure

suspendAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

suspendAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"suspended": boolean,
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the keys "id" and "suspended" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	The unique identifier of the asset.
asset.suspended	boolean	if no error	Indicates whether the object is suspended. Value is always true
asset.v	array[number(uint32)]	if no error	The asset version keys at the time of suspension.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Behaviours

clearBehaviourLogsByAsset

Clears the list of Behaviour Logs for the specified Behaviour Script.

JSON request message structure

clearBehaviourLogsByAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

clearBehaviourLogsByAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object to contain the "id" key.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

clearBehaviourLogsByBehaviour

Clears the list of Behaviour Logs for the specified Behaviour.

JSON request message structure

clearBehaviourLogsByBehaviour {
	"behaviour": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	true	An object to contain the "id" key.
behaviour.id	number(uint64)	true	Unique identifier of the behaviour.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

clearBehaviourLogsByBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"script": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	object	if no error	An object to contain the "id" key.
behaviour.company	number(uint64)	if no error	Unique identifier of the company.
behaviour.id	number(uint64)	if no error	Unique identifier of the behaviour.
behaviour.script	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

clearBehaviourLogsByScript

Clears the list of Behaviour Logs for the specified Behaviour Script.

JSON request message structure

clearBehaviourLogsByScript {
	"behaviourScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	true	An object to contain the "id" key.
behaviourScript.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

clearBehaviourLogsByScriptResponse {
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScript	object	if no error	An object to contain the "id" key.
behaviourScript.company	number(uint64)	if no error	Unique identifier of the company.
behaviourScript.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviour

Gets details of the specified Behaviour.

JSON request message structure

getBehaviour {
	"behaviour": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	true	An object to contain the "id" key.
behaviour.id	number(uint64)	true	Unique identifier of the behaviour.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format, see Company.id */
		"filters": string,		/* expression format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,		/* one of the BehaviourParameterType values */
				"value": string
			}
		},
		"priority": number,		/* uint8 format */
		"script": number,		/* uint64 format, see BehaviourScript.id */
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	Behaviour	if no error	The requested Behaviour.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviourLogsListByAsset

Gets the list of Behaviour Logs for the specified Behaviour Script.

JSON request message structure

getBehaviourLogsListByAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourLogsListByAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"behaviourLogs": [
		{ /* see BehaviourLog for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the script to which the object relates.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the script.
behaviourLogs	array[BehaviourLog]	if no error	The list of BehaviourLogs.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviourLogsListByBehaviour

Gets the list of Behaviour Logs for the specified Behaviour.

JSON request message structure

getBehaviourLogsListByBehaviour {
	"behaviour": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	true	An object to contain the "id" key.
behaviour.id	number(uint64)	true	Unique identifier of the behaviour.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourLogsListByBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"script": number		/* uint64 format */
	},
	"behaviourLogs": [
		{ /* see BehaviourLog for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	object	if no error	An object which contains the "id", "company", and "script" keys when there is no error. The "id" key is the unique identifier of the behaviour to which the array of objects relate.
behaviour.company	number(uint64)	if no error	Unique identifier of the company.
behaviour.id	number(uint64)	if no error	Unique identifier of the behaviour.
behaviour.script	number(uint64)	if no error	Unique identifier of the script.
behaviourLogs	array[BehaviourLog]	if no error	The list of BehaviourLogs.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviourLogsListByScript

Gets the list of Behaviour Logs for the specified Behaviour Script.

JSON request message structure

getBehaviourLogsListByScript {
	"behaviourScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	true	An object to contain the "id" key.
behaviourScript.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourLogsListByScriptResponse {
	"behaviourLogs": [
		{ /* see BehaviourLog for details */ }
	],
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourLogs	array[BehaviourLog]	if no error	The list of BehaviourLogs.
behaviourScript	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the script to which the object relates.
behaviourScript.company	number(uint64)	if no error	Unique identifier of the company.
behaviourScript.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviourScript

Gets details of the specified Behaviour Script.

JSON request message structure

getBehaviourScript {
	"behaviourScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	true	An object to contain the "id" key.
behaviourScript.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourScriptResponse {
	"behaviourScript": {
		"company": number,		/* uint64 format, see Company.id */
		"compiles": boolean,
		"fill": string,
		"filters": string,		/* expression format */
		"global": boolean,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,		/* one of the BehaviourParameterType values */
				"value": string
			}
		},
		"source": string,
		"stroke": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScript	BehaviourScript	if no error	The requested BehaviourScript.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehaviourScriptsList

Gets the list of Behaviour Scripts for the specified Company.

JSON request message structure

getBehaviourScriptsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehaviourScriptsListResponse {
	"behaviourScripts": [
		{ /* see BehaviourScript for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScripts	array[BehaviourScript]	if no error	The list of BehaviourScripts.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBehavioursList

Gets the list of Behaviours for the specified Company.

JSON request message structure

getBehavioursList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBehavioursListResponse {
	"behaviours": [
		{ /* see Behaviour for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviours	array[Behaviour]	if no error	The list of behaviours.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeBehaviour

Creates a new or updates an existing Behaviour.

JSON request message structure

mergeBehaviour {
	"behaviour": {
		"company": number,		/* uint64 format */
		"filters": string,		/* expression format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,		/* one of the BehaviourParameterType values */
				"value": string
			},
		},
		"priority": number,		/* uint8 format */
		"script": number,		/* uint64 format */
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	always	A simple object to contain the behaviour parameters.
behaviour.company	number(uint64)	create	The company to which this behaviour belongs.
behaviour.filters	string(expression)	create	A search pattern used to select the assets which will embed this behaviour in their execution context.
behaviour.id	number(uint64)	update	The unique identifier of the behaviour you want to update.
behaviour.name	string	create	Name for the behaviour.
behaviour.notes	string	optional	Notes for the behaviour.
behaviour.parameters	object{string:BehaviourParameter}	optional	The values needed to implement the script. Each key in this object is the name of a required script argument.
behaviour.priority	number(uint8)	optional	The order in which this behaviour is embedded.
behaviour.script	number(uint64)	create	The identifier of the script being implemented.
behaviour.targets	string(expression)	create	A search pattern used to select the providers which can implement this behaviour.
behaviour.v	array[number(uint32)]	update	The behaviour version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"script": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	object	if no error	An object which contains the "id", "company", and "script" keys when there is no error.
behaviour.company	number(uint64)	if no error	Unique identifier of the company.
behaviour.id	number(uint64)	if no error	Unique identifier of the behaviour.
behaviour.script	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeBehaviourScript

Creates a new or updates an existing Behaviour Script.

JSON request message structure

mergeBehaviourScript {
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"fill": string,
		"filters": string,		/* expression format */
		"global": string,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"context": string,
				"notes": string,
				"type": string,		/* one of the BehaviourParameterType values */
				"value": string
			},
		},
		"source": string,
		"stroke": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	always	A simple object to contain the behaviourScript parameters.
behaviourScript.company	number(uint64)	create	The company to which this script belongs.
behaviourScript.fill	string	optional	Background and fill colour in the UI.
behaviourScript.filters	string(expression)	create	A search pattern used to select the providers.
behaviourScript.global	string	optional	When set to true, this company as well as all child companies will be able to implement this script for that companies assets.
behaviourScript.graphic	string(codified)	optional	The name of the symbol shown in the UI.
behaviourScript.id	number(uint64)	update	The unique identifier of the script you want to update.
behaviourScript.name	string	create	Name for the behaviourScript.
behaviourScript.notes	string	optional	Notes for the behaviourScript.
behaviourScript.parameters	object{string:BehaviourParameter}	optional	The defined arguments for this script. Each key in the object is the name of an argument.
behaviourScript.source	string	create	The raw source code of this script. See further documentation about writing scripts.
behaviourScript.stroke	string	optional	Text and outline colour in the UI.
behaviourScript.v	array[number(uint32)]	update	The script version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeBehaviourScriptResponse {
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScript	object	if no error	An object which contains the "id" and "company" keys when there is no error.
behaviourScript.company	number(uint64)	if no error	Unique identifier of the company.
behaviourScript.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeBehaviour

Deletes an existing Behaviour.

JSON request message structure

removeBehaviour {
	"behaviour": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	true	An object to contain the "id" key.
behaviour.id	number(uint64)	true	Unique identifier of the behaviour.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number,		/* uint64 format */
		"script": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	object	if no error	An object which contains only four keys, and is only present when there is no error.
behaviour.company	number(uint64)	if no error	Unique identifier of the company.
behaviour.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
behaviour.id	number(uint64)	if no error	Unique identifier of the behaviour.
behaviour.script	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeBehaviourScript

Deletes an existing Behaviour Script.

JSON request message structure

removeBehaviourScript {
	"behaviourScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	true	An object to contain the "id" key.
behaviourScript.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeBehaviourScriptResponse {
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScript	object	if no error	An object which contains only three keys, and is only present when there is no error.
behaviourScript.company	number(uint64)	if no error	Unique identifier of the company.
behaviourScript.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
behaviourScript.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreBehaviour

Restores the specified Behaviour to its previous version.

JSON request message structure

restoreBehaviour {
	"behaviour": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviour	object	true	An object to contain the "id" key.
behaviour.id	number(uint64)	true	Unique identifier of the behaviour.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreBehaviourResponse {
	"behaviour": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number,		/* uint64 format */
		"script": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviour	object	if no error	An object which contains only four keys, and is only present when there is no error.
behaviour.company	number(uint64)	if no error	Unique identifier of the company.
behaviour.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
behaviour.id	number(uint64)	if no error	Unique identifier of the behaviour.
behaviour.script	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreBehaviourScript

Restores the specified Behaviour Script to its previous version.

JSON request message structure

restoreBehaviourScript {
	"behaviourScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
behaviourScript	object	true	An object to contain the "id" key.
behaviourScript.id	number(uint64)	true	Unique identifier of the script.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreBehaviourScriptResponse {
	"behaviourScript": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
behaviourScript	object	if no error	An object which contains only three keys, and is only present when there is no error.
behaviourScript.company	number(uint64)	if no error	Unique identifier of the company.
behaviourScript.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
behaviourScript.id	number(uint64)	if no error	Unique identifier of the script.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Billing

getBillingProfile

Gets details of the specified Billing Profile.

JSON request message structure

getBillingProfile {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBillingProfileResponse {
	"billingProfile": {
		"billee": number,		/* uint64 format, see Company.id */
		"company": number,		/* uint64 format, see Company.id */
		"currency": string,		/* one of the BillingCurrency values */
		"cycle": string,		/* one of the BillingCycle values */
		"cycleEnd": string,		/* datetime format */
		"cyclePostDated": boolean,
		"cycleStart": string,		/* datetime format */
		"googleServicesEnabled": boolean,
		"id": number,		/* uint64 format */
		"messages": [
			{
				"amount": number,		/* double format */
				"limit": number		/* uint32 format */
			}
		],
		"name": string,
		"notes": string,
		"target": number,		/* uint64 format, see Company.id */
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	BillingProfile	if no error	The requested Billing Profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBillingProfilesList

Gets the list of Billing Profiles for the specified Company.

JSON request message structure

getBillingProfilesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBillingProfilesListResponse {
	"billingProfiles": [
		{ /* see BillingProfile for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfiles	array[BillingProfile]	if no error	The list of Billing Profiles.
company	object	if no error	An object which contains key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBillingReport

Gets details of the specified Billing Report.

JSON request message structure

getBillingReport {
	"billingReport": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingReport	object	true	An object to contain the "id" key.
billingReport.id	number(uint64)	true	Unique identifier of the billing report.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBillingReportResponse {
	"billingReport": {
		"billee": number,		/* uint64 format, see Company.id */
		"company": number,		/* uint64 format, see Company.id */
		"currency": string,		/* one of the BillingCurrency values */
		"endDate": string,		/* datetime format */
		"hostingBreakdown": {
			string: array
		},
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"profile": number,		/* uint64 format, see BillingProfile.id */
		"startDate": string,		/* datetime format */
		"status": ErrorCodes,
		"summary": [
			{
				"hostingSummary": [
					{
						"count": number,		/* double format */
						"kind": string,		/* one of the BillableHostingType values */
						"total": number		/* double format */
					}
				],
				"name": string,
				"notes": string,
				"parent": number,		/* uint64 format, see Company.id */
				"target": number		/* uint64 format, see Company.id */
			}
		],
		"total": number,		/* double format */
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingReport	BillingReport	if no error	The requested Billing Report.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBillingReportsList

Gets the list of Billing Reports for the specified Profile.

JSON request message structure

getBillingReportsList {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBillingReportsListResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"billingReports": [
		{ /* see BillingReport for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the billing profile to which the array of objects relate.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
billingReports	array[BillingReport]	if no error	The list of Billing Reports.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getBillingReportsListByCompany

Gets the list of Billing Reports for all the Profiles in the specified Company.

JSON request message structure

getBillingReportsListByCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getBillingReportsListByCompanyResponse {
	"billingReports": [
		{ /* see BillingReport for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingReports	array[BillingReport]	if no error	The list of Billing Reports.
company	object	if no error	An object which contains key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingDiscount

Gets details of the specified Billable Hosting Discount.

JSON request message structure

getHostingDiscount {
	"hostingDiscount": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingDiscount	object	true	An object to contain the "id" key.
hostingDiscount.id	number(uint64)	true	Unique identifier of the hosting discount.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingDiscountResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingDiscount": {
		"amount": number,		/* double format */
		"company": number,		/* uint64 format, see Company.id */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"percentage": boolean,
		"profile": number,		/* uint64 format, see BillingProfile.id */
		"reference": string,
		"services": [
			string		/* one of the BillableHostingType values */
		],
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingDiscount	BillableHostingDiscount	if no error	The requested Hosting Discount.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingDiscountsList

Gets the list of Billable Hosting Discounts for the specified Billing Profile.

JSON request message structure

getHostingDiscountsList {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingDiscountsListResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingDiscounts": [
		{ /* see BillableHostingDiscount for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains key "id" when there is no error. The "id" key is the unique identifier of the billing profile to which the array of objects relate.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingDiscounts	array[BillableHostingDiscount]	if no error	The list of Hosting Discounts.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingLicense

Gets details of the specified Billable Hosting License.

JSON request message structure

getHostingLicense {
	"hostingLicense": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingLicense	object	true	An object to contain the "id" key.
hostingLicense.id	number(uint64)	true	Unique identifier of the hosting license.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingLicenseResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingLicense": {
		"amount": number,		/* double format */
		"company": number,		/* uint64 format, see Company.id */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the BillableLicenseType values */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"profile": number,		/* uint64 format, see BillingProfile.id */
		"reference": string,
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingLicense	BillableHostingLicense	if no error	The requested Hosting License.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingLicensesList

Gets the list of Billable Hosting Licenses for the specified Billing Profile.

JSON request message structure

getHostingLicensesList {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingLicensesListResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingLicenses": [
		{ /* see BillableHostingLicense for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains key "id" when there is no error. The "id" key is the unique identifier of the billing profile to which the array of objects relate.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingLicenses	array[BillableHostingLicense]	if no error	The list of Hosting Licenses.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingRule

Gets details of the specified Billable Hosting Rule.

JSON request message structure

getHostingRule {
	"hostingRule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingRule	object	true	An object to contain the "id" key.
hostingRule.id	number(uint64)	true	Unique identifier of the hosting rule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingRuleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingRule": {
		"amount": number,		/* double format */
		"company": number,		/* uint64 format, see Company.id */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"profile": number,		/* uint64 format, see BillingProfile.id */
		"reference": string,
		"service": string,		/* one of the BillableHostingType values */
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingRule	BillableHostingRule	if no error	The requested Hosting Rule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHostingRulesList

Gets the list of Billable Hosting Rules for the specified Billing Profile.

JSON request message structure

getHostingRulesList {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHostingRulesListResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingRules": [
		{ /* see BillableHostingRule for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains key "id" when there is no error. The "id" key is the unique identifier of the billing profile to which the array of objects relate.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingRules	array[BillableHostingRule]	if no error	The list of Hosting Rules.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeBillingProfile

Creates new or updates an existing Billing Profile.

JSON request message structure

mergeBillingProfile {
	"billingProfile": {
		"billee": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"currency": string,		/* one of the BillingCurrency values */
		"cycle": string,		/* one of the BillingCycle values */
		"cycleEnd": string,		/* datetime format */
		"cyclePostDated": boolean,
		"cycleStart": string,		/* datetime format */
		"googleServicesEnabled": boolean,
		"id": number,		/* uint64 format */
		"messages": [
			{
				"amount": number,		/* double format */
				"limit": number		/* uint32 format */
			}
		],
		"name": string,
		"notes": string,
		"target": number,		/* uint64 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	always	A simple object to contain the billing profile parameters.
billingProfile.billee	number(uint64)	create	Unique identifier of the company receiving the bill.
billingProfile.company	number(uint64)	create	Unique identifier of the company that owns this profile and is sending the bill.
billingProfile.currency	string(BillingCurrency)	optional	Kind of money
billingProfile.cycle	string(BillingCycle)	optional	Repeating cycle used for generating bills
billingProfile.cycleEnd	string(datetime)	optional	When should the cycle end (customer cancelled); null means it never ends.
billingProfile.cyclePostDated	boolean	optional	Pro-rated, or post-dated.
billingProfile.cycleStart	string(datetime)	optional	When is the first day of the billing cycle.
billingProfile.googleServicesEnabled	boolean	optional	Are the Google services available to be proxied by the service?
billingProfile.id	number(uint64)	update	The unique identifier of the billing profile you want to update.
billingProfile.messages	array[BillableSmsProfile]	optional	SMS messaging tiers.
billingProfile.name	string	optional	Name.
billingProfile.notes	string	optional	Notes.
billingProfile.target	number(uint64)	create	Unique identifier of the company to which this rule pertains.
billingProfile.v	array[number(uint32)]	update	The billing profile version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeBillingProfileResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains the "id" and "company" keys when there is no error.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeHostingDiscount

Creates a new or updates an existing Hosting Discount.

JSON request message structure

mergeHostingDiscount {
	"hostingDiscount": {
		"amount": number,		/* double format */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"percentage": boolean,
		"profile": number,		/* uint64 format */
		"reference": string,
		"services": [
			string		/* one of the BillableHostingType values */
		],
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingDiscount	object	always	A simple object to contain the hosting Discount parameters.
hostingDiscount.amount	number(double)	optional	Cost per cycle for this plan.
hostingDiscount.end	string(datetime)	optional	Date this billing discount is applied until; null means it never ends.
hostingDiscount.id	number(uint64)	update	The unique identifier of the hosting discount you want to update.
hostingDiscount.limit	number(uint32)	optional	The number of units to which this billing discount applies; null means unlimited
hostingDiscount.name	string	optional	Name.
hostingDiscount.notes	string	optional	Notes.
hostingDiscount.percentage	boolean	optional	When true, the amount is used as a percentage value instead of a currency values.
hostingDiscount.profile	number(uint64)	create	The billing profile to which this hosting discount belongs.
hostingDiscount.reference	string	optional	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingDiscount.services	array[string(BillableHostingType)]	optional	The types of service being discounted.
hostingDiscount.start	string(datetime)	optional	Date this billing discount takes effect.
hostingDiscount.suspended	boolean	optional	Does this hosting discount apply to suspended resources.
hostingDiscount.targets	string(expression)	optional	Which assets are targetted by this hosting discount.
hostingDiscount.v	array[number(uint32)]	update	The hosting discount version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeHostingDiscountResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingDiscount": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"profile": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingDiscount	object	if no error	An object which contains the "id" and "company" keys when there is no error.
hostingDiscount.company	number(uint64)	if no error	Unique identifier of the company.
hostingDiscount.id	number(uint64)	if no error	Unique identifier of the hosting discount.
hostingDiscount.profile	number(uint64)	if no error	Unique identifier of the billing profile.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeHostingLicense

Creates a new or updates an existing Hosting License.

JSON request message structure

mergeHostingLicense {
	"hostingLicense": {
		"amount": number,		/* double format */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the BillableLicenseType values */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"profile": number,		/* uint64 format */
		"reference": string,
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingLicense	object	always	A simple object to contain the hosting license parameters.
hostingLicense.amount	number(double)	optional	Cost per cycle for this plan.
hostingLicense.end	string(datetime)	optional	Date this billing license is applied until; null means it never ends.
hostingLicense.id	number(uint64)	update	The unique identifier of the hosting license you want to update.
hostingLicense.kind	string(BillableLicenseType)	create	The type of hardware license.
hostingLicense.limit	number(uint32)	optional	The number of units to which this billing license applies; null means unlimited
hostingLicense.name	string	optional	Name.
hostingLicense.notes	string	optional	Notes.
hostingLicense.profile	number(uint64)	create	The billing profile to which this hosting license belongs.
hostingLicense.reference	string	optional	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingLicense.start	string(datetime)	optional	Date this billing license takes effect.
hostingLicense.suspended	boolean	optional	Does this hosting license apply to suspended resources.
hostingLicense.targets	string(expression)	optional	Which assets are targetted by this hosting license.
hostingLicense.v	array[number(uint32)]	update	The hosting Llicense version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeHostingLicenseResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingLicense": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"profile": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingLicense	object	if no error	An object which contains the "id" and "company" keys when there is no error.
hostingLicense.company	number(uint64)	if no error	Unique identifier of the company.
hostingLicense.id	number(uint64)	if no error	Unique identifier of the hosting license.
hostingLicense.profile	number(uint64)	if no error	Unique identifier of the billing profile.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeHostingRule

Creates a new or updates an existing Hosting Rule.

JSON request message structure

mergeHostingRule {
	"hostingRule": {
		"amount": number,		/* double format */
		"end": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"limit": number,		/* uint32 format */
		"name": string,
		"notes": string,
		"profile": number,		/* uint64 format */
		"reference": string,
		"service": string,		/* one of the BillableHostingType values */
		"start": string,		/* datetime format */
		"suspended": boolean,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingRule	object	always	A simple object to contain the hosting rule parameters.
hostingRule.amount	number(double)	optional	Cost per cycle for this plan.
hostingRule.end	string(datetime)	optional	Date this billing rule is applied until; null means it never ends.
hostingRule.id	number(uint64)	update	The unique identifier of the hosting rule you want to update.
hostingRule.limit	number(uint32)	optional	The number of units to which this billing rule applies; null means unlimited
hostingRule.name	string	optional	Name.
hostingRule.notes	string	optional	Notes.
hostingRule.profile	number(uint64)	create	The billing profile to which this hosting rule belongs.
hostingRule.reference	string	optional	A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans...
hostingRule.service	string(BillableHostingType)	create	The type of service being billed.
hostingRule.start	string(datetime)	optional	Date this billing rule takes effect.
hostingRule.suspended	boolean	optional	Does this hosting rule apply to suspended resources.
hostingRule.targets	string(expression)	optional	Which assets are targetted by this hosting rule.
hostingRule.v	array[number(uint32)]	update	The hosting rule version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeHostingRuleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingRule": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"profile": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingRule	object	if no error	An object which contains the "id" and "company" keys when there is no error.
hostingRule.company	number(uint64)	if no error	Unique identifier of the company.
hostingRule.id	number(uint64)	if no error	Unique identifier of the hosting rule.
hostingRule.profile	number(uint64)	if no error	Unique identifier of the billing profile.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeBillingProfile

Deletes an existing Billing Profile.

JSON request message structure

removeBillingProfile {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeBillingProfileResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains only three keys, and is only present when there is no error.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeBillingReport

Deletes an existing Billing Report.

JSON request message structure

removeBillingReport {
	"billingReport": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingReport	object	true	An object to contain the "id" key.
billingReport.id	number(uint64)	true	Unique identifier of the billing report.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeBillingReportResponse {
	"billingReport": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingReport	object	if no error	An object which contains only three keys, and is only present when there is no error.
billingReport.company	number(uint64)	if no error	Unique identifier of the company.
billingReport.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
billingReport.id	number(uint64)	if no error	Unique identifier of the billing report.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeHostingDiscount

Deletes an existing Billable Hosting Discount.

JSON request message structure

removeHostingDiscount {
	"hostingDiscount": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingDiscount	object	true	An object to contain the "id" key.
hostingDiscount.id	number(uint64)	true	Unique identifier of the hosting discount.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeHostingDiscountResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingDiscount": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingDiscount	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingDiscount.company	number(uint64)	if no error	Unique identifier of the company.
hostingDiscount.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
hostingDiscount.id	number(uint64)	if no error	Unique identifier of the hosting discount.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeHostingLicense

Deletes an existing Billable Hosting License.

JSON request message structure

removeHostingLicense {
	"hostingLicense": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingLicense	object	true	An object to contain the "id" key.
hostingLicense.id	number(uint64)	true	Unique identifier of the hosting license.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeHostingLicenseResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingLicense": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingLicense	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingLicense.company	number(uint64)	if no error	Unique identifier of the company.
hostingLicense.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
hostingLicense.id	number(uint64)	if no error	Unique identifier of the hosting license.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeHostingRule

Deletes an existing Billable Hosting Rule.

JSON request message structure

removeHostingRule {
	"hostingRule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingRule	object	true	An object to contain the "id" key.
hostingRule.id	number(uint64)	true	Unique identifier of the hosting rule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeHostingRuleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingRule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingRule	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingRule.company	number(uint64)	if no error	Unique identifier of the company.
hostingRule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
hostingRule.id	number(uint64)	if no error	Unique identifier of the hosting rule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreBillingProfile

Restores the specified Billing Profile to its previous version.

JSON request message structure

restoreBillingProfile {
	"billingProfile": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingProfile	object	true	An object to contain the "id" key.
billingProfile.id	number(uint64)	true	Unique identifier of the billing profile.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreBillingProfileResponse {
	"billingProfile": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingProfile	object	if no error	An object which contains only three keys, and is only present when there is no error.
billingProfile.company	number(uint64)	if no error	Unique identifier of the company.
billingProfile.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
billingProfile.id	number(uint64)	if no error	Unique identifier of the billing profile.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreBillingReport

Restores the specified Billing Report to its previous version.

JSON request message structure

restoreBillingReport {
	"billingReport": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
billingReport	object	true	An object to contain the "id" key.
billingReport.id	number(uint64)	true	Unique identifier of the billing report.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreBillingReportResponse {
	"billingReport": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
billingReport	object	if no error	An object which contains only three keys, and is only present when there is no error.
billingReport.company	number(uint64)	if no error	Unique identifier of the company.
billingReport.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
billingReport.id	number(uint64)	if no error	Unique identifier of the billing report.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreHostingDiscount

Restores the specified Billable Hosting Discount to its previous version.

JSON request message structure

restoreHostingDiscount {
	"hostingDiscount": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingDiscount	object	true	An object to contain the "id" key.
hostingDiscount.id	number(uint64)	true	Unique identifier of the hosting discount.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreHostingDiscountResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingDiscount": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingDiscount	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingDiscount.company	number(uint64)	if no error	Unique identifier of the company.
hostingDiscount.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
hostingDiscount.id	number(uint64)	if no error	Unique identifier of the hosting discount.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreHostingLicense

Restores the specified Billable Hosting License to its previous version.

JSON request message structure

restoreHostingLicense {
	"hostingLicense": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingLicense	object	true	An object to contain the "id" key.
hostingLicense.id	number(uint64)	true	Unique identifier of the hosting license.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreHostingLicenseResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingLicense": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingLicense	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingLicense.company	number(uint64)	if no error	Unique identifier of the company.
hostingLicense.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
hostingLicense.id	number(uint64)	if no error	Unique identifier of the hosting license.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreHostingRule

Restores the specified Billable Hosting Rule to its previous version.

JSON request message structure

restoreHostingRule {
	"hostingRule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hostingRule	object	true	An object to contain the "id" key.
hostingRule.id	number(uint64)	true	Unique identifier of the hosting rule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreHostingRuleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hostingRule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hostingRule	object	if no error	An object which contains only three keys, and is only present when there is no error.
hostingRule.company	number(uint64)	if no error	Unique identifier of the company.
hostingRule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
hostingRule.id	number(uint64)	if no error	Unique identifier of the hosting rule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Companies

getCompaniesList

Gets the list of child Companies for the specified Company.

JSON request message structure

getCompaniesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getCompaniesListResponse {
	"companies": [
		{ /* see CompanyGeneral for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
companies	array[CompanyGeneral]	if no error	The list of CompanyGenerals.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getCompany

Gets details of the specified Company.

JSON request message structure

getCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getCompanyResponse {
	"company": {
		"id": number,		/* uint64 format */
		"labels": {
			string /* LabelStyle format */ : {
				"code": string,		/* codified format */
				"fill": string,
				"graphic": string,		/* codified format */
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"name": string,
		"notes": string,
		"parent": number,		/* uint64 format, see Company.id */
		"passwordPolicy": {
			"expireMode": string,		/* one of the ExpiryModePolicy values */
			"expireThreshold": number,		/* uint8 format */
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number		/* uint8 format */
		},
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,		/* uint16 format */
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string		/* ipv4 format */
			],
			"maxSessions": number,		/* uint8 format */
			"multiUser": string		/* one of the MultiUserPolicy values */
		},
		"tags": {
			string /* LabelStyle format */ : {
				"code": string,		/* codified format */
				"fill": string,
				"graphic": string,		/* codified format */
				"name": string,
				"notes": string,
				"stroke": string
			}
		},
		"userGroups": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"id": number,		/* uint64 format */
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,		/* uint64 format, see Company.id */
						"labels": [
							string		/* see LabelStyle.code */
						],
						"level": string,		/* one of the PermissionLevel values */
						"method": string,		/* one of the PermissionMethod values */
						"type": string		/* one of the PermissionType values */
					}
				],
				"v": [
					number		/* uint32 format */
				]
			}
		],
		"v": [
			number		/* uint32 format */
		],
		"v[0]": uint32,
		"v[1]": uint32,
		"v[2]": uint32,
		"v[3]": uint32,
		"v[4]": uint32,
		"v[5]": uint32
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	Company	if no error	The requested company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeCompany

Creates a new or updates an existing Company.

JSON request message structure

mergeCompany {
	"company": {
		"billing": {
			"bundles": [
				BillingBundle
			],
			"policy": [
				BillingRule
			]
		},
		"id": number,		/* uint64 format */
		"labels": [
			{
				"code": string,		/* codified format */
				"fill": string,
				"graphic": string,		/* codified format */
				"name": string,
				"notes": string,
				"stroke": string
			}
		],
		"name": string,
		"notes": string,
		"parent": number,		/* uint64 format */
		"passwordPolicy": {
			"expireMode": string,		/* one of the ExpiryModePolicy values */
			"expireThreshold": number,		/* uint8 format */
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number		/* uint8 format */
		},
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,		/* uint16 format */
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string		/* ipv4 format */
			],
			"maxSessions": number,		/* uint8 format */
			"multiUser": string		/* one of the MultiUserPolicy values */
		},
		"tags": [
			{
				"code": string,		/* codified format */
				"fill": string,
				"graphic": string,		/* codified format */
				"name": string,
				"notes": string,
				"stroke": string
			}
		],
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	always	A simple object to contain the company parameters.
company.billing	object	optional	An object that when present, will overwrite all policy and bunde information.
company.billing.bundles	array[BillingBundle]	optional	A list of bundled rules to provide a discount when a child company orders multiple services.
company.billing.policy	array[BillingRule]	optional	The list of default billing rules used to calculate the monthly invoice.
company.id	number(uint64)	update	The unique identifier of the company you want to update.
company.labels	array[LabelStyle]	optional	A list of label styles used to categorize/organize this company. The codified names of labels must be unique.
company.name	string	create	Name for the company.
company.notes	string	optional	Notes for the company.
company.parent	number(uint64)	create	The unique identifier of the parent-organization's company.
company.passwordPolicy	PasswordPolicy	optional	The password complexity and expiry policy for this company.
company.sessionPolicy	SessionPolicy	optional	The session lifetime policy for this company.
company.tags	array[LabelStyle]	optional	A list of tag styles used to create context for assets in the field. The codified names of tags must be unique.
company.v	array[number(uint32)]	update	The company version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeCompanyResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeCompany

Deletes an existing Company. Deleting a Company is permanent, and cannot be undone.
After deletion, all data is purged from the system within 24 hours.

JSON request message structure

removeCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	always	A simple object to contain the company parameters.
company.id	number(uint64)	update	The unique identifier of the company you want to update.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeCompanyResponse {
	"company": {
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error.
company.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreCompany

Restores a deleted Company. Restoration can only be done within one hour of deletion.
After deletion, all data is purged from the system within 24 hours.

JSON request message structure

restoreCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	always	A simple object to contain the company parameters.
company.id	number(uint64)	update	The unique identifier of the company you want to update.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreCompanyResponse {
	"company": {
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error.
company.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Contacts

getContact

Gets details of the specified Contact.

JSON request message structure

getContact {
	"contact": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
contact	object	true	An object to contain the "id" key.
contact.id	number(uint64)	true	Unique identifier of the contact.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getContactResponse {
	"contact": {
		"addresses": {
			string: string		/* email format */
		},
		"company": number,		/* uint64 format, see Company.id */
		"dates": {
			string: string		/* datetime format */
		},
		"emails": {
			string: string		/* email format */
		},
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"options": {
			string: string
		},
		"otherNames": {
			string: string
		},
		"phones": {
			string: number		/* uint64 format */
		},
		"pictures": [
			number		/* uint64 format */
		],
		"roles": [
			string		/* codified format */
		],
		"urls": {
			string: string
		},
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
contact	Contact	if no error	The requested Contact.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getContactsList

Gets the list of Contacts for the specified Company.

JSON request message structure

getContactsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getContactsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"contacts": [
		{ /* see Contact for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
contacts	array[Contact]	if no error	The list of contacts.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeContact

Creates a new or updates an existing Contact.

JSON request message structure

mergeContact {
	"contact": {
		"address": string,
		"company": number,		/* uint64 format */
		"email": string,		/* email format */
		"id": number,		/* uint64 format */
		"mobile": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"phone": number,		/* uint64 format */
		"pictures": [
			number		/* uint64 format */
		],
		"roles": [
			string
		],
		"url": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
contact	object	always	A simple object to contain the contact parameters.
contact.address	string	optional	The street address of this contact.
contact.company	number(uint64)	create	The company to which this contact belongs.
contact.email	string(email)	optional	The email address of this contact.
contact.id	number(uint64)	update	The unique identifier of the contact you want to update.
contact.mobile	number(uint64)	optional	The mobile/cellular phone number for this contact.
contact.name	string	create	Name for the contact.
contact.notes	string	optional	Notes for the contact.
contact.phone	number(uint64)	optional	The work/home phone number for this contact.
contact.pictures	array[number(uint64)]	optional	The identifiers of pictures of this contact.
contact.roles	array[string]	optional	A list of strings describing the types of roles for this contact.
contact.url	string	optional	The website for this contact.
contact.v	array[number(uint32)]	update	The contact version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeContactResponse {
	"contact": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
contact	object	if no error	An object which contains the "id" and "company" keys when there is no error.
contact.company	number(uint64)	if no error	Unique identifier of the company.
contact.id	number(uint64)	if no error	Unique identifier of the contact.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeContact

Deletes an existing Contact.

JSON request message structure

removeContact {
	"contact": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
contact	object	true	An object to contain the "id" key.
contact.id	number(uint64)	true	Unique identifier of the contact.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeContactResponse {
	"contact": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
contact	object	if no error	An object which contains only three keys, and is only present when there is no error.
contact.company	number(uint64)	if no error	Unique identifier of the company.
contact.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
contact.id	number(uint64)	if no error	Unique identifier of the contact.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreContact

Restores the specified Contact to its previous version.

JSON request message structure

restoreContact {
	"contact": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
contact	object	true	An object to contain the "id" key.
contact.id	number(uint64)	true	Unique identifier of the contact.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreContactResponse {
	"contact": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
contact	object	if no error	An object which contains only three keys, and is only present when there is no error.
contact.company	number(uint64)	if no error	Unique identifier of the company.
contact.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
contact.id	number(uint64)	if no error	Unique identifier of the contact.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Dispatch

getDispatchTask

Gets details of the specified Dispatch Task.

JSON request message structure

getDispatchTask {
	"dispatchTask": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
dispatchTask	object	true	An object to contain the "id" key.
dispatchTask.id	number(uint64)	true	Unique identifier of the task.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDispatchTaskResponse {
	"dispatchTask": {
		"address": string,
		"arrived": string,		/* datetime format */
		"asset": number,		/* uint64 format, see Asset.id */
		"attachments": [
			number		/* uint64 format */
		],
		"company": number,		/* uint64 format, see Company.id */
		"completed": string,		/* datetime format */
		"created": string,		/* datetime format */
		"duration": string,		/* duration format */
		"eta": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"instructions": string,
		"latlng": {
			"lat": number,		/* double format */
			"lng": number		/* double format */
		},
		"name": string,
		"notes": string,
		"place": number,		/* uint64 format, see Place.id */
		"reference": string,
		"references": {
			string: string
		},
		"signatory": string,
		"signature": boolean,
		"status": string,		/* one of the TaskStatus values */
		"updatedBy": string,
		"updatedUtc": string,		/* datetime format */
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
dispatchTask	DispatchTask	if no error	The requested task.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getDispatchTasksList

Gets the list of Dispatch Tasks for the specified Asset.

JSON request message structure

getDispatchTasksList {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDispatchTasksListResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"dispatchTasks": [
		{ /* see DispatchTask for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the asset to which the array of objects relate.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the asset.
dispatchTasks	array[DispatchTask]	if no error	The list of tasks.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getDispatchTasksListByCompany

Gets the list of Dispatch Tasks for the all the Assets in the specified Company.

JSON request message structure

getDispatchTasksListByCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDispatchTasksListByCompanyResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"dispatchTasks": [
		{ /* see DispatchTask for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
dispatchTasks	array[DispatchTask]	if no error	The list of tasks.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getDispatchTasksListByReference

Gets the list of Dispatch Tasks for the specified Asset.

JSON request message structure

getDispatchTasksListByReference {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reference": string,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reference	string	true	Case-insensitive reference used to match assets.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDispatchTasksListByReferenceResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"dispatchTasks": [
		{ /* see DispatchTask for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reference": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the asset.
dispatchTasks	array[DispatchTask]	if no error	The list of tasks.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reference	string	if no error	Case-insensitive reference used to match assets.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getDispatchTasksListByReferences

Gets the list of Dispatch Tasks for the specified Asset only if the specified Task reference fields match. If no references are specified, it will match any Task with no references. If a reference value is null, it will match any Task without that reference key.

JSON request message structure

getDispatchTasksListByReferences {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reference": string,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reference	string	true	Case-insensitive reference used to match assets.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDispatchTasksListByReferencesResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"dispatchTasks": [
		{ /* see DispatchTask for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"references": {stringstring,},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the asset.
dispatchTasks	array[DispatchTask]	if no error	The list of tasks.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
references	object{string:string}	if no error	The pairs of names/values as interpreted by the system for the search.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeDispatchTask

Creates a new or updates an existing DispatchTask.

JSON request message structure

mergeDispatchTask {
	"dispatchTask": {
		"address": string,
		"asset": number,		/* uint64 format */
		"attachments": [
			number		/* uint32 format */
		],
		"company": number,		/* uint64 format */
		"duration": string,		/* duration format */
		"eta": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"instructions": string,
		"latlng": {
			"lat": number,		/* double format */
			"lng": number		/* double format */
		},
		"name": string,
		"notes": string,
		"place": number,		/* uint64 format */
		"reference": string,
		"references": {
			string /* codified format */ : string,
		},
		"status": string,		/* one of the TaskStatus values */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
dispatchTask	object	always	A simple object to contain the dispatchTask parameters.
dispatchTask.address	string	create (conditional)	The street address of this task. Condition: You must provide a place, a latlng, or an address. Note: If you ommit the address, the geocoder attempts to populate the field, but will not return an error if it fails.
dispatchTask.asset	number(uint64)	create	The identifier of the asset assigned for this task.
dispatchTask.attachments	array[number(uint32)]	optional	A list of Documents to attach to this task for both driver and dispatcher review.
dispatchTask.company	number(uint64)	create	The company to which this task belongs.
dispatchTask.duration	string(duration)	optional	The duration on site, or how much time is expected to complete the task. Used to help calculate other task ETAs when routing is performed.
dispatchTask.eta	string(datetime)	optional	Estimated time of arrival.
dispatchTask.id	number(uint64)	update	The unique identifier of the task you want to update.
dispatchTask.instructions	string	optional	Instructions for the driver to help them complete the task. Such as which door to use, a buzz code to enter the facility, etc...
dispatchTask.latlng	LatLng	create (conditional)	The lat/long coordinates of the street address. Condition: You must provide a place, a latlng, or an address. Note: If you invoke the geocoder, the address is also replaced with the geocoded value.
dispatchTask.name	string	optional	Name for the task.
dispatchTask.notes	string	optional	Notes completed by the driver about the task. Such as service notes, damaged goods upon pick-up, etc...
dispatchTask.place	number(uint64)	create (conditional)	An optional identifier of a place for this task. Using a place makes detecting the "arrived" status more reliable. Condition: You must provide a place, a latlng, or an address. Note: If you invoke the geocoder, the address is also replaced with the geocoded value.
dispatchTask.reference Deprecated since v4.12.	string	deprecated	A custom field used to refer this dispatchTask an external system. Examples are a work order, pick-up, waybill, etc... Since v4.13 this value operates as the "Reference" key on the references object.
dispatchTask.references	object{string(codified):string}	optional	A custom field used to refer this dispatchTask an external system. Examples are a work order, pick-up, waybill, etc... If value is null, the field is removed from the DispatchTask. If a new value or null is not provided for a current attribute, no change is made.
dispatchTask.status	string(TaskStatus)	optional	Tasks have a lifetime and each status represents a task's progress through it's life.
dispatchTask.v	array[number(uint32)]	update	The task version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeDispatchTaskResponse {
	"dispatchTask": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
dispatchTask	object	if no error	An object which contains only one key "id" when there is no error.
dispatchTask.asset	number(uint64)	if no error	Unique identifier of the asset.
dispatchTask.company	number(uint64)	if no error	Unique identifier of the company.
dispatchTask.id	number(uint64)	if no error	Unique identifier of the task.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeDispatchTask

Deletes an existing Dispatch Task.

JSON request message structure

removeDispatchTask {
	"dispatchTask": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
dispatchTask	object	true	An object to contain the "id" key.
dispatchTask.id	number(uint64)	true	Unique identifier of the task.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeDispatchTaskResponse {
	"dispatchTask": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
dispatchTask	object	if no error	An object which contains only four keys, and is only present when there is no error.
dispatchTask.asset	number(uint64)	if no error	Unique identifier of the asset.
dispatchTask.company	number(uint64)	if no error	Unique identifier of the company.
dispatchTask.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
dispatchTask.id	number(uint64)	if no error	Unique identifier of the task.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreDispatchTask

Restores an deleted Dispatch Task.

JSON request message structure

restoreDispatchTask {
	"dispatchTask": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
dispatchTask	object	true	An object to contain the "id" key.
dispatchTask.id	number(uint64)	true	Unique identifier of the task.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreDispatchTaskResponse {
	"dispatchTask": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
dispatchTask	object	if no error	An object which contains only four keys, and is only present when there is no error.
dispatchTask.asset	number(uint64)	if no error	Unique identifier of the asset.
dispatchTask.company	number(uint64)	if no error	Unique identifier of the company.
dispatchTask.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
dispatchTask.id	number(uint64)	if no error	Unique identifier of the task.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

File Hosting

getDocument

Gets details of the specified Document.

JSON request message structure

getDocument {
	"document": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
document	object	true	An object to contain the "id" key.
document.id	number(uint64)	true	Unique identifier of the document.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDocumentResponse {
	"document": {
		"bytes": number,		/* uint64 format */
		"company": number,		/* uint64 format, see Company.id */
		"expiry": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"mime": string,
		"name": string,
		"notes": string,
		"src": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
document	Document	if no error	The requested document.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getDocumentsList

Gets the list of Documents for the specified Asset.

JSON request message structure

getDocumentsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getDocumentsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"documents": [
		{ /* see Document for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
documents	array[Document]	if no error	The list of documents.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeDocument

Updates an existing Document. You cannot use the WebSocket to create new Documents, for that you need to use the Files API.

JSON request message structure

mergeDocument {
	"document": {
		"expiry": string,		/* datetime format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
document	object	always	A simple object to contain the document parameters.
document.expiry	string(datetime)	optional	The time at which the document will automatically be purged from the system.
document.id	number(uint64)	update	The unique identifier of the document you want to update.
document.name	string	optional	Name for the document.
document.notes	string	optional	Notes about the document.
document.v	array[number(uint32)]	update	The document version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeDocumentResponse {
	"document": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
document	object	if no error	An object which contains only one key "id" when there is no error.
document.company	number(uint64)	if no error	Unique identifier of the company.
document.id	number(uint64)	if no error	Unique identifier of the document.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeDocument

Deletes an existing Document.

JSON request message structure

removeDocument {
	"document": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
document	object	true	An object to contain the "id" key.
document.id	number(uint64)	true	Unique identifier of the document.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeDocumentResponse {
	"document": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
document	object	if no error	An object which contains only four keys, and is only present when there is no error.
document.company	number(uint64)	if no error	Unique identifier of the company to which the document belonged.
document.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
document.id	number(uint64)	if no error	Unique identifier of the document.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreDocument

Restores an deleted Document.

JSON request message structure

restoreDocument {
	"document": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
document	object	true	An object to contain the "id" key.
document.id	number(uint64)	true	Unique identifier of the document.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreDocumentResponse {
	"document": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
document	object	if no error	An object which contains only four keys, and is only present when there is no error.
document.company	number(uint64)	if no error	Unique identifier of the company to which the document belonged.
document.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
document.id	number(uint64)	if no error	Unique identifier of the document.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Hours of Service

getHosCarrier

Gets details of the specified Hours of Service Carrier.

JSON request message structure

getHosCarrier {
	"hosCarrier": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosCarrier	object	true	An object to contain the "id" key.
hosCarrier.id	number(uint64)	true	Unique identifier of the carrier.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosCarrierResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosCarrier": {
		"address": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		},
		"codes": {
			string: string
		},
		"company": number,		/* uint64 format, see Company.id */
		"contact": number,		/* uint64 format, see Contact.id */
		"id": number,		/* uint64 format */
		"logo": number,		/* uint64 format, see Picture.id */
		"name": string,
		"notes": string,
		"shiftCycle": string,		/* one of the HosCycle values */
		"timezone": string,		/* see Timezone.code */
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosCarrier	HosCarrier	if no error	The requested Carrier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosCarriersList

Gets the list of Hours of Service Carriers for the specified Company.

JSON request message structure

getHosCarriersList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosCarriersListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosCarriers": [
		{ /* see HosCarrier for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosCarriers	array[HosCarrier]	if no error	The list of carriers.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosEvent

Retrieves all the HoS Events from the last 14 days for the given company.

JSON request message structure

getHosEvent {
	"hosEvent": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosEvent	object	true	An object to contain the "id" key.
hosEvent.id	number(uint64)	true	Unique identifier of the HosEvent.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosEventResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosEvent": {
		"address": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		},
		"carrier": number,		/* uint64 format, see HosCarrier.id */
		"certificationDate": string,		/* datetime format */
		"code": number,		/* uint8 format */
		"company": number,		/* uint64 format, see Company.id */
		"diagnosticCode": string,		/* one of the HosDiagnosticCode values */
		"diagnosticStatus": boolean,
		"distanceSinceGPSFix": number,		/* single format */
		"dts": string,		/* datetime format */
		"engineHours": number,		/* double format */
		"id": number,		/* uint64 format */
		"isCoDriver": boolean,
		"latitude": string,
		"longitude": string,
		"malfunctionCode": string,
		"malfunctionStatus": boolean,
		"notes": string,
		"odometer": number,		/* double format */
		"origin": string,		/* one of the HosEventOrigin values */
		"person": number,		/* uint64 format, see Person.id */
		"seqNo": number,		/* uint16 format */
		"shiftCycle": string,		/* one of the HosCycle values */
		"status": string,		/* one of the HosEventStatus values */
		"type": number,		/* one of the HosEventType values */
		"v": [
			number		/* uint32 format */
		],
		"vehicle": number,		/* uint64 format, see Vehicle.id */
		"violationStatus": boolean,
		"violationType": string		/* one of the HosViolationType values */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosEvent	HosEvent	if no error	The requested HoS event.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosEventsList

Retrieves all the HoS Events from the last 14 days for the given company.

JSON request message structure

getHosEventsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosEventsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosEvents": [
		{ /* see HosEvent for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosEvents	array[HosEvent]	if no error	A list of the past 14 days of HoS events for the company.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosEventsListByAsset

Retrieves all the HoS Events from the last 14 days for the given asset.

JSON request message structure

getHosEventsListByAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosEventsListByAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosEvents": [
		{ /* see HosEvent for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the keys "id" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	The unique identifier of the asset.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosEvents	array[HosEvent]	if no error	A list of the past 14 days of HoS Events for the asset.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosInspection

Gets details of the specified Trip Inspection.

JSON request message structure

getHosInspection {
	"hosInspection": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosInspection	object	true	An object to contain the "id" key.
hosInspection.id	number(uint64)	true	Unique identifier of the trip inspection.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosInspectionResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosInspection": {
		"address": {
			"city": string,
			"country": string,
			"isToll": boolean,
			"number": string,
			"postal": string,
			"province": string,
			"region": string,
			"street": string
		},
		"carrier": number,		/* uint64 format, see HosCarrier.id */
		"company": number,		/* uint64 format, see Company.id */
		"defects": [
			{
				"area": string,		/* one of the HosDefectArea values */
				"category": string,
				"description": string,
				"major": [
					string
				],
				"minor": [
					string
				]
			}
		],
		"id": number,		/* uint64 format */
		"inspectedOn": string,		/* datetime format */
		"latlng": {
			"lat": number,		/* double format */
			"lng": number		/* double format */
		},
		"odometer": number,		/* double format */
		"person": number,		/* uint64 format, see Person.id */
		"status": string,		/* one of the HosDefectStatus values */
		"technician": string,
		"techSigned": string,		/* datetime format */
		"trailers": [
			string
		],
		"v": [
			number		/* uint32 format */
		],
		"vehicle": number		/* uint64 format, see Vehicle.id */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosInspection	HosInspection	if no error	The requested Trip Inspection.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosInspectionsList

Gets the list of Trip Inspections for the specified Company.

JSON request message structure

getHosInspectionsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosInspectionsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosInspections": [
		{ /* see HosInspection for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosInspections	array[HosInspection]	if no error	The list of trip inspections.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getHosInspectionsListByAsset

Gets the list of Trip Inspections for the specified Company.

JSON request message structure

getHosInspectionsListByAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getHosInspectionsListByAssetResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosInspections": [
		{ /* see HosInspection for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosInspections	array[HosInspection]	if no error	The list of trip inspections for the asset.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeHosCarrier

Creates a new or updates an existing Hours of Service Carrier.

JSON request message structure

mergeHosCarrier {
	"hosCarrier": {
		"address": {
			"city": string,
			"country": string,
			"number": string,
			"postal": string,
			"province": string,
			"street": string
		},
		"code": string,
		"company": number,		/* uint64 format */
		"contact": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"logo": number,		/* uint64 format */
		"notes": string,
		"shiftCycle": string,		/* one of the HosCycle values */
		"timezone": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosCarrier	object	always	A simple object to contain the carrier parameters.
hosCarrier.address	object	create	An object to contain the carrier's home address.
hosCarrier.address.city	string	create	City name
hosCarrier.address.country	string	create	Country name or code
hosCarrier.address.number	string	create	Address' street number
hosCarrier.address.postal	string	create	Postal or zip code
hosCarrier.address.province	string	create	Province or state name
hosCarrier.address.street	string	create	Street name
hosCarrier.code	string	optional	Governmental or regulatory assigned identifier (DOT ID).
hosCarrier.company	number(uint64)	create	The company to which this carrier belongs.
hosCarrier.contact	number(uint64)	optional	A Contact used as the contact information for the carrier's head office.
hosCarrier.id	number(uint64)	update	The unique identifier of the carrier you want to update.
hosCarrier.logo	number(uint64)	optional	A Picture used as the carrier logo.
hosCarrier.notes	string	optional	Notes.
hosCarrier.shiftCycle	string(HosCycle)	optional	Default shift cycle used by the drivers.
hosCarrier.timezone	string	create	The carrier's local timezone code used for driving cycles and creating reports.
hosCarrier.v	array[number(uint32)]	update	The carrier version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeHosCarrierResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosCarrier": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosCarrier	object	if no error	An object which contains the "id" and "company" keys when there is no error.
hosCarrier.company	number(uint64)	if no error	Unique identifier of the company.
hosCarrier.id	number(uint64)	if no error	Unique identifier of the carrier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeHosCarrier

Deletes an existing Hours of Service Carrier.

JSON request message structure

removeHosCarrier {
	"hosCarrier": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosCarrier	object	true	An object to contain the "id" key.
hosCarrier.id	number(uint64)	true	Unique identifier of the carrier.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeHosCarrierResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosCarrier": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosCarrier	object	if no error	An object which contains only three keys, and is only present when there is no error.
hosCarrier.company	number(uint64)	if no error	Unique identifier of the company.
hosCarrier.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
hosCarrier.id	number(uint64)	if no error	Unique identifier of the carrier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreHosCarrier

Restores the specified Hours of Service Carrier to its previous version.

JSON request message structure

restoreHosCarrier {
	"hosCarrier": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
hosCarrier	object	true	An object to contain the "id" key.
hosCarrier.id	number(uint64)	true	Unique identifier of the carrier.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreHosCarrierResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"hosCarrier": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
hosCarrier	object	if no error	An object which contains only three keys, and is only present when there is no error.
hosCarrier.company	number(uint64)	if no error	Unique identifier of the company.
hosCarrier.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
hosCarrier.id	number(uint64)	if no error	Unique identifier of the carrier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Icons

getIcon

Gets details of the specified Icon.

JSON request message structure

getIcon {
	"icon": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
icon	object	true	An object to contain the "id" key.
icon.id	number(uint64)	true	Unique identifier of the icon.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getIconResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"icon": {
		"category": string,
		"company": number,		/* uint64 format, see Company.id */
		"global": boolean,
		"glyphs": [
			{
				"anchor": {
					"x": number,		/* double format */
					"y": number		/* double format */
				},
				"layer": string,		/* one of the IconLayer values */
				"rotates": boolean,
				"size": {
					"height": number,		/* double format */
					"width": number		/* double format */
				},
				"src": string,
				"tags": [
					string
				],
				"zIndex": number		/* uint16 format */
			}
		],
		"id": number,		/* uint64 format */
		"label": {
			"align": string,
			"anchor": {
				"x": number,		/* double format */
				"y": number		/* double format */
			},
			"colour": string
		},
		"name": string,
		"notes": string,
		"usage": [
			string
		],
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
icon	Icon	if no error	The requested Icon.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getIconsList

Gets the list of Icons for the specified Company. (If Company not specified, returns a list of Icons from Master Company)

JSON request message structure

getIconsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getIconsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"icons": [
		{ /* see Icon for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
icons	array[Icon]	if no error	The list of icons.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeIcon

Creates a new or updates an existing Icon.

JSON request message structure

mergeIcon {
	"icon": {
		"category": string,
		"company": number,		/* uint64 format */
		"global": boolean,
		"glyphs": [
			{
				"anchor": {
					"x": number,		/* double format */
					"y": number		/* double format */
				},
				"layer": string,		/* one of the IconLayer values */
				"rotates": boolean,
				"size": {
					"height": number,		/* double format */
					"width": number		/* double format */
				},
				"src": string,
				"tags": [
					string
				],
				"zIndex": number		/* uint16 format */
			}
		],
		"id": number,		/* uint64 format */
		"label": {
			"align": string,
			"anchor": {
				"x": number,		/* double format */
				"y": number		/* double format */
			},
			"colour": string
		},
		"name": string,
		"notes": string,
		"usage": [
			string
		],
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
icon	object	always	A simple object to contain the icon parameters.
icon.category	string	create	A general name for the icon like Building or Truck. Used in conjunction with icon.name, you get "Office Building" or "Green Truck".
icon.company	number(uint64)	create	The company to which this icon belongs.
icon.global	boolean	optional	When set to true, this company as well as all child companies will be able to use this icon.
icon.glyphs	array[IconGlyph]	optional	The image and defined status tags which need to be applied to an asset in order to show the image.
icon.id	number(uint64)	update	The unique identifier of the icon you want to update.
icon.label	IconLabel	optional	Definition for the name bubble above the icon on a map.
icon.name	string	create	A specific detail about the icon such as "Green" or "Office". Used in conjunction with icon.category, you get "Office Building" or "Green Truck".
icon.notes	string	optional	Notes for the icon.
icon.usage	array[string]	optional	A list of things that can use this icon.
icon.v	array[number(uint32)]	update	The icon version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeIconResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"icon": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
icon	object	if no error	An object which contains the "id" and "company" keys when there is no error.
icon.company	number(uint64)	if no error	Unique identifier of the company.
icon.id	number(uint64)	if no error	Unique identifier of the icon.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeIcon

Deletes an existing Icon.

JSON request message structure

removeIcon {
	"icon": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
icon	object	true	An object to contain the "id" key.
icon.id	number(uint64)	true	Unique identifier of the icon.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeIconResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"icon": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
icon	object	if no error	An object which contains only three keys, and is only present when there is no error.
icon.company	number(uint64)	if no error	Unique identifier of the company.
icon.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
icon.id	number(uint64)	if no error	Unique identifier of the icon.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreIcon

Restores the specified Icon to its previous version.

JSON request message structure

restoreIcon {
	"icon": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
icon	object	true	An object to contain the "id" key.
icon.id	number(uint64)	true	Unique identifier of the icon.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreIconResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"icon": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
icon	object	if no error	An object which contains only three keys, and is only present when there is no error.
icon.company	number(uint64)	if no error	Unique identifier of the company.
icon.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
icon.id	number(uint64)	if no error	Unique identifier of the icon.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Maintenance

getMaintenanceJob

Gets details of the specified Maintenance Job.

JSON request message structure

getMaintenanceJob {
	"maintenanceJob": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceJob	object	true	An object to contain the "id" key.
maintenanceJob.id	number(uint64)	true	Unique identifier of the maintenance work.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceJobResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJob": {
		"asset": number,		/* uint64 format, see Asset.id */
		"company": number,		/* uint64 format, see Company.id */
		"completed": string,		/* datetime format */
		"cost": number,		/* double format */
		"created": string,		/* datetime format */
		"duration": string,		/* duration format */
		"engineHours": number,		/* double format */
		"garage": string,
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"odometer": number,		/* double format */
		"pictures": [
			number		/* uint64 format, see Picture.id */
		],
		"reference": string,
		"schedule": number,		/* uint64 format, see MaintenanceSchedule.id */
		"status": string,		/* one of the MaintenanceJobStatus values */
		"technician": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJob	MaintenanceJob	if no error	The requested maintenance work.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getMaintenanceJobsList

Gets the list of Maintenance Jobs for the specified Company. You can also optionally limit the results by specifying a before date/time, an after date/time, or a before and after date/time range.

JSON request message structure

getMaintenanceJobsList {
	"after": string,		/* datetime format */
	"before": string,		/* datetime format */
	"company": {
		"id": number		/* uint64 format */
	},
	"pending": boolean,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
after	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-after this given date/time.
before	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-before this given date/time.
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
pending	boolean	false	When true, will include any pending or pasdue jobs, overriding the after/before filters.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceJobsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJobs": [
		{ /* see MaintenanceJob for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJobs	array[MaintenanceJob]	if no error	The list of MaintenanceJobs.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getMaintenanceJobsListByAsset

Gets the list of Maintenance Jobs for the specified Asset. You can also optionally limit the results by specifying a before date/time, an after date/time, or a before and after date/time range.

JSON request message structure

getMaintenanceJobsListByAsset {
	"after": string,		/* datetime format */
	"asset": {
		"id": number		/* uint64 format */
	},
	"before": string,		/* datetime format */
	"pending": boolean,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
after	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-after this given date/time.
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the maintenance schedule.
before	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-before this given date/time.
pending	boolean	false	When true, will include any pending or pasdue jobs, overriding the after/before filters.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceJobsListByAssetResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJobs": [
		{ /* see MaintenanceJob for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the asset to which the array of objects relate.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the maintenance schedule.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJobs	array[MaintenanceJob]	if no error	The list of MaintenanceJobs.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getMaintenanceJobsListBySchedule

Gets the list of Maintenance Jobs that use the specified Maintenance Schedule. You can also optionally limit the results by specifying a before date/time, an after date/time, or a before and after date/time range.

JSON request message structure

getMaintenanceJobsListBySchedule {
	"after": string,		/* datetime format */
	"before": string,		/* datetime format */
	"maintenanceSchedule": {
		"id": number		/* uint64 format */
	},
	"pending": boolean,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
after	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-after this given date/time.
before	string(datetime)	false	When specified, will limit the list of jobs to those created/completed on-or-before this given date/time.
maintenanceSchedule	object	true	An object to contain the "id" key.
maintenanceSchedule.id	number(uint64)	true	Unique identifier of the maintenance schedule.
pending	boolean	false	When true, will include any pending or pasdue jobs, overriding the after/before filters.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceJobsListByScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJobs": [
		{ /* see MaintenanceJob for details */ }
	],
	"maintenanceSchedule": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJobs	array[MaintenanceJob]	if no error	The list of MaintenanceJobs.
maintenanceSchedule	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the maintenanceSchedule to which the array of objects relate.
maintenanceSchedule.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceSchedule.id	number(uint64)	if no error	Unique identifier of the maintenance schedule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getMaintenanceSchedule

Gets details of the specified Maintenance Schedule.

JSON request message structure

getMaintenanceSchedule {
	"maintenanceSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceSchedule	object	true	An object to contain the "id" key.
maintenanceSchedule.id	number(uint64)	true	Unique identifier of the maintenance schedule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceSchedule": {
		"company": number,		/* uint64 format, see Company.id */
		"cost": number,		/* double format */
		"duration": string,		/* duration format */
		"fill": string,
		"garage": string,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"intervals": {
			string /* uint64 format */ : {
				"asset": number,		/* uint64 format, see Asset.id */
				"date": string,		/* datetime format */
				"engineHours": number,		/* double format */
				"lastJob": number,		/* uint64 format */
				"odometer": number		/* double format */
			}
		},
		"name": string,
		"notes": string,
		"notify": [
			string		/* email format */
		],
		"predictionDays": number,		/* uint32 format */
		"recurDays": number,		/* uint32 format */
		"recurDistance": number,		/* double format */
		"recurEngineHours": number,		/* double format */
		"reference": string,
		"stroke": string,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceSchedule	MaintenanceSchedule	if no error	The requested maintenance schedule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getMaintenanceSchedulesList

Gets the list of Maintenance Schedules for the specified Company.

JSON request message structure

getMaintenanceSchedulesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getMaintenanceSchedulesListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceSchedules": [
		{ /* see MaintenanceSchedule for details */ }
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceSchedules	array[MaintenanceSchedule]	if no error	The list of MaintenanceSchedules.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeMaintenanceJob

Creates a new or updates an existing Maintenance Job.

JSON request message structure

mergeMaintenanceJob {
	"maintenanceJob": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"completed": string,		/* datetime format */
		"cost": number,		/* single format */
		"created": string,		/* datetime format */
		"duration": string,		/* duration format */
		"engineHours": number,		/* double format */
		"garage": string,
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"odometer": number,		/* double format */
		"pictures": [
			number		/* uint64 format */
		],
		"reference": string,
		"schedule": number,		/* uint64 format */
		"status": string,		/* one of the MaintenanceJobStatus values */
		"technician": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceJob	object	always	A simple object to contain the maintenance work parameters.
maintenanceJob.asset	number(uint64)	create	The identifier of the vehicle or trailer for which the work was performed.
maintenanceJob.company	number(uint64)	create	The company under which this maintenance work is filed.
maintenanceJob.completed	string(datetime)	optional	The date/time stamp from when this job was completed or cancelled.
maintenanceJob.cost	number(single)	optional	How much does it cost in whatever currency you want to use.
maintenanceJob.created	string(datetime)	optional	The date/time stamp from when this job was created.
maintenanceJob.duration	string(duration)	optional	How long it took.
maintenanceJob.engineHours	number(double)	optional	The recorded vehicle engine hours.
maintenanceJob.garage	string	optional	The name of the garage or service centre where the work was performed.
maintenanceJob.id	number(uint64)	update	The unique identifier of the maintenance work you want to update.
maintenanceJob.name	string	create	Name for the maintenance work.
maintenanceJob.notes	string	optional	Notes for the maintenance work.
maintenanceJob.odometer	number(double)	optional	The recorded vehicle or trailer odometer.
maintenanceJob.pictures	array[number(uint64)]	optional	The identifiers of pictures of this maintenance work.
maintenanceJob.reference	string	optional	A custom field used to refer this maintenance work an external system.
maintenanceJob.schedule	number(uint64)	create	The optional schedule identifier inputted when creating ad-hoc maintenance records. After creation, this value is read-only.
maintenanceJob.status	string(MaintenanceJobStatus)	optional	The lifetime of a maintenance work.
maintenanceJob.technician	string	optional	The name of the mechanic that does the work.
maintenanceJob.v	array[number(uint32)]	update	The maintenance work version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeMaintenanceJobResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJob": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJob	object	if no error	An object which contains the "id" and "company" keys when there is no error.
maintenanceJob.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceJob.id	number(uint64)	if no error	Unique identifier of the maintenance work.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeMaintenanceSchedule

Creates a new or updates an existing Maintenance Schedule.

JSON request message structure

mergeMaintenanceSchedule {
	"maintenanceSchedule": {
		"company": number,		/* uint64 format */
		"cost": number,		/* double format */
		"duration": string,		/* duration format */
		"fill": string,
		"garage": string,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"intervals": {
			string /* uint64 format */ : {
				"asset": number,		/* uint64 format, see Asset.id */
				"date": string,		/* datetime format */
				"engineHours": number,		/* double format */
				"lastJob": number,		/* uint64 format */
				"odometer": number		/* double format */
			},
		},
		"name": string,
		"notes": string,
		"notify": [
			string		/* email format */
		],
		"predictionDays": number,		/* uint16 format */
		"recurDays": number,		/* uint16 format */
		"recurDistance": number,		/* double format */
		"recurEngineHours": number,		/* double format */
		"reference": string,
		"stroke": string,
		"targets": string,		/* expression format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceSchedule	object	always	A simple object to contain the maintenanceSchedule parameters.
maintenanceSchedule.company	number(uint64)	create	The company to which this maintenance schedule belongs.
maintenanceSchedule.cost	number(double)	optional	How much does it cost in whatever currency you want to use.
maintenanceSchedule.duration	string(duration)	optional	How long it took.
maintenanceSchedule.fill	string	optional	Background and fill colour in the UI.
maintenanceSchedule.garage	string	optional	The name of the garage or service centre where the work was performed.
maintenanceSchedule.graphic	string(codified)	optional	The name of the symbol shown in the UI.
maintenanceSchedule.id	number(uint64)	update	The unique identifier of the maintenance schedule you want to update.
maintenanceSchedule.intervals	object{string(uint64):MaintenanceInterval}	optional	Allows you to add, remove, and replace asset interval details for the schedule. For each MaintenanceInterval in the intervals object, the value will be replaced in the schedule. However, if the asset is not targetted by the schedule, the interval will be removed. Bare in mind that the lastJob, odometer, and engineHours will default to zero if not specified, and the date will revert to the current time. If value is null, the interval is removed for that asset. However, if the asset is still targetted, the interval will be reset using the asset's current state. If a new value or null is not provided for a currently targetted asset, no change is made.
maintenanceSchedule.name	string	create	Name for the maintenance schedule.
maintenanceSchedule.notes	string	optional	Notes for the maintenance schedule.
maintenanceSchedule.notify	array[string(email)]	optional	A list of user logins who will receive an offline notification when the schedule is predicted to come due within 2 weeks, and when it becomes over-due.
maintenanceSchedule.predictionDays	number(uint16)	optional	A number of days in advance to predict when jobs will become pending for this schedule.
maintenanceSchedule.recurDays	number(uint16)	optional	The maximum number of days between service visits.
maintenanceSchedule.recurDistance	number(double)	optional	The maximum distance (in kilometres) a vehicle or trailer should travel between service visits.
maintenanceSchedule.recurEngineHours	number(double)	optional	The maximum engine hours a vehicle can run between service visits.
maintenanceSchedule.reference	string	optional	A custom field used to refer this maintenanceSchedule an external system.
maintenanceSchedule.stroke	string	optional	Text and outline colour in the UI.
maintenanceSchedule.targets	string(expression)	create	An expression to target the Vehicles and Trailers which require this maintenance work.
maintenanceSchedule.v	array[number(uint32)]	update	The maintenance schedule version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeMaintenanceScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceSchedule": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceSchedule	object	if no error	An object which contains the "id" and "company" keys when there is no error.
maintenanceSchedule.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceSchedule.id	number(uint64)	if no error	Unique identifier of the maintenance schedule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeMaintenanceJob

Deletes an existing Maintenance Job.

JSON request message structure

removeMaintenanceJob {
	"maintenanceJob": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceJob	object	true	An object to contain the "id" key.
maintenanceJob.id	number(uint64)	true	Unique identifier of the maintenance job.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeMaintenanceJobResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJob": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJob	object	if no error	An object which contains only three keys, and is only present when there is no error.
maintenanceJob.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceJob.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
maintenanceJob.id	number(uint64)	if no error	Unique identifier of the maintenance job.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeMaintenanceSchedule

Deletes an existing Maintenance Schedule.

JSON request message structure

removeMaintenanceSchedule {
	"maintenanceSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceSchedule	object	true	An object to contain the "id" key.
maintenanceSchedule.id	number(uint64)	true	Unique identifier of the maintenance schedule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeMaintenanceScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceSchedule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceSchedule	object	if no error	An object which contains only three keys, and is only present when there is no error.
maintenanceSchedule.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceSchedule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
maintenanceSchedule.id	number(uint64)	if no error	Unique identifier of the maintenance schedule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreMaintenanceJob

Restores the specified Maintenance Job to its previous version.

JSON request message structure

restoreMaintenanceJob {
	"maintenanceJob": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceJob	object	true	An object to contain the "id" key.
maintenanceJob.id	number(uint64)	true	Unique identifier of the maintenance work.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreMaintenanceJobResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceJob": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceJob	object	if no error	An object which contains only three keys, and is only present when there is no error.
maintenanceJob.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceJob.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
maintenanceJob.id	number(uint64)	if no error	Unique identifier of the maintenance work.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreMaintenanceSchedule

Restores the specified Maintenance Schedule to its previous version.

JSON request message structure

restoreMaintenanceSchedule {
	"maintenanceSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
maintenanceSchedule	object	true	An object to contain the "id" key.
maintenanceSchedule.id	number(uint64)	true	Unique identifier of the maintenance schedule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreMaintenanceScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"maintenanceSchedule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
maintenanceSchedule	object	if no error	An object which contains only three keys, and is only present when there is no error.
maintenanceSchedule.company	number(uint64)	if no error	Unique identifier of the company.
maintenanceSchedule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
maintenanceSchedule.id	number(uint64)	if no error	Unique identifier of the maintenance schedule.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Messaging

getAssetMessage

Gets details of the specified Asset Message.

JSON request message structure

getAssetMessage {
	"assetMessage": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
assetMessage	object	true	An object to contain the "id" key.
assetMessage.id	number(uint64)	true	Unique identifier of the message.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetMessageResponse {
	"assetMessage": {
		"asset": number,		/* uint64 format, see Asset.id */
		"body": string,
		"company": number,		/* uint64 format, see Company.id */
		"delivered": string,		/* datetime format */
		"folder": string,		/* one of the MessageFolder values */
		"from": string,
		"id": number,		/* uint64 format */
		"incoming": boolean,
		"kind": string,		/* one of the MemoType values */
		"processed": string,		/* datetime format */
		"readBy": string,		/* email format, see User.login */
		"status": string,		/* one of the MemoStatus values */
		"subject": string,
		"to": string,
		"user": string,		/* email format, see User.login */
		"v": [
			number		/* uint32 format */
		]
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assetMessage	Message	if no error	The requested message.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAssetMessagesList

Gets the list of Asset Messages for the specified Asset.

JSON request message structure

getAssetMessagesList {
	"asset": {
		"id": number		/* uint64 format */
	},
	"folder": string,		/* one of the MessageFolder values */
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
folder	string(MessageFolder)	optional	The folder of messages to retrieve.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetMessagesListResponse {
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"assetMessages": [
		{ /* see Message for details */ }
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
asset	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the asset to which the array of objects relate.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	Unique identifier of the asset.
assetMessages	array[Message]	if no error	The list of messages.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAssetMessagesListByCompany

Gets the list of Asset Messages for the all the Assets in the specified Company.

JSON request message structure

getAssetMessagesListByCompany {
	"company": {
		"id": number		/* uint64 format */
	},
	"folder": string,		/* one of the MessageFolder values */
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
folder	string(MessageFolder)	optional	The folder of messages to retrieve.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAssetMessagesListByCompanyResponse {
	"assetMessages": [
		{ /* see Message for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assetMessages	array[Message]	if no error	The list of messages.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeAssetMessage

Creates a new or updates an existing Asset Message.

JSON request message structure

mergeAssetMessage {
	"assetMessage": {
		"asset": number,		/* uint64 format */
		"body": string,
		"company": number,		/* uint64 format */
		"folder": string,		/* one of the MessageFolder values */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the MemoType values */
		"read": boolean,
		"responses": [
			string
		],
		"subject": string,
		"to": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
assetMessage	object	always	A simple object to contain the assetMessage parameters.
assetMessage.asset	number(uint64)	create	The asset that this message was sent from or to.
assetMessage.body	string	optional	The body of the message.
assetMessage.company	number(uint64)	create	The company to which this message belongs.
assetMessage.folder	string(MessageFolder)	optional	The folder where this message is stored.
assetMessage.id	number(uint64)	update	The unique identifier of the message you want to update.
assetMessage.kind	string(MemoType)	optional	The kind of protocol used for this message. Like SMS, Email, etc...
assetMessage.read	boolean	optional	Set to true to log that the message was received and read by yourself. Once set, the readBy value will be your login.
assetMessage.responses	array[string]	optional	These responses are used as canned-replies for PND messages.
assetMessage.subject	string	optional	The message subject field. This is used almost exclusively with email type messages.
assetMessage.to	string	optional	Optional to address used when creating the message if no messaging address is available. After creation, this value is read-only.
assetMessage.v	array[number(uint32)]	update	The message version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeAssetMessageResponse {
	"assetMessage": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assetMessage	object	if no error	An object which contains the "id", "asset", and "company" keys when there is no error.
assetMessage.asset	number(uint64)	if no error	Unique identifier of the asset.
assetMessage.company	number(uint64)	if no error	Unique identifier of the company.
assetMessage.id	number(uint64)	if no error	Unique identifier of the message.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeAssetMessage

Deletes an existing Asset Message.

JSON request message structure

removeAssetMessage {
	"assetMessage": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
assetMessage	object	true	An object to contain the "id" key.
assetMessage.id	number(uint64)	true	Unique identifier of the message.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeAssetMessageResponse {
	"assetMessage": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
assetMessage	object	if no error	An object which contains only four keys, and is only present when there is no error.
assetMessage.asset	number(uint64)	if no error	Unique identifier of the asset.
assetMessage.company	number(uint64)	if no error	Unique identifier of the company.
assetMessage.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
assetMessage.id	number(uint64)	if no error	Unique identifier of the message.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Pictures

getPicture

Gets details of the specified Picture.

JSON request message structure

getPicture {
	"picture": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
picture	object	true	An object to contain the "id" key.
picture.id	number(uint64)	true	Unique identifier of the picture.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getPictureResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"picture": {
		"bytes": number,		/* uint64 format */
		"company": number,		/* uint64 format, see Company.id */
		"focals": [
			{
				"bottom": number,		/* double format */
				"left": number,		/* double format */
				"right": number,		/* double format */
				"top": number		/* double format */
			}
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"size": {
			"height": number,		/* double format */
			"width": number		/* double format */
		},
		"src": string,
		"uses": number,		/* uint32 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
picture	Picture	if no error	The requested Picture.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getPicturesList

Gets the list of Pictures for the specified Company.

JSON request message structure

getPicturesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getPicturesListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"pictures": [
		{ /* see Picture for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
pictures	array[Picture]	if no error	The list of pictures.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergePicture

Creates a new or updates an existing Picture.

JSON request message structure

mergePicture {
	"picture": {
		"focals": [
			{
				"bottom": number,		/* double format */
				"left": number,		/* double format */
				"right": number,		/* double format */
				"top": number		/* double format */
			}
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
picture	object	always	A simple object to contain the picture parameters.
picture.focals	array[Square]	optional	Focal points of the image like the faces of people or the license plate of a vehicle.
picture.id	number(uint64)	update	The unique identifier of the picture you want to update.
picture.name	string	optional	Name for the picture.
picture.notes	string	optional	Notes for the picture.
picture.v	array[number(uint32)]	update	The picture version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergePictureResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"picture": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
picture	object	if no error	An object which contains the "id" and "company" keys when there is no error.
picture.company	number(uint64)	if no error	Unique identifier of the company.
picture.id	number(uint64)	if no error	Unique identifier of the picture.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removePicture

Deletes an existing Picture.

JSON request message structure

removePicture {
	"picture": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
picture	object	true	An object to contain the "id" key.
picture.id	number(uint64)	true	Unique identifier of the picture.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removePictureResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"picture": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
picture	object	if no error	An object which contains only three keys, and is only present when there is no error.
picture.company	number(uint64)	if no error	Unique identifier of the company.
picture.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
picture.id	number(uint64)	if no error	Unique identifier of the picture.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restorePicture

Restores the specified Picture to its previous version.

JSON request message structure

restorePicture {
	"picture": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
picture	object	true	An object to contain the "id" key.
picture.id	number(uint64)	true	Unique identifier of the picture.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restorePictureResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"picture": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
picture	object	if no error	An object which contains only three keys, and is only present when there is no error.
picture.company	number(uint64)	if no error	Unique identifier of the company.
picture.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
picture.id	number(uint64)	if no error	Unique identifier of the picture.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Places

getPlace

Gets details of the specified Place.

JSON request message structure

getPlace {
	"place": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
place	object	true	An object to contain the "id" key.
place.id	number(uint64)	true	Unique identifier of the place.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getPlaceResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"place": {
		"address": string,
		"anchor": {
			"lat": number,		/* double format */
			"lng": number		/* double format */
		},
		"colour": string,
		"company": number,		/* uint64 format, see Company.id */
		"icon": number,		/* uint64 format, see Icon.id */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the ShapeType values */
		"labels": [
			string		/* see LabelStyle.code */
		],
		"name": string,
		"notes": string,
		"pictures": [
			number		/* uint64 format */
		],
		"radius": number,		/* double format */
		"reference": string,
		"v": [
			number		/* uint32 format */
		],
		"v[0]": uint32
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
place	PlaceGeneral	if no error	The requested PlaceGeneral.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getPlacesList

Gets the list of Places for the specified Company.

JSON request message structure

getPlacesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getPlacesListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"places": [
		{ /* see PlaceGeneral for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
places	array[PlaceGeneral]	if no error	The list of PlaceGenerals.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getPlacesListByReference

Gets the list of Places for the specified Company.

JSON request message structure

getPlacesListByReference {
	"company": {
		"id": number		/* uint64 format */
	},
	"reference": string,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reference	string	true	Case-insensitive reference used to match places.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getPlacesListByReferenceResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"places": [
		{ /* see PlaceGeneral for details */ }
	],
	"reference": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
places	array[PlaceGeneral]	if no error	The list of PlaceGenerals.
reference	string	if no error	Case-insensitive reference used to match places.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergePlace

Creates a new or updates an existing Place.

JSON request message structure

mergePlace {
	"place": {
		"address": string,
		"anchor": {
			"lat": number,		/* double format */
			"lng": number		/* double format */
		},
		"colour": string,
		"company": number,		/* uint64 format */
		"icon": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the ShapeType values */
		"labels": [
			string		/* codified format */
		],
		"name": string,
		"notes": string,
		"pictures": [
			number		/* uint64 format */
		],
		"radius": number,		/* double format */
		"reference": string,
		"shape": [
			{
				"lat": number,		/* double format */
				"lng": number		/* double format */
			}
		],
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
place	object	always	A simple object to contain the place parameters.
place.address	string	conditional create	The street address of this place. Condition: You must provide an anchor or an address. Note: If the address is ommitted when creating a place, the geocoder uses the anchor to populate the address, but if no suitable results are found, no error is returned.
place.anchor	LatLng	conditional create	The "centre" point of the place. This anchor isn't necessarily the centre, but it is where the place icon will appear. Condition: You must provide an anchor or an address. Note: If you invoke the geocoder by ommitting the anchor, the address is also replaced with the geocoded value.
place.colour	string	optional	The background and fill colour of this place in the UI.
place.company	number(uint64)	create	The company to which this place belongs.
place.icon	number(uint64)	optional	The identifier of the icon used to represent this place in the UI.
place.id	number(uint64)	update	The unique identifier of the place you want to update.
place.kind	string(ShapeType)	create	The type of shape of this place.
place.labels	array[string(codified)]	optional	A list of codified label names to categorize/organize this place.
place.name	string	create	Name for the place.
place.notes	string	optional	Notes for the place.
place.pictures	array[number(uint64)]	optional	The identifiers of pictures of this place.
place.radius	number(double)	optional	Only applicable to radial shape types, this value (in meters) is the radius of the circle around the anchor.
place.reference	string	optional	A custom field used to refer this place an external system.
place.shape	array[LatLng]	create rectangle or create polygon	For rectangle shapes, this array is only two points representing the corners of the place. If more than two points are provided, the rectangle will be expanded to encompass all the points. For polygon shape types, this array of at least 3 coordinates delineates the outer boundary of the place. Coordinates cannot create overlaps when drawing lines, and are automatically re-oriented to counter-clockwise, and reduced in complexity. When saving a polygon, the first and last point do not need to match, but the saved polygon will have matching first and last points. For all other shape types the specified points are not used.
place.v	array[number(uint32)]	update	The place version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergePlaceResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"place": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
place	object	if no error	An object which contains the "id" and "company" keys when there is no error.
place.company	number(uint64)	if no error	Unique identifier of the company.
place.id	number(uint64)	if no error	Unique identifier of the place.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removePlace

Deletes an existing Place.

JSON request message structure

removePlace {
	"place": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
place	object	true	An object to contain the "id" key.
place.id	number(uint64)	true	Unique identifier of the place.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removePlaceResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"place": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
place	object	if no error	An object which contains only three keys, and is only present when there is no error.
place.company	number(uint64)	if no error	Unique identifier of the company.
place.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
place.id	number(uint64)	if no error	Unique identifier of the place.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restorePlace

Restores the specified Place to its previous version.

JSON request message structure

restorePlace {
	"place": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
place	object	true	An object to contain the "id" key.
place.id	number(uint64)	true	Unique identifier of the place.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restorePlaceResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"place": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
place	object	if no error	An object which contains only three keys, and is only present when there is no error.
place.company	number(uint64)	if no error	Unique identifier of the company.
place.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
place.id	number(uint64)	if no error	Unique identifier of the place.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Providers and Configurations

getProvider

Gets details of the specified Provider.

JSON request message structure

getProvider {
	"provider": {
		"id": string
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	true	An object to contain the "id" key.
provider.id	string	true	Unique identifier of the device.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"asset": number,		/* uint64 format, see Asset.id */
		"attributes": {
			string /* dictionary format */ : dictionary
		},
		"company": number,		/* uint64 format, see Company.id */
		"configuration": number,		/* uint64 format, see ProviderConfig.id */
		"firmware": string,
		"firmwareStatus": string,		/* one of the ProvisioningStatus values */
		"geofenceLast": string,		/* datetime format */
		"geofenceStatus": string,		/* one of the ProvisioningStatus values */
		"id": string,
		"information": {
			string: string
		},
		"kind": string,		/* one of the ProviderType values */
		"lastCheckIn": string,		/* datetime format */
		"lastIP": string,		/* ipv4 format */
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,		/* uint64 format */
		"pnd": string,
		"scriptLast": string,		/* datetime format */
		"scriptStatus": string,		/* one of the ProvisioningStatus values */
		"sim": string,
		"snf": {
			string: string
		},
		"v": [
			number		/* uint32 format */
		],
		"v[0]": uint32,
		"v[1]": uint32
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	Provider	if no error	The requested device.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderConfig

Gets details of the specified ProviderConfig.

JSON request message structure

getProviderConfig {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format, see Company.id */
		"geofences": string,		/* expression format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"parameters": {
			string: string
		},
		"script": number,		/* uint64 format, see ProviderScript.id */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	ProviderConfig	if no error	The requested configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderConfigsList

Gets the list of ProviderConfigs for the specified Company.

JSON request message structure

getProviderConfigsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfigs": [
		{ /* see ProviderConfig for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfigs	array[ProviderConfig]	if no error	The list of ProviderConfigs.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderConfiguration

Gets details of the specified Provider Configuration.

JSON request message structure

getProviderConfiguration {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigurationResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format, see Company.id */
		"geofences": [
			number		/* uint64 format */
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"scriptParameters": {
			string: object
		},
		"type": number,		/* uint64 format, see ProviderConfigurationType.id */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	ProviderConfiguration	if no error	The requested configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderConfigurationsList

Gets the list of Provider Configurations for the specified Company.

JSON request message structure

getProviderConfigurationsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderConfigurationsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfigs": [
		{ /* see ProviderConfiguration for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfigs	array[ProviderConfiguration]	if no error	The list of ProviderConfigurations.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderScript

Gets details of the specified ProviderScript.

JSON request message structure

getProviderScript {
	"providerScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerScript	object	true	An object to contain the "id" key.
providerScript.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderScriptResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerScript": {
		"blocks": [
			{
				"condition": string,
				"content": string,
				"replace": string,
				"validate": string
			}
		],
		"company": number,		/* uint64 format, see Company.id */
		"fill": string,
		"global": boolean,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"kind": string,		/* one of the ProviderType values */
		"name": string,
		"notes": string,
		"parameters": {
			string: {
				"advanced": boolean,
				"context": string,
				"notes": string,
				"order": number,		/* uint32 format */
				"type": string,		/* one of the ProviderScriptParameterType values */
				"value": string
			}
		},
		"stroke": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerScript	ProviderScript	if no error	The requested configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProviderScriptsList

Gets the list of ProviderScripts for the specified Company.

JSON request message structure

getProviderScriptsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProviderScriptsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerScripts": [
		{ /* see ProviderScript for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerScripts	array[ProviderScript]	if no error	The list of ProviderScripts.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProvidersList

Gets the list of Providers for the specified Company.

JSON request message structure

getProvidersList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProvidersListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providers": [
		{ /* see Provider for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providers	array[Provider]	if no error	The list of general device information.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getProvidersListByConfiguration

Gets the list of Providers that use the specified Provider Configuration.

JSON request message structure

getProvidersListByConfiguration {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getProvidersListByConfigurationResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"providers": [
		{ /* see Provider for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains the "id" and "company" keys when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
providers	array[Provider]	if no error	The list of devices.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeProvider

A shortcut around the Provisioning Service so that adding multiple providers to the system is easier to automate.

JSON request message structure

mergeProvider {
	"provider": {
		"asset": number,		/* uint64 format */
		"company": number,		/* uint64 format */
		"configuration": number,		/* uint64 format */
		"id": string,
		"kind": string,		/* one of the ProviderType values */
		"name": string,
		"notes": string,
		"password": string,
		"phoneNumber": number,		/* uint64 format */
		"pnd": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	always	A simple object to contain the device parameters.
provider.asset	number(uint64)	optional	The asset for which this device provides data.
provider.company	number(uint64)	create	The company to which this device belongs.
provider.configuration	number(uint64)	optional	The identifier of the configuration loaded onto this device.
provider.id	string	create or update	Unique identifier of the device.
provider.kind	string(ProviderType)	create	The type of device.
provider.name	string	optional	Name for the device.
provider.notes	string	optional	Notes for the device.
provider.password	string	optional	Security password for some devices. The password is set automagically by the system and shouldn't be changed unless an error has occurred or the device was re-programmed in the field.
provider.phoneNumber	number(uint64)	optional	The device's phone number.
provider.pnd	string	optional	Single-word name of the type of Portable Navigation Device connected ie: "Garmin" or "Magellan".
provider.v	array[number(uint32)]	update	The device version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"company": number,		/* uint64 format */
		"id": string
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	object	if no error	An object which contains the "id" and "company" keys when there is no error.
provider.company	number(uint64)	if no error	Unique identifier of the company.
provider.id	string	if no error	Unique identifier of the device.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeProviderConfig

Creates a new or updates an existing ProviderConfig.

JSON request message structure

mergeProviderConfig {
	"providerConfig": {
		"company": number,		/* uint64 format */
		"geofences": [
			number		/* uint64 format */
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"scriptParameters": {
			string: object,
		},
		"type": number,		/* uint64 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	always	A simple object to contain the configuration parameters.
providerConfig.company	number(uint64)	create	The company to which this configuration belongs.
providerConfig.geofences	array[number(uint64)]	optional	A list of place identifiers. These places are sent over-the-air to the provider for geofence boundary event raising.
providerConfig.id	number(uint64)	update	Unique identifier of the configuration.
providerConfig.name	string	create	Name for the configuration.
providerConfig.notes	string	optional	Notes for the configuration.
providerConfig.scriptParameters	object{string:object}	optional	The values required to implement the chosen type.
providerConfig.type	number(uint64)	create	The identifier of the type this configuration implements.
providerConfig.v	array[number(uint32)]	update	The configuration version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeProviderConfigResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains the "id" and "company" keys when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeProviderConfiguration

Creates a new or updates an existing Provider Configuration.

JSON request message structure

mergeProviderConfiguration {
	"providerConfig": {
		"company": number,		/* uint64 format */
		"geofences": [
			number		/* uint64 format */
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"scriptParameters": {
			string: object,
		},
		"type": number,		/* uint64 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	always	A simple object to contain the configuration parameters.
providerConfig.company	number(uint64)	create	The company to which this configuration belongs.
providerConfig.geofences	array[number(uint64)]	optional	A list of place identifiers. These places are sent over-the-air to the provider for geofence boundary event raising.
providerConfig.id	number(uint64)	update	Unique identifier of the configuration.
providerConfig.name	string	create	Name for the configuration.
providerConfig.notes	string	optional	Notes for the configuration.
providerConfig.scriptParameters	object{string:object}	optional	The values required to implement the chosen type.
providerConfig.type	number(uint64)	create	The identifier of the type this configuration implements.
providerConfig.v	array[number(uint32)]	update	The configuration version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeProviderConfigurationResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains the "id" and "company" keys when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeProviderScript

Creates a new or updates an existing ProviderScript.

JSON request message structure

mergeProviderScript {
	"providerScript": {
		"company": number,		/* uint64 format */
		"geofences": [
			number		/* uint64 format */
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"scriptParameters": {
			string: object,
		},
		"type": number,		/* uint64 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerScript	object	always	A simple object to contain the configuration parameters.
providerScript.company	number(uint64)	create	The company to which this configuration belongs.
providerScript.geofences	array[number(uint64)]	optional	A list of place identifiers. These places are sent over-the-air to the provider for geofence boundary event raising.
providerScript.id	number(uint64)	update	Unique identifier of the configuration.
providerScript.name	string	create	Name for the configuration.
providerScript.notes	string	optional	Notes for the configuration.
providerScript.scriptParameters	object{string:object}	optional	The values required to implement the chosen type.
providerScript.type	number(uint64)	create	The identifier of the type this configuration implements.
providerScript.v	array[number(uint32)]	update	The configuration version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeProviderScriptResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerScript": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerScript	object	if no error	An object which contains the "id" and "company" keys when there is no error.
providerScript.company	number(uint64)	if no error	Unique identifier of the company.
providerScript.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeProvider

Deletes an existing device.

JSON request message structure

removeProvider {
	"provider": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	true	An object to contain the "id" key.
provider.id	number(uint64)	true	Unique identifier of the device.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	object	if no error	An object which contains only three keys, and is only present when there is no error.
provider.company	number(uint64)	if no error	Unique identifier of the company.
provider.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
provider.id	number(uint64)	if no error	Unique identifier of the device.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeProviderConfig

Deletes an existing ProviderConfig.

JSON request message structure

removeProviderConfig {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeProviderConfigResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeProviderConfiguration

Deletes an existing Provider Configuration.

JSON request message structure

removeProviderConfiguration {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeProviderConfigurationResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeProviderScript

Deletes an existing ProviderScript.

JSON request message structure

removeProviderScript {
	"providerScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerScript	object	true	An object to contain the "id" key.
providerScript.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeProviderScriptResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerScript": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerScript	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerScript.company	number(uint64)	if no error	Unique identifier of the company.
providerScript.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
providerScript.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreProvider

Restores the specified device to its previous version.

JSON request message structure

restoreProvider {
	"provider": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	true	An object to contain the "id" key.
provider.id	number(uint64)	true	Unique identifier of the device.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	object	if no error	An object which contains only three keys, and is only present when there is no error.
provider.company	number(uint64)	if no error	Unique identifier of the company.
provider.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
provider.id	number(uint64)	if no error	Unique identifier of the device.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreProviderConfig

Restores the specified ProviderConfig to its previous version.

JSON request message structure

restoreProviderConfig {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreProviderConfigResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreProviderConfiguration

Restores the specified Provider Configuration to its previous version.

JSON request message structure

restoreProviderConfiguration {
	"providerConfig": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerConfig	object	true	An object to contain the "id" key.
providerConfig.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreProviderConfigurationResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerConfig": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerConfig	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerConfig.company	number(uint64)	if no error	Unique identifier of the company.
providerConfig.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
providerConfig.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreProviderScript

Restores the specified ProviderScript to its previous version.

JSON request message structure

restoreProviderScript {
	"providerScript": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
providerScript	object	true	An object to contain the "id" key.
providerScript.id	number(uint64)	true	Unique identifier of the configuration.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreProviderScriptResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"providerScript": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
providerScript	object	if no error	An object which contains only three keys, and is only present when there is no error.
providerScript.company	number(uint64)	if no error	Unique identifier of the company.
providerScript.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
providerScript.id	number(uint64)	if no error	Unique identifier of the configuration.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

reviveProvider

Revives an Provider from suspended state so that new events are processed (data sent while suspended is ignored).

JSON request message structure

reviveProvider {
	"provider": {
		"id": string
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	true	An object to contain the "id" key.
provider.id	string	true	Unique identifier of the device.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

reviveProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"company": number,		/* uint64 format */
		"id": string,
		"suspended": boolean,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	object	if no error	An object which contains the keys "id" and "suspended" when there is no error.
provider.company	number(uint64)	if no error	Unique identifier of the company.
provider.id	string	if no error	The unique identifier of the device.
provider.suspended	boolean	if no error	Indicates whether the object is suspended. Value is always false
provider.v	array[number(uint32)]	if no error	The device version keys at the time of suspension.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

suspendProvider

Suspends an Provider so that no further events are processed for it, but it remains available for historical reports.

JSON request message structure

suspendProvider {
	"provider": {
		"id": string
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
provider	object	true	An object to contain the "id" key.
provider.id	string	true	Unique identifier of the device.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

suspendProviderResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"provider": {
		"company": number,		/* uint64 format */
		"id": string,
		"suspended": boolean,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
provider	object	if no error	An object which contains the keys "id" and "suspended" when there is no error.
provider.company	number(uint64)	if no error	Unique identifier of the company.
provider.id	string	if no error	The unique identifier of the device.
provider.suspended	boolean	if no error	Indicates whether the object is suspended. Value is always true
provider.v	array[number(uint32)]	if no error	The device version keys at the time of suspension.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Real-time Analytics

getAnalyticSummaryList

Retrieves all the analytics summaries from the last 14 days for the given company.

JSON request message structure

getAnalyticSummaryList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAnalyticSummaryListResponse {
	"analyticSummaries": [
		{ /* see AnalyticSummary for details */ }
	],
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
analyticSummaries	array[AnalyticSummary]	if no error	A list of the past 14 days worth of real-time analytics for the company.
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getAnalyticSummaryListByAsset

Retrieves all the analytics summaries from the last 14 days for the given asset.

JSON request message structure

getAnalyticSummaryListByAsset {
	"asset": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
asset	object	true	An object to contain the "id" key.
asset.id	number(uint64)	true	Unique identifier of the asset.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getAnalyticSummaryListByAssetResponse {
	"analyticSummaries": [
		{ /* see AnalyticSummary for details */ }
	],
	"asset": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
analyticSummaries	array[AnalyticSummary]	if no error	A list of the past 14 days worth of real-time analytics for the asset.
asset	object	if no error	An object which contains the keys "id" when there is no error.
asset.company	number(uint64)	if no error	Unique identifier of the company.
asset.id	number(uint64)	if no error	The unique identifier of the asset.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Reports

getReportResult

Gets details of the specified Report Result.

JSON request message structure

getReportResult {
	"reportResult": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportResult	object	true	An object to contain the "id" key.
reportResult.id	number(uint64)	true	Unique identifier of the report results.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportResultResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResult": {
		"archive": boolean,
		"bounds": {
			"east": number,		/* double format */
			"north": number,		/* double format */
			"south": number,		/* double format */
			"west": number		/* double format */
		},
		"company": number,		/* uint64 format, see Company.id */
		"completed": string,		/* datetime format */
		"created": string,		/* datetime format */
		"error": string,		/* see ReportResult.status */
		"filtered": [
			number		/* uint64 format */
		],
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"progress": number,		/* uint8 format */
		"runBy": string,		/* email format, see User.login */
		"schedule": number,		/* uint64 format, see ReportSchedule.id */
		"scorecards": [
			ReportDataScorecard
		],
		"status": string,		/* one of the ReportStatus values */
		"targeted": [
			number		/* uint64 format */
		],
		"template": number,		/* uint64 format, see ReportTemplate.id */
		"timezone": string,		/* see Timezone.code */
		"totals": [
			ReportDataTotal
		],
		"type": string,		/* one of the ReportType values */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResult	ReportResult	if no error	The requested report results.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportResultsList

Gets the list of Report Results for the specified Company.

JSON request message structure

getReportResultsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportResultsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResults": [
		{ /* see ReportResult for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResults	array[ReportResult]	if no error	The list of report results.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportResultsListByTemplate

Gets the list of Report Results for the specified Report Template.

JSON request message structure

getReportResultsListByTemplate {
	"reportTemplate": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	true	An object to contain the "id" key.
reportTemplate.id	number(uint64)	true	Unique identifier of the report template.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportResultsListByTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResult": [
		{ /* see ReportResult for details */ }
	],
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResult	array[ReportResult]	if no error	The list of report results.
reportTemplate	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the report template to which the array of objects relate.
reportTemplate.company	number(uint64)	if no error	Unique identifier of the company.
reportTemplate.id	number(uint64)	if no error	Unique identifier of the report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportSchedule

Gets details of the specified Report Schedule.

JSON request message structure

getReportSchedule {
	"reportSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportSchedule	object	true	An object to contain the "id" key.
reportSchedule.id	number(uint64)	true	Unique identifier of the report schedule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedule": {
		"company": number,		/* uint64 format, see Company.id */
		"enabled": boolean,
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"notify": {
			"assets": string,		/* expression format */
			"users": [
				string		/* email format */
			]
		},
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"owner": string,		/* email format, see User.login */
		"repetition": {
			"end": string,		/* datetime format */
			"iterations": number,		/* uint16 format */
			"kind": string,		/* one of the ReportRecurrenceType values */
			"lastEndDate": string,		/* datetime format */
			"lastResult": number,		/* uint64 format */
			"lastStartDate": string,		/* datetime format */
			"nextEndDate": string,		/* datetime format */
			"nextStartDate": string,		/* datetime format */
			"start": string,		/* datetime format */
			"timezone": string,		/* see Timezone.code */
			"weekday": number,		/* uint8 format */
			"weekdays": [
				boolean
			]
		},
		"template": number,		/* uint64 format, see ReportTemplate.id */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedule	ReportSchedule	if no error	The requested report schedule.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportSchedulesList

Gets the list of Report Schedules for the specified Company.

JSON request message structure

getReportSchedulesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportSchedulesListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedules": [
		{ /* see ReportSchedule for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedules	array[ReportSchedule]	if no error	The list of report schedules.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportSchedulesListByTemplate

Gets the list of Report Schedules for the specified Report Template.

JSON request message structure

getReportSchedulesListByTemplate {
	"reportTemplate": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	true	An object to contain the "id" key.
reportTemplate.id	number(uint64)	true	Unique identifier of the report template.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportSchedulesListByTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedule": [
		{ /* see ReportSchedule for details */ }
	],
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedule	array[ReportSchedule]	if no error	The list of report schedules.
reportTemplate	object	if no error	An object which contains the "id" and "company" keys when there is no error. The "id" key is the unique identifier of the report template to which the array of objects relate.
reportTemplate.company	number(uint64)	if no error	Unique identifier of the company.
reportTemplate.id	number(uint64)	if no error	Unique identifier of the report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportTemplate

Gets details of the specified Report Template.

JSON request message structure

getReportTemplate {
	"reportTemplate": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	true	An object to contain the "id" key.
reportTemplate.id	number(uint64)	true	Unique identifier of the report template.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportTemplate": {
		"company": number,		/* uint64 format, see Company.id */
		"fill": string,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"stroke": string,
		"type": string,		/* one of the ReportType values */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportTemplate	ReportTemplate	if no error	The requested report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

getReportTemplatesList

Gets the list of Report Templates for the specified Company.

JSON request message structure

getReportTemplatesList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getReportTemplatesListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportTemplates": [
		{ /* see ReportTemplate for details */ }
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportTemplates	array[ReportTemplate]	if no error	The list of report templates.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeReportResult

Creates a new or updates an existing Report Result.

JSON request message structure

mergeReportResult {
	"reportResult": {
		"archive": boolean,
		"bounds": {
			"east": number,		/* double format */
			"north": number,		/* double format */
			"south": number,		/* double format */
			"west": number		/* double format */
		},
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"template": number,		/* uint64 format */
		"timezone": string,
		"type": string,		/* one of the ReportType values */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportResult	object	always	A simple object to contain the reportResult parameters.
reportResult.archive	boolean	optional	Indicates whether this report should be archived. Archived report results are stored for six months. Non-archive reports are purged after 24 hours.
reportResult.bounds	LatLngBounds	optional	The geographic boundary of all the data in these results. This property can be used to quickly centre the map around your results.
reportResult.company	number(uint64)	create	The company to which these report results belongs.
reportResult.id	number(uint64)	update	The unique identifier of the report results you want to update.
reportResult.name	string	create	Name for the report results.
reportResult.notes	string	optional	Notes for these report results.
reportResult.options	ReportOptions	create	Options used to configure the report logic.
reportResult.options.filtering	string(ReportFilterMode)	optional	The mechanism to use for filtering based on places and regions.
reportResult.options.places	string(expression)	optional	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportResult.options.regions	array[string(codified)]	optional	A list of provinces and states, where only assets within those regions will be included in the results.
reportResult.options.targets	string(expression)	create	The search pattern used to target assets for inclusion in the report results.
reportResult.template	number(uint64)	optional	Identifier of the template used to help create these results.
reportResult.timezone	string	optional	The code of the local timezone used to calculate times.
reportResult.type	string(ReportType)	create	The kind of logic used to build the report results.
reportResult.v	array[number(uint32)]	update	The reportResult version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeReportResultResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResult": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResult	object	if no error	An object which contains the "id" and "company" keys when there is no error.
reportResult.company	number(uint64)	if no error	Unique identifier of the company.
reportResult.id	number(uint64)	if no error	Unique identifier of these report results.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeReportSchedule

Creates a new or updates an existing Report Schedule.

JSON request message structure

mergeReportSchedule {
	"reportSchedule": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"notify": [
			string		/* codified format */
		],
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"repetition": {
			"end": string,		/* datetime format */
			"kind": string,		/* one of the ReportRecurrenceType values */
			"start": string,		/* datetime format */
			"timezone": string,		/* see Timezone.code */
			"weekday": number,		/* uint8 format */
			"weekdays": [
				boolean
			]
		},
		"template": number,		/* uint64 format */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportSchedule	object	always	A simple object to contain the reportSchedule parameters.
reportSchedule.company	number(uint64)	create	The company to which this report schedule belongs.
reportSchedule.id	number(uint64)	update	The unique identifier of the report results you want to update.
reportSchedule.name	string	create	Name for the report schedule.
reportSchedule.notes	string	optional	Notes for these report schedule.
reportSchedule.notify	array[string(codified)]	optional	Settings for sending notifications of results to users and report targets.
reportSchedule.notify.assets	string(expression)	optional	A targeting expression for sending report results to targeted assets (only about themselves).
reportSchedule.notify.users	array[string(email)]	optional	List of users from the target company who will receive report results (via email only) for scheduled reports.
reportSchedule.options	ReportOptions	create	Options used to configure the report logic.
reportSchedule.options.filtering	string(ReportFilterMode)	optional	The mechanism to use for filtering based on places and regions.
reportSchedule.options.places	string(expression)	optional	A targeting expression for limiting schedule which only include data from Assets interacting with the targeted Places.
reportSchedule.options.regions	array[string(codified)]	optional	A list of provinces and states, where only assets within those regions will be included in the schedule.
reportSchedule.options.targets	string(expression)	create	The search pattern used to target assets for inclusion in the report schedule.
reportSchedule.repetition	ReportRecurrence	optional	The pattern used to automatically run the report when new data is available.
reportSchedule.template	number(uint64)	optional	Identifier of the template used to help create these schedule.
reportSchedule.v	array[number(uint32)]	update	The reportSchedule version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeReportScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedule": {
		"company": number,		/* uint64 format */
		"id": number,		/* uint64 format */
		"template": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedule	object	if no error	An object which contains the "id" and "company" keys when there is no error.
reportSchedule.company	number(uint64)	if no error	Unique identifier of the company.
reportSchedule.id	number(uint64)	if no error	Unique identifier of these report schedule.
reportSchedule.template	number(uint64)	if no error	Unique identifier of the report template to which this schedule belongs.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

mergeReportTemplate

Creates a new or updates an existing Report Template.

JSON request message structure

mergeReportTemplate {
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"fill": string,
		"graphic": string,		/* codified format */
		"id": number,		/* uint64 format */
		"name": string,
		"notifyAssets": string,		/* expression format */
		"notifyUsers": [
			string		/* email format */
		],
		"options": {
			"filtering": string,		/* one of the ReportFilterMode values */
			"parameters": [
				{
					"type": string,		/* one of the ReportParameterType values */
					"value": string
				}
			],
			"places": string,		/* expression format */
			"regions": [
				string
			],
			"scorecardRules": {
				"baseScore": number,		/* double format */
				"parameters": [
					{
						"condition": string,
						"duration": string,		/* duration format */
						"points": number		/* double format */
					}
				]
			},
			"targets": string		/* expression format */
		},
		"schedule": {
			"end": string,		/* datetime format */
			"kind": string,		/* one of the ReportRecurrenceType values */
			"start": string,		/* datetime format */
			"timezone": string,		/* see Timezone.code */
			"weekday": number,		/* uint8 format */
			"weekdays": [
				boolean
			]
		},
		"stroke": string,
		"timezone": string,
		"type": string,		/* one of the ReportType values */
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	always	A simple object to contain the report template parameters.
reportTemplate.company	number(uint64)	create	The company to which this report template belongs.
reportTemplate.fill	string	optional	Background and fill colour in the UI.
reportTemplate.graphic	string(codified)	optional	The name of the symbol shown in the UI.
reportTemplate.id	number(uint64)	update	The unique identifier of the report template you want to update.
reportTemplate.name	string	create	Name for the report template.
reportTemplate.notifyAssets	string(expression)	optional	A targeting expression for sending report results to targeted assets (only about themselves).
reportTemplate.notifyUsers	array[string(email)]	optional	List of users from the target company who will receive report results (via email only) for scheduled reports.
reportTemplate.options	ReportOptions	optional	Options used to configure the report logic.
reportTemplate.options.filtering	string(ReportFilterMode)	optional	The mechanism to use for filtering based on places and regions.
reportTemplate.options.places	string(expression)	optional	A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
reportTemplate.options.regions	array[string(codified)]	optional	A list of provinces and states, where only assets within those regions will be included in the results.
reportTemplate.options.targets	string(expression)	create	The search pattern used to target assets for inclusion in the report results.
reportTemplate.schedule	ReportRecurrence	optional	An optional schedule used to automatically run the report when new data is available.
reportTemplate.stroke	string	optional	Text and outline colour in the UI.
reportTemplate.timezone	string	optional	The code of the local timezone used to calculate times.
reportTemplate.type	string(ReportType)	create	The kind of logic used to build the report results.
reportTemplate.v	array[number(uint32)]	update	The report template version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

mergeReportTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportTemplate	object	if no error	An object which contains the "id" and "company" keys when there is no error.
reportTemplate.company	number(uint64)	if no error	Unique identifier of the company.
reportTemplate.id	number(uint64)	if no error	Unique identifier of the report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeReportResult

Deletes an existing Report Result.

JSON request message structure

removeReportResult {
	"reportResult": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportResult	object	true	An object to contain the "id" key.
reportResult.id	number(uint64)	true	Unique identifier of the report results.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeReportResultResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResult": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResult	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportResult.company	number(uint64)	if no error	Unique identifier of the company.
reportResult.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
reportResult.id	number(uint64)	if no error	Unique identifier of the report results.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeReportSchedule

Deletes an existing Report Schedule.

JSON request message structure

removeReportSchedule {
	"reportSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportSchedule	object	true	An object to contain the "id" key.
reportSchedule.id	number(uint64)	true	Unique identifier of the report schedule.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeReportScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedule	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportSchedule.company	number(uint64)	if no error	Unique identifier of the company.
reportSchedule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
reportSchedule.id	number(uint64)	if no error	Unique identifier of the report schedule.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

removeReportTemplate

Deletes an existing Report Template.

JSON request message structure

removeReportTemplate {
	"reportTemplate": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	true	An object to contain the "id" key.
reportTemplate.id	number(uint64)	true	Unique identifier of the report template.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

removeReportTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportTemplate	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportTemplate.company	number(uint64)	if no error	Unique identifier of the company.
reportTemplate.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always true
reportTemplate.id	number(uint64)	if no error	Unique identifier of the report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreReportResult

Restores the specified ReportResult to its previous version.

JSON request message structure

restoreReportResult {
	"reportResult": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportResult	object	true	An object to contain the "id" key.
reportResult.id	number(uint64)	true	Unique identifier of the group.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreReportResultResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportResult": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportResult	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportResult.company	number(uint64)	if no error	Unique identifier of the company.
reportResult.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
reportResult.id	number(uint64)	if no error	Unique identifier of the group.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreReportSchedule

Restores the specified ReportSchedule to its previous version.

JSON request message structure

restoreReportSchedule {
	"reportSchedule": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportSchedule	object	true	An object to contain the "id" key.
reportSchedule.id	number(uint64)	true	Unique identifier of the group.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreReportScheduleResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportSchedule": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportSchedule	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportSchedule.company	number(uint64)	if no error	Unique identifier of the company.
reportSchedule.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
reportSchedule.id	number(uint64)	if no error	Unique identifier of the group.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

restoreReportTemplate

Restores the specified Report Template to its previous version.

JSON request message structure

restoreReportTemplate {
	"reportTemplate": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reportTemplate	object	true	An object to contain the "id" key.
reportTemplate.id	number(uint64)	true	Unique identifier of the report template.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

restoreReportTemplateResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reportTemplate": {
		"company": number,		/* uint64 format */
		"deleted": boolean,
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reportTemplate	object	if no error	An object which contains only three keys, and is only present when there is no error.
reportTemplate.company	number(uint64)	if no error	Unique identifier of the company.
reportTemplate.deleted	boolean	if no error	Indicates whether the object is deleted. Value is always false
reportTemplate.id	number(uint64)	if no error	Unique identifier of the report template.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Self

getSessionDetails

Gets details of the current Session (yourself) and User.

JSON request message structure

getSessionDetails {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getSessionDetailsResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"ghostId": string,
	"message": string,
	"reqId": number,		/* uint32 format */
	"serverTime": string,		/* datetime format */
	"user": {
		"company": number,		/* uint64 format, see Company.id */
		"contact": {
			"addresses": {
				string: string		/* email format */
			},
			"company": number,		/* uint64 format, see Company.id */
			"dates": {
				string: string		/* datetime format */
			},
			"emails": {
				string: string		/* email format */
			},
			"id": number,		/* uint64 format */
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number		/* uint64 format */
			},
			"pictures": [
				number		/* uint64 format */
			],
			"roles": [
				string		/* codified format */
			],
			"urls": {
				string: string
			},
			"v": [
				number		/* uint32 format */
			]
		},
		"enabled": boolean,
		"formats": {
			string /* codified format */ : string
		},
		"groups": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"id": number,		/* uint64 format */
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,		/* uint64 format, see Company.id */
						"labels": [
							string		/* see LabelStyle.code */
						],
						"level": string,		/* one of the PermissionLevel values */
						"method": string,		/* one of the PermissionMethod values */
						"type": string		/* one of the PermissionType values */
					}
				],
				"v": [
					number		/* uint32 format */
				]
			}
		],
		"language": string,
		"login": string,		/* email format, see User.login */
		"measurements": {
			string /* codified format */ : string		/* one of the SystemsOfUnits values */
		},
		"nickname": string,
		"notify": [
			{
				"email": string,		/* email format */
				"enabled": boolean,
				"end": string,		/* duration format, see UserGeneral.timezone */
				"name": string,
				"offline": [
					string		/* one of the NotificationsMethod values */
				],
				"online": [
					string		/* one of the NotificationsMethod values */
				],
				"sms": number,		/* uint64 format */
				"start": string,		/* duration format, see UserGeneral.timezone */
				"weekdays": [
					boolean		/* see UserGeneral.timezone */
				]
			}
		],
		"options": {
			string /* codified format */ : string
		},
		"passwordExpired": boolean,
		"passwordPolicy": {
			"expireMode": string,		/* one of the ExpiryModePolicy values */
			"expireThreshold": number,		/* uint8 format */
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number		/* uint8 format */
		},
		"permissions": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"labels": [
					string		/* see LabelStyle.code */
				],
				"level": string,		/* one of the PermissionLevel values */
				"method": string,		/* one of the PermissionMethod values */
				"type": string		/* one of the PermissionType values */
			}
		],
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,		/* uint16 format */
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string		/* ipv4 format */
			],
			"maxSessions": number,		/* uint8 format */
			"multiUser": string		/* one of the MultiUserPolicy values */
		},
		"timezone": string,		/* see Timezone.code */
		"v": [
			number		/* uint32 format */
		]
	}
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
ghostId	string	if no error	Your session identifier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
serverTime	string(datetime)	if no error	The UTC date/time of the server hosting the connection.
user	Session	if no error	All the details about your user.

login

Creates a new session and allows access to authorized services.

JSON request message structure

login {
	"password": string,
	"reqId": number,		/* uint32 format */
	"userAgent": string,
	"username": string		/* email format */
}

Request
Property	Type	Required	Description
password	string	true	User's password.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
userAgent	string	optional	Application name. This should match the allowed applications from user's company's SessionPolicy.applications.
username	string(email)	true	User's email address.

JSON response message structure

loginResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"expiry": string,		/* datetime format */
	"ghostId": string,
	"message": string,
	"passwordPolicy": {
		"expireMode": string,		/* one of the ExpiryModePolicy values */
		"expireThreshold": number,		/* uint8 format */
		"includeLetters": boolean,
		"includeNumbers": boolean,
		"includeSpecial": boolean,
		"includeUpperLower": boolean,
		"minimumLength": number		/* uint8 format */
	},
	"reqId": number,		/* uint32 format */
	"serverTime": string,		/* datetime format */
	"sessionPolicy": {
		"applications": [
			string
		],
		"expireTimeout": number,		/* uint16 format */
		"idleAllowed": boolean,
		"ipv4Ranges": [
			string		/* ipv4 format */
		],
		"maxSessions": number,		/* uint8 format */
		"multiUser": string		/* one of the MultiUserPolicy values */
	},
	"user": {
		"company": number,		/* uint64 format, see Company.id */
		"contact": {
			"addresses": {
				string: string		/* email format */
			},
			"company": number,		/* uint64 format, see Company.id */
			"dates": {
				string: string		/* datetime format */
			},
			"emails": {
				string: string		/* email format */
			},
			"id": number,		/* uint64 format */
			"name": string,
			"notes": string,
			"options": {
				string: string
			},
			"otherNames": {
				string: string
			},
			"phones": {
				string: number		/* uint64 format */
			},
			"pictures": [
				number		/* uint64 format */
			],
			"roles": [
				string		/* codified format */
			],
			"urls": {
				string: string
			},
			"v": [
				number		/* uint32 format */
			]
		},
		"enabled": boolean,
		"formats": {
			string /* codified format */ : string
		},
		"groups": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"id": number,		/* uint64 format */
				"name": string,
				"notes": string,
				"permissions": [
					{
						"company": number,		/* uint64 format, see Company.id */
						"labels": [
							string		/* see LabelStyle.code */
						],
						"level": string,		/* one of the PermissionLevel values */
						"method": string,		/* one of the PermissionMethod values */
						"type": string		/* one of the PermissionType values */
					}
				],
				"v": [
					number		/* uint32 format */
				]
			}
		],
		"language": string,
		"login": string,		/* email format, see User.login */
		"measurements": {
			string /* codified format */ : string		/* one of the SystemsOfUnits values */
		},
		"nickname": string,
		"notify": [
			{
				"email": string,		/* email format */
				"enabled": boolean,
				"end": string,		/* duration format, see UserGeneral.timezone */
				"name": string,
				"offline": [
					string		/* one of the NotificationsMethod values */
				],
				"online": [
					string		/* one of the NotificationsMethod values */
				],
				"sms": number,		/* uint64 format */
				"start": string,		/* duration format, see UserGeneral.timezone */
				"weekdays": [
					boolean		/* see UserGeneral.timezone */
				]
			}
		],
		"options": {
			string /* codified format */ : string
		},
		"passwordExpired": boolean,
		"passwordPolicy": {
			"expireMode": string,		/* one of the ExpiryModePolicy values */
			"expireThreshold": number,		/* uint8 format */
			"includeLetters": boolean,
			"includeNumbers": boolean,
			"includeSpecial": boolean,
			"includeUpperLower": boolean,
			"minimumLength": number		/* uint8 format */
		},
		"permissions": [
			{
				"company": number,		/* uint64 format, see Company.id */
				"labels": [
					string		/* see LabelStyle.code */
				],
				"level": string,		/* one of the PermissionLevel values */
				"method": string,		/* one of the PermissionMethod values */
				"type": string		/* one of the PermissionType values */
			}
		],
		"sessionPolicy": {
			"applications": [
				string
			],
			"expireTimeout": number,		/* uint16 format */
			"idleAllowed": boolean,
			"ipv4Ranges": [
				string		/* ipv4 format */
			],
			"maxSessions": number,		/* uint8 format */
			"multiUser": string		/* one of the MultiUserPolicy values */
		},
		"timezone": string,		/* see Timezone.code */
		"v": [
			number		/* uint32 format */
		]
	}
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
expiry	string(datetime)	if no error	The date/time when this UserSession expires.
ghostId	string	if no error	Your session identifier.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
passwordPolicy	PasswordPolicy	if no error	The company's password policy. Needed if the user's password is expired.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
serverTime	string(datetime)	if no error	The UTC date/time of the server hosting the connection.
sessionPolicy	SessionPolicy	if no error	The company's session policy.
user	Session	if no error	All the details about your user.

logout

Ends your session.

JSON request message structure

logout {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

logoutResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

updateOwnContact

Allows a Session User to update their own contact. If your user has no associated contact, you will receive a Contact not found error.

JSON request message structure

updateOwnContact {
	"contact": {
		"address": string,
		"email": string,		/* email format */
		"fax": number,		/* uint64 format */
		"mobile": number,		/* uint64 format */
		"name": string,
		"notes": string,
		"office": number,		/* uint64 format */
		"pictures": [
			number		/* uint64 format */
		],
		"url": string,
		"v": [
			number		/* uint32 format */
		]
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
contact	object	true	An object similar to a Contact, but without the id or company properties.
contact.address	string	optional	Full street address including city, province/state, country, and postal code.
contact.email	string(email)	optional	Your preferred email address.
contact.fax	number(uint64)	optional	Your office's fax number.
contact.mobile	number(uint64)	optional	Your mobile phone number.
contact.name	string	true	Your full name.
contact.notes	string	optional	Notes about yourself.
contact.office	number(uint64)	optional	Your office phone number.
contact.pictures	array[number(uint64)]	optional	List of pictures of yourself.
contact.url	string	optional	Your website address.
contact.v	array[number(uint32)]	true	The contact version keys used to validate synchronization.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

updateOwnContactResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

updateOwnPassword

Allows a Session User to change their own password.

JSON request message structure

updateOwnPassword {
	"current": string,
	"password": string,
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
current	string	true	Your current/old password is required to confirm account ownership.
password	string	true	Your new password must conform to your company's password policy.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

updateOwnPasswordResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

updateOwnPreferences

Allows a Session User to change their own preferences.

JSON request message structure

updateOwnPreferences {
	"formats": {
		string: string,
	},
	"language": string,
	"measurements": {
		string: string,		/* one of the SystemsOfUnits values */
	},
	"notify": [
		{
			"email": string,		/* email format */
			"enabled": boolean,
			"end": string,		/* duration format, see UserGeneral.timezone */
			"name": string,
			"offline": [
				string		/* one of the NotificationsMethod values */
			],
			"online": [
				string		/* one of the NotificationsMethod values */
			],
			"sms": number,		/* uint64 format */
			"start": string,		/* duration format, see UserGeneral.timezone */
			"weekdays": [
				boolean		/* see UserGeneral.timezone */
			]
		}
	],
	"options": {
		string: string,
	},
	"reqId": number,		/* uint32 format */
	"timezone": string
}

Request
Property	Type	Required	Description
formats	object{string:string}	optional	Formatting help for dates, times, numbers.
language	string	optional	Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
measurements	object{string:string(SystemsOfUnits)}	optional	Preferred way of displaying ambiguous numbers in the context of measurements.
notify	array[UserNotifications]	optional	List of notification preferences. Please note that active times cannot overlap.
options	object{string:string}	optional	Additional options which do not fit in with the formats or measurements preferences. If a value of null is given, the option is removed. To keep the option, you can use a blank string. For convenience, if the value of an option is given as JSON (instead of a string), they are automatically serialized with no white-space.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
timezone	string	optional	Your local timezone code used to calculate times.

JSON response message structure

updateOwnPreferencesResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Socket

getSubscriptionsList

Gets the list of current subscriptions for this WebSocket

JSON request message structure

getSubscriptionsList {
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getSubscriptionsListResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number,		/* uint32 format */
	"subscriptions": [
		{ /* see Subscription for details */ }
	]
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
subscriptions	array[Subscription]	if no error	The list of your current notification types.

Subscribes the user to receive notifications for add/update.

JSON request message structure

subscribe {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number,		/* uint32 format */
	"subscriptionTypes": [
		string		/* one of the SubscriptionType values */
	]
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
subscriptionTypes	array[string(SubscriptionType)]	true	The list of notification types you want to receive.

JSON response message structure

subscribeResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"denied": [
		string	/* one of the SubscriptionType values */
	],
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"invalid": [
		string
	],
	"merged": [
		string	/* one of the SubscriptionType values */
	],
	"message": string,
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
denied	array[string(SubscriptionType)]	error or partial success	Notification types not added to your socket due to insufficient permissions.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
invalid	array[string]	error or partial success	A returned list of non-sense you sent to my beuatiful server.
merged	array[string(SubscriptionType)]	if no error	The list of notification types added (or re-added) to your socket's subscriptions.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

unsubscribe

Unsubscribes the user from receiving notifications for add/update.

JSON request message structure

unsubscribe {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number,		/* uint32 format */
	"subscriptionTypes": [
		string		/* one of the SubscriptionType values */
	]
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
subscriptionTypes	array[string(SubscriptionType)]	true	The list of notification types you no longer want to receive.

JSON response message structure

unsubscribeResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"invalid": [
		string
	],
	"message": string,
	"removed": [
		string	/* one of the SubscriptionType values */
	],
	"reqId": number		/* uint32 format */
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
invalid	array[string]	error or partial success	A returned list of non-sense you sent to my beuatiful server.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
removed	array[string(SubscriptionType)]	if no error	The list of notification types added (or re-added) to your socket's subscriptions.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).

Users and Groups

getSessionsList

Gets the list of UserSessions for the specified Company.

JSON request message structure

getSessionsList {
	"company": {
		"id": number		/* uint64 format */
	},
	"reqId": number		/* uint32 format */
}

Request
Property	Type	Required	Description
company	object	true	An object to contain the "id" key.
company.id	number(uint64)	true	Unique identifier of the company.
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.

JSON response message structure

getSessionsListResponse {
	"company": {
		"id": number		/* uint64 format */
	},
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number,		/* uint32 format */
	"sessions": [
		{ /* see SessionHandle for details */ }
	]
}

Response
Property	Type	Presence	Description
company	object	if no error	An object which contains only one key "id" when there is no error. The "id" key is the unique identifier of the company to which the array of objects relate.
company.id	number(uint64)	if no error	Unique identifier of the company.
errorCode	number(ErrorCode)	always	The type of error encountered (if any).
errorDetails	object	some errors	An object to provide developers with a hint about the nature of the error.
message	string	always	Using the errorCode as a guide, the message property is a human readable field that can be used to debug.
reqId	number(uint32)	if given	The request identifier sent by the client. (only returned if given).
sessions	array[SessionHandle]	if no error	The list of sessions.

getSessionsListByUser

Gets the list of UserSessions for the specified Company.

JSON request message structure

getSessionsListByUser {
	"reqId": number,		/* uint32 format */
	"user": {
		"login": string		/* email format */
	}
}

Request
Property	Type	Required	Description
reqId	number(uint32)	optional	An optional integer used to correlate requests with responses.
user	object	true	An object to contain the "login" key.
user.login	string(email)	true	Username of the user.

JSON response message structure

getSessionsListByUserResponse {
	"errorCode": number,		/* one of the ErrorCode values */
	"errorDetails": {
	},
	"message": string,
	"reqId": number,		/* uint32 format */
	"sessions": [
		{ /* see SessionHandle for details */ }
	],
	"user": {
		"company": number,		/* uint64 format */
		"login": string		/* email format */
	}
}

Response
Property	Type	Presence	Description
errorCode	number(ErrorCode)	always

WebSocket API Reference

Service Commands

API Definitions

connection

JSON request message structure

JSON response message structure

getProviderConfigType

JSON request message structure

JSON response message structure

getProviderConfigTypesList

JSON request message structure

JSON response message structure

getTimezone

JSON request message structure

JSON response message structure

getTimezonesList

JSON request message structure

JSON response message structure

noop

JSON request message structure

JSON response message structure

Assets

getAsset

JSON request message structure

JSON response message structure

getAssetsList

JSON request message structure

JSON response message structure

getAssetsListByReference

JSON request message structure

JSON response message structure

getAssetsListByReferences

JSON request message structure

JSON response message structure

mergeAsset

JSON request message structure

JSON response message structure

removeAsset

JSON request message structure

JSON response message structure

restoreAsset

JSON request message structure

JSON response message structure

reviveAsset

JSON request message structure

JSON response message structure

suspendAsset

JSON request message structure

JSON response message structure

Behaviours

clearBehaviourLogsByAsset

JSON request message structure

JSON response message structure

clearBehaviourLogsByBehaviour

JSON request message structure

JSON response message structure

clearBehaviourLogsByScript

JSON request message structure

JSON response message structure

getBehaviour

JSON request message structure

JSON response message structure

getBehaviourLogsListByAsset

JSON request message structure

JSON response message structure

getBehaviourLogsListByBehaviour

JSON request message structure

JSON response message structure

getBehaviourLogsListByScript

JSON request message structure

JSON response message structure

getBehaviourScript

JSON request message structure

JSON response message structure

getBehaviourScriptsList

JSON request message structure

JSON response message structure

getBehavioursList

JSON request message structure

JSON response message structure