connectionResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"expiry": string, /* datetime format */
"ghostId": string,
"message": string,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"reqId": number, /* uint32 format */
"serverTime": string, /* datetime format */
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"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
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
},
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
}
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 {
"providerConfigType": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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": ProviderDataUnits,
"value": object
}
},
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
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 {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getProviderConfigTypesListResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerConfigTypes": [
{ /* see ProviderConfigurationType for details */ }
],
"reqId": number /* uint32 format */
}
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 {
"reqId": number, /* uint32 format */
"timezone": {
"code": string
}
}
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. |
getTimezoneResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"timezone": {
"code": string,
}
}
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 {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getTimezonesListResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"timezones": [
{ /* see Timezone for details */ }
]
}
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 {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
noopResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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). |
getAsset {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reference": string,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"references": {
string: string,
},
"reqId": number /* uint32 format */
}
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{ | 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. |
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 */
}
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{ | 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 {
"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 */
}
Property | Type | Required | Description |
---|---|---|---|
asset | object | always | A simple object to contain the asset parameters. |
asset.attributes | object{ | 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 codifiedAssetAttribute.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{ | 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. |
mergeAssetResponse {
"asset": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
clearBehaviourLogsByAsset {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
clearBehaviourLogsByAssetResponse {
"asset": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"behaviour": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviourScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
clearBehaviourLogsByScriptResponse {
"behaviourScript": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"behaviour": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviour": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviourScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviourScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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{ | 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. |
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 */
}
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 {
"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 */
}
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{ | 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. |
mergeBehaviourScriptResponse {
"behaviourScript": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"behaviour": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviourScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviour": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"behaviourScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getBillingProfile {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingReport": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingDiscount": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingLicense": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingRule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeBillingProfileResponse {
"billingProfile": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"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 */
}
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. |
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 */
}
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 {
"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 */
}
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. |
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 */
}
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 {
"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 */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingReport": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingDiscount": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingLicense": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingRule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingProfile": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"billingReport": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingDiscount": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingLicense": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hostingRule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getCompaniesList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"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 */
}
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 {
"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": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"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 */
}
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. |
mergeCompanyResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
removeCompanyResponse {
"company": {
"deleted": boolean,
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
restoreCompanyResponse {
"company": {
"deleted": boolean,
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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). |
getContact {
"contact": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeContactResponse {
"contact": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"contact": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"contact": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getDispatchTask {
"dispatchTask": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reference": string,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reference": string,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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{ | 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 {
"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 */
}
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{ | 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. |
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 */
}
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). |
multiMergeDispatchTask {
"dispatchTasks": [
],
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
dispatchTasks | array[] | always | This array contains mergeDispatchTask.dispatchTask objects. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
multiMergeDispatchTaskResponse {
"dispatchTasks": [
],
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
dispatchTasks | array[] | if no error | An object which contains each mergeDispatchTask command response. |
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). |
multiRemoveDispatchTask {
"dispatchTasks": [
],
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
dispatchTasks | array[] | always | This array contains removeDispatchTask.dispatchTask objects. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
multiRemoveDispatchTaskResponse {
"dispatchTasks": [
],
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
dispatchTasks | array[] | if no error | An object which contains each removeDispatchTask command response. |
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 {
"dispatchTask": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"dispatchTask": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getDocument {
"document": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"document": {
"expiry": string, /* datetime format */
"id": number, /* uint64 format */
"name": string,
"notes": string,
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
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. |
mergeDocumentResponse {
"document": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"document": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"document": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getHosCarrier {
"hosCarrier": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hosEvent": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hosInspection": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeHosCarrierResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"hosCarrier": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"hosCarrier": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"hosCarrier": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getIcon {
"icon": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeIconResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"icon": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"icon": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"icon": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getMaintenanceJob {
"maintenanceJob": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"after": string, /* datetime format */
"before": string, /* datetime format */
"company": {
"id": number /* uint64 format */
},
"pending": boolean,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"after": string, /* datetime format */
"asset": {
"id": number /* uint64 format */
},
"before": string, /* datetime format */
"pending": boolean,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"after": string, /* datetime format */
"before": string, /* datetime format */
"maintenanceSchedule": {
"id": number /* uint64 format */
},
"pending": boolean,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"maintenanceSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeMaintenanceJobResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"maintenanceJob": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"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 */
}
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{ | 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. |
mergeMaintenanceScheduleResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"maintenanceSchedule": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"maintenanceJob": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"maintenanceSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"maintenanceJob": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"maintenanceSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getAssetMessage {
"assetMessage": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"asset": {
"id": number /* uint64 format */
},
"folder": string, /* one of the MessageFolder values */
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"folder": string, /* one of the MessageFolder values */
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
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 */
}
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). |
multiMergeAssetMessage {
"assetMessages": [
],
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
assetMessages | array[] | always | This array contains mergeAssetMessage.assetMessage objects. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
multiMergeAssetMessageResponse {
"assetMessages": [
],
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
assetMessages | array[] | if no error | An object which contains each mergeAssetMessage command response. |
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 {
"assetMessage": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
restoreAssetMessage {
"assetMessage": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
restoreAssetMessageResponse {
"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 */
}
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 false |
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). |
getPicture {
"picture": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergePictureResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"picture": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"picture": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"picture": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getPlace {
"place": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reference": string,
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergePlaceResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"place": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"place": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"place": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getProvider {
"provider": {
"id": string
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getProviderRegistration {
"providerRegistration": {
"code": string /* uint32 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
providerRegistration | object | true | An object to contain the "code" key. |
providerRegistration.code | string(uint32) | true | Key code of the registration. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getProviderRegistrationResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerRegistration": {
"asset": number, /* uint64 format, see Asset.id */
"code": string,
"company": number, /* uint64 format, see Company.id */
"completed": string, /* datetime format */
"config": number, /* uint64 format, see ProviderConfig.id */
"expires": string, /* datetime format */
"identifier": string, /* see Provider.id */
"kind": string, /* one of the ProviderType values */
"name": string,
"notes": string,
"password": string,
"phoneNumber": number, /* uint64 format */
"since": string, /* datetime format */
"user": string /* email format, see User.login */
},
"reqId": number /* uint32 format */
}
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. |
providerRegistration | ProviderRegistration | if no error | The requested Provider Registration. |
reqId | number(uint32) | if given | The request identifier sent by the client. (only returned if given). |
getProviderRegistrationsList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
getProviderRegistrationsListResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerRegistrations": [
{ /* see ProviderRegistration for details */ }
],
"reqId": number /* uint32 format */
}
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. |
providerRegistrations | array[ProviderRegistration] | if no error | The list of pending device registrations. |
reqId | number(uint32) | if given | The request identifier sent by the client. (only returned if given). |
getProviderRegistrationsListByKind {
"company": {
"id": number /* uint64 format */
},
"kind": string, /* one of the ProviderType values */
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
company | object | true | An object to contain the "id" key. |
company.id | number(uint64) | true | Unique identifier of the company. |
kind | string(ProviderType) | true | The type of device. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getProviderRegistrationsListByKindResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"kind": string, /* one of the ProviderType values */
"message": string,
"providerRegistrations": [
{ /* see ProviderRegistration for details */ }
],
"reqId": number /* uint32 format */
}
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. |
kind | string(ProviderType) | if no error | The type of device. |
message | string | always | Using the errorCode as a guide, the message property is a human readable field that can be used to debug. |
providerRegistrations | array[ProviderRegistration] | if no error | The list of pending device registrations. |
reqId | number(uint32) | if given | The request identifier sent by the client. (only returned if given). |
getProviderScript {
"providerScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeProviderResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"provider": {
"company": number, /* uint64 format */
"id": string
},
"reqId": number /* uint32 format */
}
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 {
"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 */
}
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{ | 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. |
mergeProviderConfigResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerConfig": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"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 */
}
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{ | 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. |
mergeProviderConfigurationResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerConfig": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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). |
mergeProviderRegistration {
"providerRegistration": {
"asset": number, /* uint64 format */
"config": number, /* uint64 format */
"identifier": string,
"lifetime": string, /* duration format */
"name": string,
"notes": string,
"password": string,
"phoneNumber": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
providerRegistration | object | true | A simple object to contain the registration parameters. |
providerRegistration.asset | number(uint64) | optional | The asset for which the device provides data. |
providerRegistration.config | number(uint64) | true | The identifier of the configuration loaded onto the device. |
providerRegistration.identifier | string | optional | The unique identifier of the device that will complete this registration. |
providerRegistration.lifetime | string(duration) | optional | Default is 10 minutes. Can be specified as up to 2 months to allow for long term deployments. |
providerRegistration.name | string | optional | A name to assign to the provider once it's been programmed. |
providerRegistration.notes | string | optional | Notes about the provider once it's been programmed. |
providerRegistration.password | string | optional | The password programmed on the device used to ensure the system is the only client authorized to make changes. |
providerRegistration.phoneNumber | number(uint64) | optional | The device's phone number if known before provisioning. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
mergeProviderRegistrationResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerRegistration": {
"asset": number, /* uint64 format, see Asset.id */
"code": string,
"company": number, /* uint64 format, see Company.id */
"completed": string, /* datetime format */
"config": number, /* uint64 format, see ProviderConfig.id */
"expires": string, /* datetime format */
"identifier": string, /* see Provider.id */
"kind": string, /* one of the ProviderType values */
"name": string,
"notes": string,
"password": string,
"phoneNumber": number, /* uint64 format */
"since": string, /* datetime format */
"user": string /* email format, see User.login */
},
"reqId": number /* uint32 format */
}
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. |
providerRegistration | ProviderRegistration | if no error | The pending device registration. |
reqId | number(uint32) | if given | The request identifier sent by the client. (only returned if given). |
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 */
}
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{ | 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. |
mergeProviderScriptResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerScript": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"provider": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
removeProviderRegistration {
"providerRegistration": {
"code": string /* uint32 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
providerRegistration | object | true | An object to contain the "code" key. |
providerRegistration.code | string(uint32) | true | Key code of the registration. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
removeProviderRegistrationResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"providerRegistration": {
"code": string, /* uint32 format */
"company": number, /* uint64 format */
"deleted": boolean
},
"reqId": number /* uint32 format */
}
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. |
providerRegistration | object | if no error | An object which contains only three keys, and is only present when there is no error. |
providerRegistration.code | string(uint32) | if no error | Key code of the registration. |
providerRegistration.company | number(uint64) | if no error | Unique identifier of the company. |
providerRegistration.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always true |
reqId | number(uint32) | if given | The request identifier sent by the client. (only returned if given). |
removeProviderScript {
"providerScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"provider": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerConfig": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"providerScript": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"provider": {
"id": string
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"provider": {
"id": string
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getReportResult {
"reportResult": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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, /* codified format, see Timezone.code */
"totals": [
ReportDataTotal
],
"type": string, /* one of the ReportType values */
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportTemplate": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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, /* codified format, see Timezone.code */
"weekday": number, /* uint8 format */
"weekdays": [
boolean
]
},
"template": number, /* uint64 format, see ReportTemplate.id */
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportTemplate": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportTemplate": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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 */
}
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. |
mergeReportResultResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reportResult": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"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, /* codified format, see Timezone.code */
"weekday": number, /* uint8 format */
"weekdays": [
boolean
]
},
"template": number, /* uint64 format */
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"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, /* codified format, 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 */
}
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. |
mergeReportTemplateResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reportTemplate": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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 {
"reportResult": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportTemplate": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportResult": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportSchedule": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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 {
"reportTemplate": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */
}
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). |
getSessionDetails {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"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
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
},
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
}
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 {
"password": string,
"reqId": number, /* uint32 format */
"userAgent": string,
"username": string /* email format */
}
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. |
loginResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"expiry": string, /* datetime format */
"ghostId": string,
"message": string,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"reqId": number, /* uint32 format */
"serverTime": string, /* datetime format */
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"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
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
},
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
}
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 {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
logoutResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"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 */
}
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. |
updateOwnContactResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"current": string,
"password": string,
"reqId": number /* uint32 format */
}
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. |
updateOwnPasswordResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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 {
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"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
}
Property | Type | Required | Description |
---|---|---|---|
formats | object{ | 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{ | 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{ | 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. |
updateOwnPreferencesResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
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). |
getSubscriptionsList {
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getSubscriptionsListResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"subscriptions": [
{ /* see Subscription for details */ }
]
}
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. |
subscribe {
"company": {
"id": number /* uint64 format */
},
"reqId": number, /* uint32 format */
"subscriptionTypes": [
string /* one of the SubscriptionType values */
]
}
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. |
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 */
}
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 {
"company": {
"id": number /* uint64 format */
},
"reqId": number, /* uint32 format */
"subscriptionTypes": [
string /* one of the SubscriptionType values */
]
}
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. |
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 */
}
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). |
getMachine {
"machine": {
"key": string
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
machine | object | true | An object to contain the "key" key. |
machine.key | string | true | The unique identifier of the Service Account. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getMachineResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"machine": {
"company": number, /* uint64 format, see Company.id */
"enabled": boolean,
"formats": {
string /* codified format */ : string
},
"groups": [
number /* uint64 format, see UserGroup.id */
],
"insecure": boolean,
"ipRanges": [
string /* ipv4 format */
],
"key": string,
"language": string,
"measurements": {
string /* codified format */ : string /* one of the SystemsOfUnits values */
},
"nickname": string,
"notAfter": string, /* datetime format */
"notBefore": string, /* datetime format */
"notes": string,
"options": {
string /* codified format */ : 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 */
}
],
"referrers": [
string
],
"secret": string,
"services": [
string
],
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
},
"message": string,
"reqId": number /* uint32 format */
}
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. |
machine | Machine | if no error | The requested Service Account. |
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). |
getMachinesList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
getMachinesListResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"machines": [
{ /* see Machine for details */ }
],
"message": string,
"reqId": number /* uint32 format */
}
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. |
machines | array[Machine] | if no error | The list of Service Accounts. |
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). |
getSessionsList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
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 */ }
]
}
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 {
"reqId": number, /* uint32 format */
"user": {
"login": string /* email format */
}
}
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. |
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 */
}
}
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). |
sessions | array[SessionHandle] | if no error | The list of sessions. |
user | object | if no error | An object which contains the "login" and "company" keys when there is no error. The "login" key is the username of the user to which the array of objects relate. |
user.company | number(uint64) | if no error | Unique identifier of the company. |
user.login | string(email) | if no error | User's email address. |
getUser {
"reqId": number, /* uint32 format */
"user": {
"login": string /* email format */
}
}
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 | The unique identifier of the user. |
getUserResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"user": {
"company": number, /* uint64 format, see Company.id */
"contact": number, /* uint64 format, see Contact.id */
"enabled": boolean,
"formats": {
string /* codified format */ : string
},
"groups": [
number /* uint64 format, see UserGroup.id */
],
"language": string,
"login": string, /* email format */
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"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 */
}
],
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
],
"v[0]": uint32,
"v[1]": uint32
}
}
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). |
user | User | if no error | The requested user. |
getUserGroup {
"reqId": number, /* uint32 format */
"userGroup": {
"id": number, /* uint64 format */
"v": [
number /* uint32 format */
]
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
userGroup | object | true | An object to contain the "id" key. |
userGroup.id | number(uint64) | true | Unique identifier of the group. |
userGroup.v | array[number(uint32)] | false | The group version keys used to validate synchronization. |
getUserGroupResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"userGroup": {
"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 */
]
}
}
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). |
userGroup | UserGroup | if no error | The requested UserGroup. |
getUserGroupsList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
getUserGroupsListResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"userGroups": [
{ /* see UserGroup for details */ }
]
}
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). |
userGroups | array[UserGroup] | if no error | The list of UserGroups. |
getUsersList {
"company": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
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. |
getUsersListResponse {
"company": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"users": [
{ /* see User for details */ }
]
}
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). |
users | array[User] | if no error | The list of users. |
killSession {
"reqId": number, /* uint32 format */
"session": {
"handle": string
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
session | object | true | An object to contain the "id" key. |
session.handle | string | true | The handle of the session you want to kill. |
killSessionResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"session": {
"company": number, /* uint64 format */
"handle": string,
"user": string /* email format */
}
}
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). |
session | object | if no error | An object which contains only one key "handle" when there is no error. |
session.company | number(uint64) | if no error | Unique identifier of the company to which the user belonged. |
session.handle | string | if no error | The identifier of the session which was killed. |
session.user | string(email) | if no error | The unique identifier of the user to whom the session belonged. |
mergeMachine {
"machine": {
"company": number, /* uint64 format */
"enabled": boolean,
"formats": {
string: string,
},
"groups": [
number /* uint64 format */
],
"ipRanges": [
string /* ipv4 format */
],
"key": string,
"language": string,
"measurements": {
string: string, /* one of the SystemsOfUnits values */
},
"nickname": string,
"notes": string,
"options": {
string: 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 */
}
],
"referrers": [
string /* url format */
],
"secret": bool,
"services": [
string /* url format */
],
"timezone": string,
"v": [
number /* uint32 format */
]
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
machine | object | always | A simple object to contain the Service Account parameters. |
machine.company | number(uint64) | create | The company to which this Service Account belongs. |
machine.enabled | boolean | optional | Indicates that the Service Account can make requests of the system. |
machine.formats | object{ | optional | Formatting help for dates, times, numbers. |
machine.groups | array[number(uint64)] | optional | List of groups of which this Service Account is a member. |
machine.ipRanges | array[string(ipv4)] | optional | Restrict service access to only the provided IPv4 ranges (using CIDR slash-notation). |
machine.key | string | update | The unique identifier of the Service Account you want to update. |
machine.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". |
machine.measurements | object{ | optional | Preferred way of displaying ambiguous numbers in the context of measurements. |
machine.nickname | string | optional | An optional nickname for this Service Account. |
machine.notes | string | optional | Optional notes for this Service Account. |
machine.options | object{ | 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. |
machine.permissions | array[UserPermission] | optional | A list of permissions assigned specifically to this Service Account. These permissions override any group permissions. |
machine.referrers | array[string(url)] | optional | Optional list of your managed domains from which this service account can be used. |
machine.secret | bool | optional | When true, the system will generate a new API secret used to hash requests. When false, will remove the API secret so that hashing is disabled. |
machine.services | array[string(url)] | optional | List of Fleet Freedom service URIs that this service account is permitted to access. |
machine.timezone | string | optional | The Service Account's local timezone code used to calculate times. |
machine.v | array[number(uint32)] | update | The Service Account version keys used to validate synchronization. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
mergeMachineResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"machine": {
"company": number, /* uint64 format */
"key": string
},
"message": string,
"reqId": number /* uint32 format */
}
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. |
machine | object | if no error | An object which contains the "key" and "company" keys when there is no error. |
machine.company | number(uint64) | if no error | Unique identifier of the company. |
machine.key | string | if no error | The unique identifier of the Service Account. |
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). |
mergeUser {
"reqId": number, /* uint32 format */
"user": {
"company": number, /* uint64 format */
"contact": number, /* uint64 format */
"enabled": boolean,
"formats": {
string: string,
},
"groups": [
number /* uint64 format */
],
"language": string,
"login": string, /* email format */
"measurements": {
string: 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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
},
"options": {
string: string,
},
"password": string,
"passwordExpired": boolean,
"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 */
}
],
"timezone": string,
"v": [
number /* uint32 format */
]
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
user | object | always | A simple object to contain the user parameters. |
user.company | number(uint64) | create | The company to which this user belongs. |
user.contact | number(uint64) | optional | The contact card for this user. |
user.enabled | boolean | optional | Indicates that the user can login to the system. If set to false, all sessions belonging to this user are automatically killed. |
user.formats | object{ | optional | Formatting help for dates, times, numbers. |
user.groups | array[number(uint64)] | optional | List of groups of which this user is a member. |
user.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". |
user.login | string(email) | create or update | The unique identifier of the user you want to update. |
user.measurements | object{ | optional | Preferred way of displaying ambiguous numbers in the context of measurements. |
user.nickname | string | optional | In case no contact is chosen for this user, a nickname can be used for reference. |
user.notify | UserNotifications | optional | Notification preferences. |
user.options | object{ | 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. |
user.password | string | create | The password must conform to the company's password policy. |
user.passwordExpired | boolean | optional | Indicates that the user must change their password on their next connection to the socket. If set to true, it cannot be set to false. |
user.permissions | array[UserPermission] | optional | A list of permissions assigned specifically to this user. These permissions override any group permissions. |
user.timezone | string | optional | The user's local timezone code used to calculate times. |
user.v | array[number(uint32)] | update | The user version keys used to validate synchronization. |
mergeUserResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"user": {
"company": number, /* uint64 format */
"login": string /* email format */
}
}
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). |
user | object | if no error | An object which contains the "login" and "company" keys when there is no error. |
user.company | number(uint64) | if no error | Unique identifier of the company. |
user.login | string(email) | if no error | The unique identifier of the user. |
mergeUserGroup {
"reqId": number, /* uint32 format */
"userGroup": {
"company": number, /* uint64 format */
"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 */
]
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
userGroup | object | always | A simple object to contain the group parameters. |
userGroup.company | number(uint64) | create | The company to which this group belongs. |
userGroup.id | number(uint64) | update | The unique identifier of the group you want to update. |
userGroup.name | string | create | Name for the group. |
userGroup.notes | string | optional | Notes for the group. |
userGroup.permissions | array[UserPermission] | optional | List of permissions assigned to members of this group. |
userGroup.v | array[number(uint32)] | update | The group version keys used to validate synchronization. |
mergeUserGroupResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"userGroup": {
"company": number, /* uint64 format */
"id": number /* uint64 format */
}
}
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). |
userGroup | object | if no error | An object which contains the "id" and "company" keys when there is no error. |
userGroup.company | number(uint64) | if no error | Unique identifier of the company. |
userGroup.id | number(uint64) | if no error | Unique identifier of the group. |
removeMachine {
"machine": {
"key": string
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
machine | object | true | An object to contain the "key" key. |
machine.key | string | true | Unique identifier of the Service Account. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
removeMachineResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"machine": {
"company": number, /* uint64 format */
"deleted": boolean,
"key": string
},
"message": string,
"reqId": number /* uint32 format */
}
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. |
machine | object | if no error | An object which contains only three keys, and is only present when there is no error. |
machine.company | number(uint64) | if no error | Unique identifier of the company. |
machine.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always true |
machine.key | string | if no error | The unique identifier of the Service Account. |
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). |
removeUser {
"reqId": number, /* uint32 format */
"user": {
"login": string /* email format */
}
}
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 | Unique identifier of the user. |
removeUserResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"user": {
"company": number, /* uint64 format */
"deleted": boolean,
"login": string /* email format */
}
}
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). |
user | object | if no error | An object which contains only three keys, and is only present when there is no error. |
user.company | number(uint64) | if no error | Unique identifier of the company. |
user.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always true |
user.login | string(email) | if no error | The unique identifier of the user. |
removeUserGroup {
"reqId": number, /* uint32 format */
"userGroup": {
"id": number /* uint64 format */
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
userGroup | object | true | An object to contain the "id" key. |
userGroup.id | number(uint64) | true | Unique identifier of the group. |
removeUserGroupResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"userGroup": {
"company": number, /* uint64 format */
"deleted": boolean,
"id": number /* uint64 format */
}
}
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). |
userGroup | object | if no error | An object which contains only three keys, and is only present when there is no error. |
userGroup.company | number(uint64) | if no error | Unique identifier of the company. |
userGroup.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always true |
userGroup.id | number(uint64) | if no error | Unique identifier of the group. |
restoreMachine {
"machine": {
"key": string
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
machine | object | true | An object to contain the "key" key. |
machine.key | string | true | Unique identifier of the Service Account. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
restoreMachineResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"machine": {
"company": number, /* uint64 format */
"deleted": boolean,
"key": string
},
"message": string,
"reqId": number /* uint32 format */
}
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. |
machine | object | if no error | An object which contains only three keys, and is only present when there is no error. |
machine.company | number(uint64) | if no error | Unique identifier of the company. |
machine.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always false |
machine.key | string | if no error | The unique identifier of the Service Account. |
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). |
restoreUser {
"reqId": number, /* uint32 format */
"user": {
"login": string /* email format */
}
}
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 | Unique identifier of the user. |
restoreUserResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"user": {
"company": number, /* uint64 format */
"deleted": boolean,
"login": string /* email format */
}
}
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). |
user | object | if no error | An object which contains only three keys, and is only present when there is no error. |
user.company | number(uint64) | if no error | Unique identifier of the company. |
user.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always false |
user.login | string(email) | if no error | The unique identifier of the user. |
restoreUserGroup {
"reqId": number, /* uint32 format */
"userGroup": {
"id": number /* uint64 format */
}
}
Property | Type | Required | Description |
---|---|---|---|
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
userGroup | object | true | An object to contain the "id" key. |
userGroup.id | number(uint64) | true | Unique identifier of the group. |
restoreUserGroupResponse {
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number, /* uint32 format */
"userGroup": {
"company": number, /* uint64 format */
"deleted": boolean,
"id": number /* uint64 format */
}
}
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). |
userGroup | object | if no error | An object which contains only three keys, and is only present when there is no error. |
userGroup.company | number(uint64) | if no error | Unique identifier of the company. |
userGroup.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always false |
userGroup.id | number(uint64) | if no error | Unique identifier of the group. |
getCompanyReseller {
"companyReseller": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
companyReseller | object | true | An object to contain the "id" key. |
companyReseller.id | number(uint64) | true | Unique identifier of the company. |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
getCompanyResellerResponse {
"companyReseller": {
"contactInfo": {
string: number /* uint64 format, see Contact.id */
},
"domain": string,
"favourite": string,
"gamut": {
string: {
"fill": string,
"stroke": string
}
},
"graphics": {
string: string
},
"icon": string,
"id": number, /* uint64 format, see Company.id */
"languages": [
string
],
"logo": string,
"notifyEmail": {
"incomingAddress": string,
"incomingLogin": string,
"incomingMessageNumber": number, /* uint32 format */
"incomingPort": number, /* uint16 format */
"incomingSecure": boolean,
"incomingType": string,
"outgoingAddress": string,
"outgoingLogin": string,
"outgoingPort": number, /* uint16 format */
"outgoingReplyTo": string, /* email format */
"outgoingSecure": boolean,
"outgoingType": string
},
"notifySms": {
"notifyLimit": number, /* uint16 format */
"phoneNumbers": {
string: array /* uint64 format */
}
},
"parent": number, /* uint64 format, see Company.id */
"recoverBody": string,
"recoverIsHtml": boolean,
"recoverSubject": string,
"serviceName": string,
"termsPreamble": string,
"termsUpdated": string, /* datetime format */
"v": [
number /* uint32 format */
],
"website": {
string: string
}
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
companyReseller | CompanyReseller | if no error | The requested white-labeller. |
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). |
mergeCompanyReseller {
"companyReseller": {
"contactInfo": Dictionary, /* uint64 format */
"email": {
"incomingAddress": string,
"incomingLogin": string,
"incomingMessageNumber": number, /* uint32 format */
"incomingPort": number, /* uint16 format */
"incomingSecure": boolean,
"incomingType": string,
"outgoingAddress": string,
"outgoingLogin": string,
"outgoingPort": number, /* uint16 format */
"outgoingReplyTo": string, /* email format */
"outgoingSecure": boolean,
"outgoingType": string
},
"gamut": Dictionary,
"graphics": Dictionary,
"icon": string,
"id": number, /* uint64 format */
"languages": Array,
"logo": string,
"serviceName": string,
"sms": {
"notifyLimit": number, /* uint16 format */
"phoneNumbers": {
string: array /* uint64 format */
}
},
"termsPreamble": string,
"urn": string,
"v": [
number /* uint32 format */
],
"website": Dictionary
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
companyReseller | object | always | A simple object to contain the company parameters. |
companyReseller.contactInfo | Dictionary(uint64) | create | A list roles/Contact identifiers given to users of the service for things like billing inquiries, technical support, etc. |
companyReseller.email | NotificationServerEmail | create | Incoming and outgoing email server used to send notifications and user generated messages. |
companyReseller.gamut | Dictionary | create | A list of variables/colours given to users of the service to colour labels and places. |
companyReseller.graphics | Dictionary | create | A list of graphics given to users of the service to add to status tags, report templates, etc. |
companyReseller.icon | string | create | Icon for the service. |
companyReseller.id | number(uint64) | update | The unique identifier of the company you want to update. |
companyReseller.languages | Array | create | A list languages supported by the service site(s). |
companyReseller.logo | string | create | Logo for the service. |
companyReseller.serviceName | string | create | Name for the White-label service. |
companyReseller.sms | NotificationServerSms | create | Incoming and outgoing SMS numbers used to send notifications and user generated messages. |
companyReseller.termsPreamble | string | create | A pre-amble to the regular terms of service written by Trak iT Wireless Inc. |
companyReseller.urn | string | create | Domain name for the service. |
companyReseller.v | array[number(uint32)] | update | The company version keys used to validate synchronization. |
companyReseller.website | Dictionary | create | A list of variables/colours used to skin the service site(s). |
reqId | number(uint32) | optional | An optional integer used to correlate requests with responses. |
mergeCompanyResellerResponse {
"companyReseller": {
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
companyReseller | object | if no error | An object which contains only one key "id" when there is no error. |
companyReseller.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). |
removeCompanyReseller {
"companyReseller": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
companyReseller | object | always | A simple object to contain the company parameters. |
companyReseller.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. |
removeCompanyResellerResponse {
"companyReseller": {
"deleted": boolean,
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
companyReseller | object | if no error | An object which contains only one key "id" when there is no error. |
companyReseller.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always true |
companyReseller.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). |
restoreCompanyReseller {
"companyReseller": {
"id": number /* uint64 format */
},
"reqId": number /* uint32 format */
}
Property | Type | Required | Description |
---|---|---|---|
companyReseller | object | always | A simple object to contain the company parameters. |
companyReseller.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. |
restoreCompanyResellerResponse {
"companyReseller": {
"deleted": boolean,
"id": number /* uint64 format */
},
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": {
},
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Presence | Description |
---|---|---|---|
companyReseller | object | if no error | An object which contains only one key "id" when there is no error. |
companyReseller.deleted | boolean | if no error | Indicates whether the object is deleted. Value is always false |
companyReseller.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). |
Property | Type | Description |
---|---|---|
lat | number(double) | Latitude |
lng | number(double) | Longitude |
{
"east": number, /* double format */
"north": number, /* double format */
"south": number, /* double format */
"west": number /* double format */
}
Property | Type | Description |
---|---|---|
east | number(double) | Eastern longitude |
north | number(double) | Northern latitude |
south | number(double) | Southern latitude |
west | number(double) | Western longitude |
Property | Type | Description |
---|---|---|
x | number(double) | Horizontal coordinate |
y | number(double) | Vertical coordinate |
Property | Type | Description |
---|---|---|
height | number(double) | Height |
width | number(double) | Width |
{
"bottom": number, /* double format */
"left": number, /* double format */
"right": number, /* double format */
"top": number /* double format */
}
Property | Type | Description |
---|---|---|
bottom | number(double) | Lowest vertical coordinate |
left | number(double) | Left-most horizontal coordinate |
right | number(double) | Right-most horizontal coordinate |
top | number(double) | Highest vertical coordinate |
{
"code": string,
"dst": boolean,
"name": string,
"offset": number /* uint16 format */
}
Property | Type | Description |
---|---|---|
code | string | Unique timezone code |
dst | boolean | Indicates whether this timezone abides by daylight savings |
name | string | Common timezone name |
offset | number(uint16) | Minutes offset from GMT |
{
"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 */
}
Property | Type | Description |
---|---|---|
attributes | object{ | A list of attributes given to this asset by the connection device such as wiring state, VBus, etc. |
colour | string max-length: 22 | Primary colour of the vehicle (given in 24bit hex; #RRGGBB) |
company | number(uint64) | The company to which this asset belongs. See: Company.id |
contact | number(uint64) | A reference to their Company's Contact information. See: Contact.id |
engineHours | number(double) | The cumulative duration that the vehicle's engine has been running (in decimal hours). |
icon | number(uint64) | The icon that represents this asset on the map and in lists. See: Icon.id |
id | number(uint64) | Unique identifier of this asset. |
kind | string(AssetType) | Type of asset. |
labels | array[string] | Codified label names. |
make | string max-length: 50 | Manufacturer's name. |
messagingAddress | string max-length: 254 | The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email. |
model | string max-length: 50 | Manufacturer's model name/number. |
name | string max-length: 100 | This thing's name. |
notes | string | Notes about it. |
odometer | number(double) | The cumulative distance travelled in kilometres. |
pictures | array[number(uint64)] | A list of photos of this thing. |
places | object{ | The current state of this asset's interaction with known Places. |
plate | string max-length: 50 | The license plate. |
position | Position | The things GPS coordinates including speed, bearing, and street information. |
providers | array[string] | The list of devices providing events for this asset. |
reference Deprecated since v4.12. Use asset.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
relationships | array[number(uint64)] | A list of assets related to this one; like a Person for a Vehicle (driver). |
serial | string max-length: 50 | Manufacturer's unique identification number for this trailer. |
tags | array[string] | The codified status tag names. |
v | array[number(uint32)] fixed length: 2 | Object version keys used to validate synchronization for different properties. |
v[0] | uint32 | Properties found in the AssetGeneral object. |
v[1] | uint32 | Properties found in the AssetAdvanced object. |
vin | string max-length: 50 | Manufacturer's unique identification number (Vehicle Identification Number). |
year | number(uint16) | Year of manufacturing. |
{
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
attributes | object{ | A list of attributes given to this asset by the connection device such as wiring state, VBus, etc. |
company | number(uint64) | The company to which this asset belongs. See: Company.id |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
odometer | number(double) | The cumulative distance travelled in kilometres. |
places | object{ | The current state of this asset's interaction with known Places. |
position | Position | The things GPS coordinates including speed, bearing, and street information. |
providers | array[string] | The list of devices providing events for this asset. |
relationships | array[number(uint64)] | A list of assets related to this one; like a Person for a Vehicle (driver). |
tags | array[string] | The codified status tag names. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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 */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The related asset which provided this attribute. See: Asset.id |
complex | string | Parse-able/formatted string for complex display. May contain HTML. |
dts | string(datetime) | Date/time stamp from when this attribute was recorded (or reported) by the device. |
global | boolean | When false, indicates that this attribute is used by an internal system and should be left untouched. |
name | string max-length: 100 | Display name of the attribute. |
provider | string | The device which provided this attribute. See: Provider.id |
raw | object | Raw value like 3.76 (volts) or true (on). |
simple | string | Computed/contextual value from the behaviour. Like "3.76 volts" or "on". |
unit | string | Text representation of unit like "°C" or "Km". See: Units |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this asset belonged. |
id | number(uint64) | Unique identifier of this asset. |
{
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"messagingAddress": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this asset belongs. See: Company.id |
icon | number(uint64) | The icon that represents this asset on the map and in lists. See: Icon.id |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
kind | string(AssetType) | Type of asset. |
labels | array[string] | Codified label names. |
messagingAddress | string max-length: 254 | The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email. |
name | string max-length: 100 | This thing's name. |
notes | string | Notes about it. |
pictures | array[number(uint64)] | A list of photos of this thing. |
reference Deprecated since v4.12. Use asset.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
Property | Type | Description |
---|---|---|
enter | string(datetime) | The date/time stamp for when the Asset first began interacting with the Place. |
kind | string(AssetPlaceStatusType) | The kind of interaction. |
latest | string(datetime) | The most recent date/time stamp for the interaction. |
{
"company": number, /* uint64 format */
"icon": number, /* uint64 format */
"id": number, /* uint64 format */
"kind": string, /* one of the AssetType values */
"labels": [
string /* codified format */
],
"name": number, /* uint64 format */
"since": string, /* datetime format */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this asset belonged. |
icon | number(uint64) | The identifier of the icon used to represent this asset in the UI. |
id | number(uint64) | Unique identifier of this asset. |
kind | string(AssetType) | The type of Asset. |
labels | array[string(codified)] | A list of codified label names to categorize/organize this asset. |
name | number(uint64) | Name for the asset. |
since | string(datetime) | Timestamp from when the asset was suspended. |
v | array[number(uint32)] | The asset version keys at the time of suspension. |
{
"company": number, /* uint64 format, see Company.id */
"contact": number, /* uint64 format, see Contact.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"messagingAddress": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this asset belongs. See: Company.id |
contact | number(uint64) | A reference to their Company's Contact information. See: Contact.id |
icon | number(uint64) | The icon that represents this asset on the map and in lists. See: Icon.id |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
kind | string(AssetType) | Type of asset. |
labels | array[string] | Codified label names. |
messagingAddress | string max-length: 254 | The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email. |
name | string max-length: 100 | This thing's name. |
notes | string | Notes about it. |
pictures | array[number(uint64)] | A list of photos of this thing. |
reference Deprecated since v4.12. Use asset.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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
}
}
Property | Type | Description |
---|---|---|
accuracy | number(uint32) | Threshold in meters for the accuracy of a position |
address | string | The road segment description |
altitude | number(double) | Distance in meters from the sea level |
bearing | number(uint16) | Direction of travel |
dts | string(datetime) | The Date/Time of the GPS reading |
lat | number(double) | Latitude |
lng | number(double) | Longitude |
origin | string | Provider Identifier |
speed | number(double) | Speed |
speedLimit | number(double) | The posted speed limit for the road segment |
streetAddress | StreetAddress | A better description of the current road-segment |
{
"city": string,
"country": string,
"isToll": boolean,
"number": string,
"postal": string,
"province": string,
"region": string,
"street": string
}
Property | Type | Description |
---|---|---|
city | string | City name. |
country | string | Country code. Codes should be a value from ISO 3166-1 alpha-2. |
isToll | boolean | Indicates that there is a toll for the current road segment. |
number | string | House number. |
postal | string | Postal or zip code. |
province | string | Province or state code. Codes should be a value from ISO 3166-2. |
region | string | Region name. |
street | string | Full street name. |
{
"colour": string,
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"make": string,
"messagingAddress": string,
"model": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"plate": string,
"reference": string,
"references": {
string: string
},
"serial": string,
"v": [
number /* uint32 format */
],
"year": number /* uint16 format */
}
Property | Type | Description |
---|---|---|
colour | string max-length: 22 | Primary colour of the trailer (given in 24bit hex; #RRGGBB) |
company | number(uint64) | The company to which this asset belongs. See: Company.id |
icon | number(uint64) | The icon that represents this asset on the map and in lists. See: Icon.id |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
kind | string(AssetType) | Type of asset. |
labels | array[string] | Codified label names. |
make | string max-length: 50 | Manufacturer's name. |
messagingAddress | string max-length: 254 | The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email. |
model | string max-length: 50 | Manufacturer's model name/number. |
name | string max-length: 100 | This thing's name. |
notes | string | Notes about it. |
pictures | array[number(uint64)] | A list of photos of this thing. |
plate | string max-length: 50 | The license plate. |
reference Deprecated since v4.12. Use asset.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
serial | string max-length: 50 | Manufacturer's unique identification number for this trailer. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
year | number(uint16) | Year of manufacturing. |
{
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"engineHours": number, /* double format */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
attributes | object{ | A list of attributes given to this asset by the connection device such as wiring state, VBus, etc. |
company | number(uint64) | The company to which this asset belongs. See: Company.id |
engineHours | number(double) | The cumulative duration that the vehicle's engine has been running (in decimal hours). |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
odometer | number(double) | The cumulative distance travelled in kilometres. |
places | object{ | The current state of this asset's interaction with known Places. |
position | Position | The things GPS coordinates including speed, bearing, and street information. |
providers | array[string] | The list of devices providing events for this asset. |
relationships | array[number(uint64)] | A list of assets related to this one; like a Person for a Vehicle (driver). |
tags | array[string] | The codified status tag names. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"colour": string,
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"make": string,
"messagingAddress": string,
"model": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"plate": string,
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
],
"vin": string,
"year": number /* uint16 format */
}
Property | Type | Description |
---|---|---|
colour | string max-length: 22 | Primary colour of the vehicle (given in 24bit hex; #RRGGBB) |
company | number(uint64) | The company to which this asset belongs. See: Company.id |
icon | number(uint64) | The icon that represents this asset on the map and in lists. See: Icon.id |
id | number(uint64) | Unique identifier of this asset. See: Asset.id |
kind | string(AssetType) | Type of asset. |
labels | array[string] | Codified label names. |
make | string max-length: 50 | Manufacturer's name. |
messagingAddress | string max-length: 254 | The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email. |
model | string max-length: 50 | Manufacturer's model name/number. |
name | string max-length: 100 | This thing's name. |
notes | string | Notes about it. |
pictures | array[number(uint64)] | A list of photos of this thing. |
plate | string max-length: 50 | The license plate. |
reference Deprecated since v4.12. Use asset.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
vin | string max-length: 50 | Manufacturer's unique identification number (Vehicle Identification Number). |
year | number(uint16) | Year of manufacturing. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this behaviour belongs. See: Company.id |
filters | string(expression) | A search pattern used to filter the providers which can implement this behaviour. |
id | number(uint64) | Unique identifier of this behaviour. |
name | string max-length: 100 | The name of this behaviour. |
notes | string | Notes. |
parameters | object{ | The list of defined variable name/value pairs for the script requires. |
priority | number(uint8) | The priority flag allows you to define an execution order for all behaviours for a provider. |
script | number(uint64) | The script which this behaviour implements. See: BehaviourScript.id |
targets | string(expression) | The search pattern used to target the assets which will embed this behaviour in their execution context. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"company": number, /* uint64 format */
"id": number, /* uint64 format */
"script": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this behaviour belonged. |
id | number(uint64) | Unique identifier of this behaviour. |
script | number(uint64) | The script this behaviour implemented. |
{
"asset": number, /* uint64 format, see Asset.id */
"behaviour": number, /* uint64 format, see Behaviour.id */
"character": number, /* uint32 format */
"company": number, /* uint64 format, see Company.id */
"dts": string, /* datetime format */
"id": number, /* uint64 format */
"kind": string, /* one of the BehaviourLogType values */
"line": number, /* uint32 format */
"message": string,
"script": number, /* uint64 format, see BehaviourScript.id */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset which whose behaviours created this log entry. See: Asset.id |
behaviour | number(uint64) | The behaviour to which this log message belongs. See: Behaviour.id |
character | number(uint32) | The character column where the error was generated. |
company | number(uint64) | The company to which this log message belongs. See: Company.id |
dts | string(datetime) | When the log entry was generated by the script. |
id | number(uint64) | Unique identifier of this log message. |
kind | string(BehaviourLogType) | The category of message. |
line | number(uint32) | The line number of the script which generated this message. |
message | string | The body of the message. |
script | number(uint64) | The script which generated this log message. See: BehaviourScript.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"behaviour": number, /* uint64 format */
"company": number, /* uint64 format */
"id": number, /* uint64 format */
"script": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
behaviour | number(uint64) | The behaviour to which this log message belonged. |
company | number(uint64) | The company to which the behaviour belonged. |
id | number(uint64) | Unique identifier of this log message. |
script | number(uint64) | The script to which this log message belonged. |
{
"context": string,
"notes": string,
"type": string, /* one of the BehaviourParameterType values */
"value": string
}
Property | Type | Description |
---|---|---|
context | string | Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types. |
notes | string | Usage notes. |
type | string(BehaviourParameterType) | Simple type information for the compiler. |
value | string | The value is given as a string, but parsed into native type when compiled. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this script belongs. See: Company.id |
compiles | boolean | Flag set by the compiler if this code compiles |
fill | string max-length: 22 | The background colour given to this script for easy visual identification (given in 24bit hex; #RRGGBB) |
filters | string(expression) | A list of targeting expressions. These expressions are defaults for derived Behaviours. |
global | boolean | Indicates whether this script is available to child companies. |
graphic | string(codified) max-length: 22 | The codified graphic name given to this script for easy visual identification. |
id | number(uint64) | Unique identifier of this script. |
name | string max-length: 100 | The nickname given to this script. |
notes | string | Usage notes and instructions for users on how best to setup this script. |
parameters | object{ | Listed parameters for the Behaviour function. |
source | string max-length: 8060 | The source code. |
stroke | string max-length: 22 | The text/graphic colour given to this script for easy visual identification (given in 24bit hex; #RRGGBB) |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this script belonged. |
id | number(uint64) | Unique identifier of this script. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
amount | number(double) | Cost per cycle for this plan |
company | number(uint64) | Unique identifier of the Company that owns this hosting rule. See: Company.id |
end | string(datetime) | Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed. |
id | number(uint64) | Unique identifier of this hosting rule. |
limit | number(uint32) | The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited |
name | string max-length: 254 | The name of this billing rule. |
notes | string | Notes about billing this rule. |
percentage | boolean | When true, the amount is used as a percentage value instead of a currency values. |
profile | number(uint64) | Unique identifier of this rule's billing profile. See: BillingProfile.id |
reference | string max-length: 100 | A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans... |
services | array[string(BillableHostingType)] | The type of services being discounted. |
start | string(datetime) | Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed. |
suspended | boolean | Does this hosting rule apply to suspended resources |
targets | string(expression) | Which assets are targetted by this hosting rule |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this hosting discount belonged. |
id | number(uint64) | Unique identifier of this hosting discount. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
amount | number(double) | Cost per cycle for this plan |
company | number(uint64) | Unique identifier of the Company that owns this hosting rule. See: Company.id |
end | string(datetime) | Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed. |
id | number(uint64) | Unique identifier of this hosting rule. |
kind | string(BillableLicenseType) | The type of hardware license |
limit | number(uint32) | The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited |
name | string max-length: 254 | The name of this billing rule. |
notes | string | Notes about billing this rule. |
profile | number(uint64) | Unique identifier of this rule's billing profile. See: BillingProfile.id |
reference | string max-length: 100 | A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans... |
start | string(datetime) | Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed. |
suspended | boolean | Does this hosting rule apply to suspended resources |
targets | string(expression) | Which assets are targetted by this hosting rule |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this hosting license belonged. |
id | number(uint64) | Unique identifier of this hosting license. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
amount | number(double) | Cost per cycle for this plan |
company | number(uint64) | Unique identifier of the Company that owns this hosting rule. See: Company.id |
end | string(datetime) | Date this billing rule is applied until; null means it never ends. These dates are used to determine how much of the cycle is billed. |
id | number(uint64) | Unique identifier of this hosting rule. |
limit | number(uint32) | The number of units to which this billing rule applies. Should be a non-zero value; null means unlimited |
name | string max-length: 254 | The name of this billing rule. |
notes | string | Notes about billing this rule. |
profile | number(uint64) | Unique identifier of this rule's billing profile. See: BillingProfile.id |
reference | string max-length: 100 | A custom field used to refer to an external system. Examples are a cost codes, SOCs, discount plans... |
service | string(BillableHostingType) | The type of service being billed. |
start | string(datetime) | Date this billing rule takes effect. These dates are used to determine how much of the cycle is billed. |
suspended | boolean | Does this hosting rule apply to suspended resources |
targets | string(expression) | Which assets are targetted by this hosting rule |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this hosting rule belonged. |
id | number(uint64) | Unique identifier of this hosting rule. |
Property | Type | Description |
---|---|---|
amount | number(double) | Cost per SMS message sent. Received messages are free. |
limit | number(uint32) | The maximum number of messages sent per cycle |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
billee | number(uint64) | Unique identifier of the Company receiving the bill.
Most of the time, this value is the same as the target. See: Company.id |
company | number(uint64) | Unique identifier of the Company that owns this profile and is sending the bill. See: Company.id |
currency | string(BillingCurrency) | kind of money |
cycle | string(BillingCycle) | Repeating cycle used for generating bills |
cycleEnd | string(datetime) | When should the cycle end (customer cancelled) |
cyclePostDated | boolean | Pro-rated, or post-dated. |
cycleStart | string(datetime) | When is the first day of the billing cycle |
googleServicesEnabled | boolean | Are the Google services available to be proxied by the service? |
id | number(uint64) | Unique identifier of this billing profile |
messages | array[BillableSmsProfile] | SMS messaging tiers |
name | string max-length: 254 | The name for this profile |
notes | string max-length: 1000 | Notes about the billing profile for the billee or target. |
target | number(uint64) | Unique identifier of the Company to which this rule pertains. See: Company.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this billing profile belonged. |
id | number(uint64) | Unique identifier of this billing profile. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
billee | number(uint64) | Unique identifier of the Company receiving the bill. See: Company.id |
company | number(uint64) | The company to which this report belongs and is sending the bill. See: Company.id |
currency | string(BillingCurrency) | Currency being billed in |
endDate | string(datetime) | Last day of the billing cycle |
hostingBreakdown | object{ | Individual amounts per targeted assets used to calculate the results of the report. |
id | number(uint64) | Unique identifier |
name | string max-length: 100 | Name of this report. |
notes | string | Notes about this report. |
profile | number(uint64) | The profile to which this report belongs See: BillingProfile.id |
startDate | string(datetime) | First day of the billing cycle |
status | ErrorCodes | The processing status of this report. (Queued, Running, Completed or Failed) |
summary | array[BillingReportSummary] | Summary contains totals per target for this billee |
total | number(double) | Total amount being billed. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this billing report belonged. |
id | number(uint64) | Unique identifier of this billing report. |
{
"asset": number, /* uint64 format, see Asset.id */
"billableDays": number, /* double format */
"cost": number, /* double format */
"created": string, /* datetime format */
"deleted": string, /* datetime format */
"discount": number, /* double format */
"labels": [
string /* see LabelStyle.code */
],
"name": string,
"notes": string,
"phoneNumbers": [
number /* uint64 format */
],
"providers": [
string /* see Provider.id */
],
"suspended": string, /* datetime format */
"suspendedCost": number, /* double format */
"suspendedDays": number, /* double format */
"suspendedDiscount": number, /* double format */
"total": number, /* double format */
"updatedDts": string /* datetime format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this breakdown instance belongs. See: Asset.id |
billableDays | number(double) | Number of days this Asset is being billed for. |
cost | number(double) | Cost per billing cycle for this asset. |
created | string(datetime) | Indicates when this Asset was created. |
deleted | string(datetime) | Indicates when this Asset was deleted. |
discount | number(double) | Discount applied per billing cycle for this asset. |
labels | array[string] | Codified label names. See: LabelStyle.code |
name | string max-length: 100 | Asset's name. |
notes | string | Notes about the asset. |
phoneNumbers | array[number(uint64)] | The list of phone numbers for this asset. |
providers | array[string] | The list of devices providing events for this asset. See: Provider.id |
suspended | string(datetime) | Indicates when this Asset wass suspended from event processing. |
suspendedCost | number(double) | Cost per billing cycle for suspended asset. |
suspendedDays | number(double) | Number of days this Asset was suspended. |
suspendedDiscount | number(double) | Discount applied per billing cycle for suspended asset. |
total | number(double) | Total amount being billed for this asset. |
updatedDts | string(datetime) | Indicates when this Asset was last updated. |
{
"count": number, /* double format */
"kind": string, /* one of the BillableHostingType values */
"total": number /* double format */
}
Property | Type | Description |
---|---|---|
count | number(double) | Number of items for this service. |
kind | string(BillableHostingType) | Service being billed |
total | number(double) | Total amount being billed for this service. |
{
"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 */
}
Property | Type | Description |
---|---|---|
hostingSummary | array[BillingReportHostingSummary] | Summary contains totals per type of hosting for this target |
name | string max-length: 100 | Target's name. |
notes | string | Notes about the target. |
parent | number(uint64) | The target company's parent. See: Company.id |
target | number(uint64) | The target company to which this summary instance belongs. See: Company.id |
{
"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": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"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
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of the Company. |
labels | object{ | The styles for labels added to Assets, Places, and other things. |
name | string max-length: 100 | The organizational name. |
notes | string | Notes. |
parent | number(uint64) | The unique identifier of this company's parent organization. See: Company.id |
passwordPolicy | PasswordPolicy | The password complexity and expiry policy. |
sessionPolicy | SessionPolicy | The session lifetime policy. |
tags | object{ | The styles for status tags added to Assets. |
userGroups | array[UserGroup] | List of groups available for users of this company. |
v | array[number(uint32)] fixed length: 6 | Object version keys used to validate synchronization for different properties. |
v[0] | uint32 | Properties found in the CompanyGeneral object. |
v[1] | uint32 | Is not yet in use. |
v[2] | uint32 | Is not yet in use. |
v[3] | uint32 | Properties found in the CompanyLabels object. |
v[4] | uint32 | Properties found in the CompanyPolicies object. |
v[5] | uint32 | Properties found in the CompanyReseller object. |
{
"id": number, /* uint64 format */
"id": number, /* uint64 format */
"parent": number, /* uint64 format */
"parent": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of this company. |
parent | number(uint64) | Unique identifier of this parent-organization's company. |
{
"id": number, /* uint64 format */
"id": number, /* uint64 format */
"parent": number, /* uint64 format */
"parent": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of this company. |
parent | number(uint64) | Unique identifier of this parent-organization's company. |
{
"id": number, /* uint64 format, see Company.id */
"name": string,
"notes": string,
"parent": number, /* uint64 format, see Company.id */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of the Company. See: Company.id |
name | string max-length: 100 | The organizational name. |
notes | string | Notes. |
parent | number(uint64) | The unique identifier of this company's parent organization. See: Company.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"id": number, /* uint64 format, see Company.id */
"labels": {
string /* LabelStyle format */ : {
"code": string, /* codified format */
"fill": string,
"graphic": string, /* codified format */
"name": string,
"notes": string,
"stroke": string
}
},
"parent": number, /* uint64 format, see Company.id */
"tags": {
string /* LabelStyle format */ : {
"code": string, /* codified format */
"fill": string,
"graphic": string, /* codified format */
"name": string,
"notes": string,
"stroke": string
}
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of the Company. See: Company.id |
labels | object{ | The styles for labels added to Assets, Places, and other things. |
parent | number(uint64) | The unique identifier of this company's parent organization. See: Company.id |
tags | object{ | The styles for status tags added to Assets. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"id": number, /* uint64 format, see Company.id */
"parent": number, /* uint64 format, see Company.id */
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
},
"sessionPolicy": {
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
id | number(uint64) | Unique identifier of the Company. See: Company.id |
parent | number(uint64) | The unique identifier of this company's parent organization. See: Company.id |
passwordPolicy | PasswordPolicy | The password complexity and expiry policy. |
sessionPolicy | SessionPolicy | The session lifetime policy. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"code": string, /* codified format */
"fill": string,
"graphic": string, /* codified format */
"name": string,
"notes": string,
"stroke": string
}
Property | Type | Description |
---|---|---|
code | string(codified) | The codified name of this style |
fill | string max-length: 22 | The background colour given to this style for easy visual identification (given in 24bit hex; #RRGGBB) |
graphic | string(codified) max-length: 22 | The codified graphic name given to this script for easy visual identification. |
name | string max-length: 100 | The name of this visual style. |
notes | string | Notes! |
stroke | string max-length: 22 | The text/graphic colour given to this style for easy visual identification (given in 24bit hex; #RRGGBB) |
{
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"minimumLength": number /* uint8 format */
}
Property | Type | Description |
---|---|---|
DEFAULT_MINIMUM_LENGTH | number(uint8) | Default minimum length of a password. |
expireMode | string(ExpiryModePolicy) | Defines how passwords expire. |
expireThreshold | number(uint8) | The threshold for expiry. |
includeLetters | boolean | Do passwords require alphabetical characters. |
includeNumbers | boolean | Do passwords require numeric characters. |
includeSpecial | boolean | Do passwords require non-alphanumeric characters. |
includeUpperLower | boolean | Do passwords require upper-case and lower-case letters. |
MINIMUM_LENGTH | number(uint8) | Minimum length of a password; no policy can be set lower than this. |
minimumLength | number(uint8) | The minimum number of characters required. |
{
"applications": [
string
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
}
Property | Type | Description |
---|---|---|
applications | array[string] | The list of applications users are allowed to use to create sessions. |
DEFAULT_LIFETIME_MINUTES | number(int32) | Default lifetime of a session. |
DEFAULT_MAX_SESSIONS | number(uint8) | Default for the maximum sessions per user. |
expireTimeout | number(uint16) | The lifetime duration of a session in minutes. |
idleAllowed | boolean | Defines whether a session should be automatically killed when the connection breaks. |
ipv4Ranges | array[string(ipv4)] | Restrict session creation to only the provided IPv4 ranges (using CIDR slash-notation). Leave blank for Internet access. |
maxSessions | number(uint8) | The maximum number of sessions allowed per user. |
multiUser | string(MultiUserPolicy) | Defines the behaviour of the system when a user creates multiple sessions. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
addresses | object{ max-length of values: 254 | Mailing addresses. Use the object key like a name of the address. Example keys: Home, Work, Park, etc. |
company | number(uint64) | The company to which this contact belongs See: Company.id |
dates | object{ | Date information. Use the object key like a name of the date. Example keys: Birthday, Started Date, Retired On, etc. |
emails | object{ max-length of values: 254 | Email addresses. Use the object key like a name of the address. Example keys: Home, Work, Support, Old, etc. |
id | number(uint64) | Unique identifier of this contact. |
name | string max-length: 100 | The person's name |
notes | string | Notes about this person. |
options | object{ max-length of values: 254 | Uncategorized information. Use the object keys and values however you'd like. |
otherNames | object{ max-length of values: 254 | A collection of other names this person might go by. Use the object key like a name identifier. Example keys: Initials, Nickname, Maiden Name, etc. |
phones | object{ | Phone numbers. Use the object key like a name of the phone number. Example keys: Mobile, Fax, Home, Office, etc. |
pictures | array[number(uint64)] | Pictures of this Contact. |
roles | array[string(codified)] | A list of roles they play in the Company. |
urls | object{ max-length of values: 254 | Websites and other online resources. Use the object key like a name of the address. Example keys: Downloads, Support, FTP, etc. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this contact belonged. |
id | number(uint64) | Unique identifier of this contact. |
{
"tasks": [
{
"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 */
]
}
]
}
Property | Type | Description |
---|---|---|
tasks | array[DispatchTask] | The current list of tasks assigned to the asset. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
address | string max-length: 500 | The street address of where the task must be completed. |
arrived | string(datetime) | The date/time stamp of when the asset arrived at this task. |
asset | number(uint64) | The asset to which this task belongs. See: Asset.id |
attachments | array[number(uint64)] | A list of hosted Document identifiers attached to this task. |
company | number(uint64) | The company to which this task belongs. See: Company.id |
completed | string(datetime) | The date/time stamp of when this task was completed. |
created | string(datetime) | When this task was created. |
duration | string(duration) | The optional expected duration of the work for this task. |
eta | string(datetime) | The optional estimated time of arrival for the asset. |
id | number(uint64) | Unique identifier of this task. |
instructions | string | Instructions (filled out by dispatcher) for the field-employee to help them completed the task. |
latlng | LatLng | The lat/long coordinates of where the task must be completed. |
name | string max-length: 100 | The name of this task or the work needed to be performed. |
notes | string | Notes about the status of the work filled in by field-employee. |
place | number(uint64) | An optional place which can be used as a template instead of providing lat/long coordinates and a street address. See: Place.id |
reference Deprecated since v4.12. Use dispatchTask.references["Reference"] instead. | string max-length: 100 | A custom field used to refer to an external system. Examples are a work order, pick-up, waybill, etc... |
references | object{ max number of values: 10 max-length of keys: 20 max-length of values: 100 | Name/value collections of custom fields used to refer to external systems. |
signatory | string max-length: 100 | The name of the person who signed the task's completion. |
signature | boolean | Indicates whether the task has a signature. |
status | string(TaskStatus) | The progress of this task. |
updatedBy | string | Either the user's login, or provider's identifier that changed this task |
updatedUtc | string(datetime) | Timestamp from the last change made to this task |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"asset": number, /* uint64 format */
"company": number, /* uint64 format */
"id": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this task belonged. |
company | number(uint64) | The company to which the asset belonged. |
id | number(uint64) | Unique identifier of this task. |
{
"altitude": number, /* double format */
"asset": number, /* uint64 format, see Asset.id */
"camera": number, /* uint8 format */
"company": number, /* uint64 format, see Company.id */
"end": string, /* datetime format */
"guid": string,
"heading": number, /* double format */
"kind": string, /* one of the DashcamDataType values */
"latitude": number, /* double format */
"longitude": number, /* double format */
"provider": string, /* see Provider.id */
"speed": number, /* double format */
"start": string /* datetime format */
}
Property | Type | Description |
---|---|---|
altitude | number(double) | Altitude of the start of the resource. |
asset | number(uint64) | Unique identifier of the asset tied to the provider at the time. See: Asset.id |
camera | number(uint8) | Number assigned to the camera that took the image/video. |
company | number(uint64) | Unique identifier of the company of the provider. See: Company.id |
end | string(datetime) | Timestamp of when this resource ended. For images, the start and end and the same. |
guid | string | Unique identifier of this resource. |
heading | number(double) | Heading of the start of the resource. |
kind | string(DashcamDataType) | The type of data being stored. |
latitude | number(double) | Latitude of the start of the resource. |
longitude | number(double) | Longitude of the start of the resource. |
provider | string | Unique identifier of the provider that sent the data. See: Provider.id |
speed | number(double) | Speed of the start of the resource. |
start | string(datetime) | Timestamp of when this resource started. For images, the start and end and the same. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
bytes | number(uint64) | The file-size on the disk. |
company | number(uint64) | The company to which this file belongs. See: Company.id |
expiry | string(datetime) | The date and time this fill will be automatically purged from our system. |
id | number(uint64) | Unique identifier of this file. |
mime | string max-length: 50 | The MIME type of the file. |
name | string max-length: 100 | The file name of this file. |
notes | string | Notes about this file. |
src | string max-length: 200 | The URL/path to find this file. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which the document belonged. |
id | number(uint64) | Unique identifier of this document. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
category | string max-length: 100 | A noun to describe the type of thing represented. Like Truck, Car, Trailer, Hot-Air Balloon, etc... |
company | number(uint64) | The company to which this icon belongs. See: Company.id |
global | boolean | Indicates whether this icon is available to child companies. |
glyphs | array[IconGlyph] | The images used to show the detail of this icon. |
id | number(uint64) | Unique identifier of this icon. |
label | IconLabel | Definition for the name bubble above the icon on a map. |
name | string max-length: 100 | A specific adjective to describe the thing. Like Blue, Red, Empty, Full, etc... |
notes | string | Notes. |
usage | array[string] | A list of things that this icon can be used to represent. Like asset, place, user, etc... |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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 */
}
Property | Type | Description |
---|---|---|
anchor | Point | The offset from the lat/long in pixels. |
layer | string(IconLayer) | The layer on which this glyph is displayed. |
rotates | boolean | Indicates that this glyph rotate based on GPS bearing. |
size | Size | Size of the glyph in pixels. |
src | string | Path to the image. |
tags | array[string] | A list of codified status tag names. Any of the tags must be applied to the asset for the image to appear. |
zIndex | number(uint16) | The z-order of this glyph compared to other glyphs on the same layer. |
{
"align": string,
"anchor": {
"x": number, /* double format */
"y": number /* double format */
},
"colour": string
}
Property | Type | Description |
---|---|---|
align | string | Determines which corner of the label is attached to the anchor. |
anchor | Point | The offset from the lat/long in pixels. |
colour | string | Background colour of the label. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
bytes | number(uint64) | The file-size on the disk. |
company | number(uint64) | The company to which this image belongs. See: Company.id |
focals | array[Square] | A list of focal points in the images like faces. |
id | number(uint64) | Unique identifier of this image. |
name | string max-length: 100 | The file name of this image. |
notes | string | Notes about this image. |
size | Size | Size defined in pixels. |
src | string max-length: 200 | The URL/path to find this image. |
uses | number(uint32) | A count of the times this image was used for something (asset, contact, task, etc). |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
address | StreetAddress | The carrier's physical or incorporated address. |
codes | object{ | Identity code supplied by a regulatory/government body (DOT ID). |
company | number(uint64) | The company to which this carrier information belongs. See: Company.id |
contact | number(uint64) | Contact information for the carrier. See: Contact.id |
id | number(uint64) | Unique identifier of the Carrier. |
logo | number(uint64) | A Picture of the carrier's logo. See: Picture.id |
name | string max-length: 100 | The carrier's registered name. |
notes | string | Notes. |
shiftCycle | string(HosCycle) | Default shift cycle used by the drivers |
timezone | string(codified) | The local timezone of the carrier's address. See: Timezone.code |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this carrier belonged. |
id | number(uint64) | Unique identifier of this carrier. |
{
"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 */
}
Property | Type | Description |
---|---|---|
address | StreetAddress | Geolocation/Written address by driver of where the event took place |
carrier | number(uint64) | The carrier information to which this event belongs. See: HosCarrier.id |
certificationDate | string(datetime) | Date of the records being certified or re-certified by the driver |
code | number(uint8) | Event code |
company | number(uint64) | The company to which this event belongs. See: Company.id |
diagnosticCode | string(HosDiagnosticCode) | Data Diagnostic Event Code |
diagnosticStatus | boolean | Data Diagnostic Event Indicator Status |
distanceSinceGPSFix | number(single) | Distance since last valid coordinates. An integer value between 0 and 6 |
dts | string(datetime) | When the event took place |
engineHours | number(double) | Odometer reading of the tractor at the time of the event |
id | number(uint64) | Unique identifier of the event. |
isCoDriver | boolean | Driver status - Primary/Co-driver |
latitude | string | Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -90.00 and 90.00 |
longitude | string | Single character 'X', single character 'M', single character 'E', or 2-decimal point precision value between -179.99 and 180.00 |
malfunctionCode | string | Malfunction Indicator Code |
malfunctionStatus | boolean | Malfunction Indicator Status |
notes | string | Comments/Annotations entered by the driver/user |
odometer | number(double) | Odometer reading of the tractor at the time of the event |
origin | string(HosEventOrigin) | Event Record origin |
person | number(uint64) | Driver associated with this event See: Person.id |
seqNo | number(uint16) | Event Sequence Id Number |
shiftCycle | string(HosCycle) | Driver's shift cycle |
status | string(HosEventStatus) | Event Record status |
type | number(HosEventType) | Event type |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
vehicle | number(uint64) | Vehicle associated with this event See: Vehicle.id |
violationStatus | boolean | Violation Status |
violationType | string(HosViolationType) | Violation Type |
{
"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 */
}
Property | Type | Description |
---|---|---|
address | StreetAddress | Written address by driver of where the inspection took place |
carrier | number(uint64) | The carrier information to which this inspection report belongs. See: HosCarrier.id |
company | number(uint64) | The company to which this inspection report belongs. See: Company.id |
defects | array[HosInspectionDefect] | List of all defects |
id | number(uint64) | Unique identifier of the inspection reports. |
inspectedOn | string(datetime) | When the inspection took place |
latlng | LatLng | Coordinates where the inspection took place |
odometer | number(double) | Odometer reading of the tractor at the time of the inspection |
person | number(uint64) | Driver who conducted the inspection See: Person.id |
status | string(HosDefectStatus) | Status of all defects |
technician | string max-length: 100 | Name of the (optional) technician/mechanic doing work or inspection. |
techSigned | string(datetime) | If the defects needed to be addressed by a technician/mechanic, his signature will happen at a different time. |
trailers | array[string] | Between 0 and 2 trailers being inspected |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
vehicle | number(uint64) | Tractor being inspected See: Vehicle.id |
{
"area": string, /* one of the HosDefectArea values */
"category": string,
"description": string,
"major": [
string
],
"minor": [
string
]
}
Property | Type | Description |
---|---|---|
area | string(HosDefectArea) | Shows where a defect was located on the rig. |
category | string | The kind of defect |
description | string | A text description of the defect. |
major | array[string] | A list of major flaws as noted for Canadian standards. |
minor | array[string] | A list of minor flaws as noted for Canadian standards. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this icon belonged. |
id | number(uint64) | Unique identifier of this icon. |
{
"asset": number, /* uint64 format, see Asset.id */
"date": string, /* datetime format */
"engineHours": number, /* double format */
"lastJob": number, /* uint64 format */
"odometer": number /* double format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The Vehicle or Trailer to which this recurrence detail belongs. See: Asset.id |
date | string(datetime) | The date of the last calculation. |
engineHours | number(double) | The operating time at the time of the last calculation. |
lastJob | number(uint64) | The last "completed" job related to this schedule interval. |
odometer | number(double) | The odometer at the time of the last calculation. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The Vehicle or Trailer to which this job belongs See: Asset.id |
company | number(uint64) | The company to which this Vehicle or Trailer belongs See: Company.id |
completed | string(datetime) | When was this job created. |
cost | number(double) | How much the job cost in dollars. |
created | string(datetime) | When was this job created. |
duration | string(duration) | Time it took to complete the job. |
engineHours | number(double) | The operating time at the time of the service. |
garage | string max-length: 100 | The name of the garage or service facility where the work is done. |
id | number(uint64) | Unique identifier |
name | string max-length: 100 | The work being done. Like "oil change". |
notes | string | Notes about the job. Like "changed the oil and filter". |
odometer | number(double) | The odometer at the time of the service. |
pictures | array[number(uint64)] | Images taken while performing the work for reference. See: Picture.id |
reference | string max-length: 100 | A reference code used to track this job |
schedule | number(uint64) | The Maintenance Schedule from which this job was created See: MaintenanceSchedule.id |
status | string(MaintenanceJobStatus) | The status of this job. |
technician | string max-length: 100 | The mechanic who performed the work. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"asset": number, /* uint64 format */
"company": number, /* uint64 format */
"id": number, /* uint64 format */
"schedule": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this maintenance job belonged. |
company | number(uint64) | The company to which this maintenance job belonged. |
id | number(uint64) | Unique identifier of this maintenance job. |
schedule | number(uint64) | The maintenance schedule of this maintenance job. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this schedule belongs See: Company.id |
cost | number(double) | The estimated cost for the job cost in dollars. |
duration | string(duration) | The estimated time for the job. |
fill | string max-length: 22 | The fill/background colour of the icon. Should be a hex colour in the format #RRGGBB. |
garage | string max-length: 100 | The name of the garage or service facility where the work is done. |
graphic | string(codified) max-length: 22 | The name of the symbol for this report. |
id | number(uint64) | Unique identifier |
intervals | object{ | The per-asset details calculated by the system to help predict the creation of Maintenance Jobs. |
name | string max-length: 100 | The name of the work to be done. Like "oil change". |
notes | string | Notes about the work to be done. Like "change the oil and oil filter". |
notify | array[string(email)] | List of Users to send notifications. |
predictionDays | number(uint32) min-value: 5 max-value: 180 | The number of days in advance to predict a job will become pending. |
recurDays | number(uint32) | The number of days between service visits. |
recurDistance | number(double) | The amount of mileage between service visits. |
recurEngineHours | number(double) | The number of operating hours between service visits. |
reference | string max-length: 100 | A reference code used to track this job |
stroke | string max-length: 22 | Outline and graphic colour. Should be a hex colour in the format #RRGGBB. |
targets | string(expression) | The targeting expression to select which Vehicles and Trailers require this maintenance work. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this maintenance schedule belonged. |
id | number(uint64) | Unique identifier of this maintenance schedule. |
{
"asset": number, /* uint64 format, see Asset.id */
"body": string,
"company": number, /* uint64 format, see Company.id */
"delivered": string, /* datetime format */
"from": string,
"id": number, /* uint64 format */
"kind": string, /* one of the MemoType values */
"priority": string, /* one of the AlertPriority values */
"processed": string, /* datetime format */
"status": string, /* one of the MemoStatus values */
"subject": string,
"to": string,
"user": string, /* email format, see User.login */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this message relates. See: Asset.id |
body | string | The main contents of the memo. |
company | number(uint64) | The company to which this memo belongs. See: Company.id |
delivered | string(datetime) | Date/time stamp of when the memo was delivered (or sent if delivery information unavailable). |
from | string min-length: 6 max-length: 254 | Sender address |
id | number(uint64) | Unique identifier of this memo. |
kind | string(MemoType) | Protocol type |
priority | string(AlertPriority) | The priority for which this message must send. |
processed | string(datetime) | Date/time stamp of when the memo was processed. |
status | string(MemoStatus) | Lifetime status |
subject | string max-length: 100 | The subject of this message. |
to | string min-length: 6 max-length: 254 | Recipient address |
user | string(email) max-length: 254 | The user who sent/received this message. See: User.login |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this message relates. See: Asset.id |
body | string | The main contents of the memo. |
company | number(uint64) | The company to which this memo belongs. See: Company.id |
delivered | string(datetime) | Date/time stamp of when the memo was delivered (or sent if delivery information unavailable). |
folder | string(MessageFolder) | The folder under which this message is stored. |
from | string min-length: 6 max-length: 254 | Sender address |
id | number(uint64) | Unique identifier of this memo. |
incoming | boolean | Indicates that this is a received message instead of a sent message. |
kind | string(MemoType) | Protocol type |
processed | string(datetime) | Date/time stamp of when the memo was processed. |
readBy | string(email) max-length: 254 | The user that read this message. This field is blank/null when unread. See: User.login |
status | string(MemoStatus) | Lifetime status |
subject | string max-length: 100 | The subject of this message. |
to | string min-length: 6 max-length: 254 | Recipient address |
user | string(email) max-length: 254 | The user who sent/received this message. See: User.login |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"asset": number, /* uint64 format */
"company": number, /* uint64 format */
"id": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this message belonged. |
company | number(uint64) | The company to which the asset belonged. |
id | number(uint64) | Unique identifier of this message. |
{
"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 */
"responses": [
string
],
"status": string, /* one of the MemoStatus values */
"subject": string,
"to": string,
"user": string, /* email format, see User.login */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this message relates. See: Asset.id |
body | string | The main contents of the memo. |
company | number(uint64) | The company to which this memo belongs. See: Company.id |
delivered | string(datetime) | Date/time stamp of when the memo was delivered (or sent if delivery information unavailable). |
folder | string(MessageFolder) | The folder under which this message is stored. |
from | string min-length: 6 max-length: 254 | Sender address |
id | number(uint64) | Unique identifier of this memo. |
incoming | boolean | Indicates that this is a received message instead of a sent message. |
kind | string(MemoType) | Protocol type |
processed | string(datetime) | Date/time stamp of when the memo was processed. |
readBy | string(email) max-length: 254 | The user that read this message. This field is blank/null when unread. See: User.login |
responses | array[string] | A list of predefined responses a driver can easily read and click without distraction from the road. |
status | string(MemoStatus) | Lifetime status |
subject | string max-length: 100 | The subject of this message. |
to | string min-length: 6 max-length: 254 | Recipient address |
user | string(email) max-length: 254 | The user who sent/received this message. See: User.login |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"body": string,
"company": number, /* uint64 format, see Company.id */
"delivered": string, /* datetime format */
"from": string,
"id": number, /* uint64 format */
"kind": string, /* one of the MemoType values */
"processed": string, /* datetime format */
"provider": string, /* see Provider.id */
"status": string, /* one of the MemoStatus values */
"to": string,
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
body | string | The main contents of the memo. |
company | number(uint64) | The company to which this memo belongs. See: Company.id |
delivered | string(datetime) | Date/time stamp of when the memo was delivered (or sent if delivery information unavailable). |
from | string min-length: 6 max-length: 254 | Sender address |
id | number(uint64) | Unique identifier of this memo. |
kind | string(MemoType) | Protocol type |
processed | string(datetime) | Date/time stamp of when the memo was processed. |
provider | string max-length: 50 | The device to which this command was sent. See: Provider.id |
status | string(MemoStatus) | Lifetime status |
to | string min-length: 6 max-length: 254 | Recipient address |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this picture belonged. |
id | number(uint64) | Unique identifier of this picture. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this place belonged. |
id | number(uint64) | Unique identifier of this 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
}
Property | Type | Description |
---|---|---|
address | string max-length: 200 | Full street address including province/state, country, and postal/zip code. |
anchor | LatLng | General coordinates. Used to place a marker on a map, or a specific door or loading bay for dispatch. |
colour | string max-length: 22 | The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB) |
company | number(uint64) | The company to which this POI belongs. See: Company.id |
icon | number(uint64) | The icon used to display this POI in lists and on the map. See: Icon.id |
id | number(uint64) | Unique identifier of this POI. |
kind | string(ShapeType) | The kind of geography represented by this POI. |
labels | array[string] | The codified names of labels See: LabelStyle.code |
name | string max-length: 100 | POI's common name instead of street address. |
notes | string | Notes! |
pictures | array[number(uint64)] | Images of this POI. |
radius | number(double) | Boundary threshold (in meters). This key is only present for radial shape types. |
reference | string max-length: 100 | A custom field used to refer to an external system. |
v | array[number(uint32)] fixed length: 1 | Object version keys used to validate synchronization for different properties. |
v[0] | uint32 | Properties found in the PlaceGeneral object. |
{
"maxGeofenceCount": number, /* uint32 format */
"maxRadius": number, /* uint32 format */
"minRadius": number, /* uint32 format */
"type": string /* one of the ShapeType values */
}
Property | Type | Description |
---|---|---|
maxGeofenceCount | number(uint32) | The maximum number of unique geofences supported by the device. |
maxRadius | number(uint32) | The largest possible radius for this geofence. |
minRadius | number(uint32) | The smallest possible radius for this geofence. |
type | string(ShapeType) | The supported shape of geofence. |
{
"maxGeofenceCount": number, /* uint32 format */
"type": string /* one of the ShapeType values */
}
Property | Type | Description |
---|---|---|
maxGeofenceCount | number(uint32) | The maximum number of unique geofences supported by the device. |
type | string(ShapeType) | The supported shape of geofence. |
{
"maxGeofenceCount": number, /* uint32 format */
"type": string /* one of the ShapeType values */
}
Property | Type | Description |
---|---|---|
maxGeofenceCount | number(uint32) | The maximum number of unique geofences supported by the device. |
type | string(ShapeType) | The supported shape of geofence. |
{
"maxGeofenceCount": number, /* uint32 format */
"maxVertices": number, /* uint32 format */
"type": string /* one of the ShapeType values */
}
Property | Type | Description |
---|---|---|
maxGeofenceCount | number(uint32) | The maximum number of unique geofences supported by the device. |
maxVertices | number(uint32) | The maximum number of vertices supported by the device. |
type | string(ShapeType) | The supported shape of geofence. |
{
"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
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset for which this device provides field data. See: Asset.id |
attributes | object{ | Often changing values like latitude, longitude, speed, wiring state, VBus information, etc... |
company | number(uint64) | The company to which this device belongs. See: Company.id |
configuration | number(uint64) | The provider's current (or pending) configuration profile. See: ProviderConfig.id |
firmware | string max-length: 100 | The firmware/application version number. |
firmwareStatus | string(ProvisioningStatus) | The system's progress of updating the device's firmware/application. |
geofenceLast | string(datetime) | A timestamp from when the geofence list was successfully updated on the provider. |
geofenceStatus | string(ProvisioningStatus) | The system's progress of updating the device's on-board geofence definitions. |
id | string max-length: 50 | Unique identifier of this device. |
information | object{ | A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc... |
kind | string(ProviderType) | The kind of communication protocol this device uses. |
lastCheckIn | string(datetime) | A timestamp from when the provider last checked for a new script or new geofences. |
lastIP | string(ipv4) | The last IP address of the device. |
name | string max-length: 100 | A nickname given to the device/hardware. |
notes | string | Notes! |
password | string max-length: 50 | The password programmed on the device used to ensure the system is the only client authorized to make changes. |
phoneNumber | number(uint64) | The phone number of this device. |
pnd | string max-length: 50 | The short-name of the kind of PND attached to this device. Leave blank if none. |
scriptLast | string(datetime) | A timestamp from when the script successfully updated on the provider. |
scriptStatus | string(ProvisioningStatus) | The system's progress of updating the device's programming. |
sim | string | ICCID of the SIM card installed in this provider |
snf | object{ | Store-and-forward information like last sequence number of SnF window |
v | array[number(uint32)] fixed length: 2 | Object version keys used to validate synchronization for different properties. |
v[0] | uint32 | Properties found in the ProviderGeneral object. |
v[1] | uint32 | Properties found in the ProviderAdvanced object. |
{
"attributes": {
string /* dictionary format */ : dictionary
},
"company": number, /* uint64 format, see Company.id */
"id": string, /* see Provider.id */
"lastIP": string, /* ipv4 format */
"snf": {
string: string
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
attributes | object{ | Often changing values like latitude, longitude, speed, wiring state, VBus information, etc... |
company | number(uint64) | The company to which this device belongs. See: Company.id |
id | string max-length: 50 | Unique identifier of this device. See: Provider.id |
lastIP | string(ipv4) | The last IP address of the device. |
snf | object{ | Store-and-forward information like last sequence number of SnF window |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this configuration belongs. See: Company.id |
geofences | string(expression) | A search pattern used to filter which Places' geometry are used as geofences. Use null to disable. Use "*" to match all the Places the Provider's Asset can match. Or use "#123456" or "label:term" like other Place search patterns. |
id | number(uint64) | Unique identifier of this configuration. |
name | string max-length: 100 | The nickname given to this configuration |
notes | string | Simple details about how the providers are expected to behave. |
parameters | object{ | The list of defined variable name/value pairs that the script requires. |
script | number(uint64) | The script which this configuration implements. See: ProviderScript.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this configuration belonged. |
id | number(uint64) | Unique identifier of this configuration. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this configuration belongs. See: Company.id |
geofences | array[number(uint64)] | List of Places loaded directly onto the provider. |
id | number(uint64) | Unique identifier of this configuration. |
name | string max-length: 100 | The nickname given to this configuration |
notes | string | Simple details about how the providers are expected to behave. |
scriptParameters | object{ | The list of defined variables given to the |
type | number(uint64) | The logic type which this configuration implements. See: ProviderConfigurationType.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this configuration belonged. |
id | number(uint64) | Unique identifier of this configuration. |
{
"id": string,
"isAdvanced": boolean,
"max": object,
"min": object,
"nodes": {
string: { /* recursive ProviderConfigurationNode objects */ }
},
"notes": string,
"type": string,
"unit": ProviderDataUnits,
"value": object
}
Property | Type | Description |
---|---|---|
id | string | Unique identifier of the value being mapped. |
isAdvanced | boolean | Indicates that this configuration is an advanced property and should only be set by someone who knows what they're doing. |
max | object | The maximum possible value for this confugration node. |
min | object | The minimum possible value for this confugration node. |
nodes | object{ | Child configuration nodes. |
notes | string | Description of what this configuration does when mapped to a device. |
type | string | Type hint used by the script processor to help format the value. |
unit | ProviderDataUnits | Unit hint used to help the script processor format the value. |
value | object | The value being set. |
{
"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": ProviderDataUnits,
"value": object
}
},
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
geofenceTypes | array[] | A list of supported types of geofences which can be programmed directly onto the device. |
id | number(uint64) | Unique identifier. |
maxGeofenceCount | number(uint32) | The maximum number of geofences that can be programmed onto a device. This number changes based on device make and model, and can also change based on the supported geofence types. |
minGeofenceCount | number(uint32) | The minimum number of geofences that need to be programmed onto the device. This value is almost always zero. |
name | string max-length: 100 | Name of the configuration type. |
notes | string | Notes regarding the use of this configuration. |
providerType | string(ProviderType) | The applicable type of provider for which this configuration type can be created. |
scriptOptions | object{ | A tree-structure of configurations required (or optionally available) for programming a device. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"dts": string, /* datetime format */
"unit": string,
"value": object
}
Property | Type | Description |
---|---|---|
dts | string(datetime) | Date/time stamp from when the device recorded (or reported) the data. |
unit | string | The relevant unit for the data provided like Km/h, degrees, volts, RPM, etc... |
value | object | The value of the data given like true, 17.3, "asdf", etc... |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this device belonged. |
id | number(uint64) | Unique identifier of this device. |
{
"asset": number, /* uint64 format, see Asset.id */
"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, /* see Provider.id */
"information": {
string: string
},
"kind": string, /* one of the ProviderType values */
"lastCheckIn": string, /* datetime 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,
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset for which this device provides field data. See: Asset.id |
company | number(uint64) | The company to which this device belongs. See: Company.id |
configuration | number(uint64) | The provider's current (or pending) configuration profile. See: ProviderConfig.id |
firmware | string max-length: 100 | The firmware/application version number. |
firmwareStatus | string(ProvisioningStatus) | The system's progress of updating the device's firmware/application. |
geofenceLast | string(datetime) | A timestamp from when the geofence list was successfully updated on the provider. |
geofenceStatus | string(ProvisioningStatus) | The system's progress of updating the device's on-board geofence definitions. |
id | string max-length: 50 | Unique identifier of this device. See: Provider.id |
information | object{ | A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc... |
kind | string(ProviderType) | The kind of communication protocol this device uses. |
lastCheckIn | string(datetime) | A timestamp from when the provider last checked for a new script or new geofences. |
name | string max-length: 100 | A nickname given to the device/hardware. |
notes | string | Notes! |
password | string max-length: 50 | The password programmed on the device used to ensure the system is the only client authorized to make changes. |
phoneNumber | number(uint64) | The phone number of this device. |
pnd | string max-length: 50 | The short-name of the kind of PND attached to this device. Leave blank if none. |
scriptLast | string(datetime) | A timestamp from when the script successfully updated on the provider. |
scriptStatus | string(ProvisioningStatus) | The system's progress of updating the device's programming. |
sim | string | ICCID of the SIM card installed in this provider |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"asset": number, /* uint64 format, see Asset.id */
"code": string,
"company": number, /* uint64 format, see Company.id */
"completed": string, /* datetime format */
"config": number, /* uint64 format, see ProviderConfig.id */
"expires": string, /* datetime format */
"identifier": string, /* see Provider.id */
"kind": string, /* one of the ProviderType values */
"name": string,
"notes": string,
"password": string,
"phoneNumber": number, /* uint64 format */
"since": string, /* datetime format */
"user": string /* email format, see User.login */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The Asset for which this device will provide data. See: Asset.id |
code | string | A unique six digit code. |
company | number(uint64) | The company to which the device will belong. See: Company.id |
completed | string(datetime) | Date/time stamp of when this registration ended successfully. |
config | number(uint64) | The predefined configuration this device will use. See: ProviderConfig.id |
expires | string(datetime) | The expiry date for this registration. |
identifier | string max-length: 50 | The unique identifier of the device that completed this registration. See: Provider.id |
kind | string(ProviderType) | The kind of protocol this device supports. |
name | string max-length: 100 | A nickname given to the device once it has been provisioned. |
notes | string | Notes! |
password | string max-length: 50 | The password programmed on the device used to ensure the system is the only client authorized to make changes. |
phoneNumber | number(uint64) | The phone number of the device being provisioned. This is set by the user for long-term registrations, or by the client during serial port setup. |
since | string(datetime) | Date/time stamp of when this registration began. |
user | string(email) max-length: 254 | The unique identifier the user who generated this registration. See: User.login |
Property | Type | Description |
---|---|---|
code | number(uint64) | Unique identifier of this device. |
company | number(uint64) | The company to which this device belonged. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
blocks | array[ProviderScriptBlock] | Blocks of file data which are (optionally) included in the script data file. |
company | number(uint64) | The company to which this configuration belongs. See: Company.id |
fill | string max-length: 22 | The fill/background colour of the icon. Should be a hex colour in the format #RRGGBB. |
global | boolean | Indicates whether this script is available to child companies. |
graphic | string(codified) max-length: 22 | The name of the symbol for this report. |
id | number(uint64) | Unique identifier of this configuration. |
kind | string(ProviderType) | The type of provider for which this script can be used. Limiting to a specific model from a manufacturer is accomplished through the block conditions. |
name | string max-length: 100 | The nickname given to this configuration |
notes | string | Simple details about how the providers are expected to behave. |
parameters | object{ | Parameter definitions for this script, including type-hints and default values. |
stroke | string max-length: 22 | Outline and graphic colour. Should be a hex colour in the format #RRGGBB. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"condition": string,
"content": string,
"replace": string,
"validate": string
}
Property | Type | Description |
---|---|---|
condition | string max-length: 50 | When defined, this condition matches a ProviderScriptParameter defined in the ProviderConfig to include or exclude this chunk from the script. |
content | string | A chunk of the file loaded onto a provider with it's variables replaced with configurable variables. Trailing or leading whitespace should be included here, so when blocks are merged, so too is the newline characters. |
replace | string max-length: 20 | A regular expression used to match variables in the content |
validate | string | Used in conjunction with condition, this value must match the given ProviderScriptParameter value to have the chunk included. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this configuration belonged. |
id | number(uint64) | Unique identifier of this configuration. |
{
"advanced": boolean,
"context": string,
"notes": string,
"order": number, /* uint32 format */
"type": string, /* one of the ProviderScriptParameterType values */
"value": string
}
Property | Type | Description |
---|---|---|
advanced | boolean | Used as a hint that this parameter controls an advanced script option and should only be set if you really know what you're doing. |
context | string | Gives a hint to the client on the best UI to use for editing. For example, "checkbox" is a good UI hint for boolean parameter types. |
notes | string | Usage notes. |
order | number(uint32) | The order in which this parameter is displayed compared to other parameters. The value has no effect on how this parameter is inserted into the ProviderScriptBlocks. |
type | string(ProviderScriptParameterType) | Simple type information for the gateway to process. |
value | string | The value is given as a string, but parsed into native type when used by the gateway. |
{
"company": number, /* uint64 format */
"configuration": number, /* uint64 format */
"id": string,
"kind": string, /* one of the ProviderType values */
"name": number, /* uint64 format */
"since": string, /* datetime format */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this device belonged. |
configuration | number(uint64) | The identifier of the configuration loaded onto this device. |
id | string max-length: 50 | Unique identifier of this device. |
kind | string(ProviderType) | The type of device. |
name | number(uint64) | Name for the device. |
since | string(datetime) | Timestamp from when the device was suspended. |
v | array[number(uint32)] | The device version keys at the time of suspension. |
{
"maxGeofenceCount": number, /* uint32 format */
"maxLength": number, /* uint32 format */
"maxWidth": number, /* uint32 format */
"type": string /* one of the ShapeType values */
}
Property | Type | Description |
---|---|---|
maxGeofenceCount | number(uint32) | The maximum number of unique geofences supported by the device. |
maxLength | number(uint32) | The smallest possible diameter for this geofence. |
maxWidth | number(uint32) | The smallest possible diameter for this geofence. |
type | string(ShapeType) | The supported shape of geofence. |
{
"filters": string, /* expression format */
"parameters": [
{
"kind": string, /* one of the AnalyticParameterType values */
"value": string
}
],
"targets": string /* expression format */
}
Property | Type | Description |
---|---|---|
filters | string(expression) | A targeting expression for limiting results which only include data from Assets interacting with the targeted Places. |
parameters | array[AnalyticParameter] | A list of parameters to better shape the results. |
targets | string(expression) | A targeting expression for including/excluding Assets. |
{
"kind": string, /* one of the AnalyticParameterType values */
"value": string
}
Property | Type | Description |
---|---|---|
kind | string(AnalyticParameterType) | The type of argument. |
value | string | The parsed value of the argument. Each type of argument has a different parsing. |
{
"company": number, /* uint64 format, see Company.id */
"fill": string,
"graphic": string, /* codified format */
"id": number, /* uint64 format */
"kind": string, /* one of the AnalyticsType values */
"name": string,
"notes": string,
"options": {
"filters": string, /* expression format */
"parameters": [
{
"kind": string, /* one of the AnalyticParameterType values */
"value": string
}
],
"targets": string /* expression format */
},
"stroke": string,
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this analysis belongs. See: Company.id |
fill | string max-length: 22 | The fill/background colour of the icon. Should be a hex colour in the format #RRGGBB. |
graphic | string(codified) max-length: 22 | The name of the symbol for this report. |
id | number(uint64) | Unique identifier |
kind | string(AnalyticsType) | The type of analysis done. |
name | string max-length: 100 | Name of this report. |
notes | string | Notes about this report. |
options | AnalyticOptions | Specified parameters for the report logic, targeted Assets, and filtering Places. |
stroke | string max-length: 22 | Outline and graphic colour. Should be a hex colour in the format #RRGGBB. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"asset": number, /* uint64 format, see Asset.id */
"company": number, /* uint64 format, see Company.id */
"complete": boolean,
"distance": number, /* double format */
"eventCount": number, /* uint32 format */
"firstState": {
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
},
"firstUtc": string, /* datetime format */
"id": number, /* uint64 format */
"kind": string, /* one of the AnalyticsType values */
"lastState": {
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
},
"lastUtc": string, /* datetime format */
"polyline": string, /* polyline format */
"state": string,
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this analysis belongs. See: Asset.id |
company | number(uint64) | The company to which this analysis belongs. See: Company.id |
complete | boolean | Denotes that an event has been processed to invalidate the sequence and end the summary. |
distance | number(double) | The distance travelled in kilometres by the asset. |
eventCount | number(uint32) | The number of events included in the calculation. |
firstState | AssetAdvanced | The first asset state which begins this summary instance. |
firstUtc | string(datetime) | Timestamp from the first event in the sequence. |
id | number(uint64) | Unique identifier |
kind | string(AnalyticsType) | The type of analysis done. |
lastState | AssetAdvanced | The asset state that ended this summary instance. |
lastUtc | string(datetime) | Timestamp from the last event in the sequence. |
polyline | string(polyline) | An encoded polyline of all the asset's positions in sequence. |
state | string | Code given to this analysis for the asset. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"advanced": {
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
},
"asset": number, /* uint64 format */
"general": {
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"messagingAddress": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
]
},
"instance": number, /* uint32 format */
"summaryInstances": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
advanced | AssetAdvanced | Advanced/detailed information used. |
asset | number(uint64) | The asset to which this event data belongs. |
general | AssetGeneral | General Asset information. |
instance | number(uint32) | Report specific identifier of the event data. |
summaryInstances | array[number(uint32)] | Identifiers of the summary instances that used this event. |
{
"advanced": {
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
},
"asset": number, /* uint64 format */
"general": {
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"messagingAddress": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
]
},
"instance": number, /* uint32 format */
"message": {
"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 */
]
},
"summaryInstances": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
advanced | AssetAdvanced | Advanced/detailed information used. |
asset | number(uint64) | The asset to which this event data belongs. |
general | AssetGeneral | General Asset information. |
instance | number(uint32) | Report specific identifier of the event data. |
message | Message | The Message used. |
summaryInstances | array[number(uint32)] | Identifiers of the summary instances that used this event. |
{
"advanced": {
"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 */
}
},
"company": number, /* uint64 format, see Company.id */
"id": number, /* uint64 format, see Asset.id */
"odometer": number, /* double format */
"places": {
string /* uint64 format */ : {
"enter": string, /* datetime format */
"kind": string, /* one of the AssetPlaceStatusType values */
"latest": string /* datetime format */
}
},
"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
],
"relationships": [
number /* uint64 format */
],
"tags": [
string
],
"v": [
number /* uint32 format */
]
},
"asset": number, /* uint64 format */
"general": {
"company": number, /* uint64 format, see Company.id */
"icon": number, /* uint64 format, see Icon.id */
"id": number, /* uint64 format, see Asset.id */
"kind": string, /* one of the AssetType values */
"labels": [
string
],
"messagingAddress": string,
"name": string,
"notes": string,
"pictures": [
number /* uint64 format */
],
"reference": string,
"references": {
string: string
},
"v": [
number /* uint32 format */
]
},
"instance": number, /* uint32 format */
"summaryInstances": [
number /* uint32 format */
],
"task": {
"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 */
]
}
}
Property | Type | Description |
---|---|---|
advanced | AssetAdvanced | Advanced/detailed information used. |
asset | number(uint64) | The asset to which this event data belongs. |
general | AssetGeneral | General Asset information. |
instance | number(uint32) | Report specific identifier of the event data. |
summaryInstances | array[number(uint32)] | Identifiers of the summary instances that used this event. |
task | DispatchTask | The Task used. |
{
"assets": string, /* expression format */
"users": [
string /* email format */
]
}
Property | Type | Description |
---|---|---|
assets | string(expression) max-length: 255 | A targeting expression to identify which assets receive the report results.
The results emailed to each asset will only be for themselves, not all assets.
To receive the emailed results, the Asset must have a |
users | array[string(email)] max-length: 50 | List of users to send emailed report. Each email will only contain the results for the assets each user is allowed to view. |
{
"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 */
}
Property | Type | Description |
---|---|---|
filtering | string(ReportFilterMode) | The mechanism to use for filtering based on places and regions. |
parameters | array[ReportParameter] | A list of parameters to better shape the results. |
places | string(expression) | A targeting expression for limiting results which only include data from Assets interacting with the targeted Places. |
regions | array[string] | A list of provinces and states, where only assets within those regions will be included in the results. |
scorecardRules | ReportScorecardRules | Rules used to generate scorecard for this report. |
targets | string(expression) | A targeting expression for including/excluding Assets. |
{
"type": string, /* one of the ReportParameterType values */
"value": string
}
Property | Type | Description |
---|---|---|
type | string(ReportParameterType) | The type of argument. |
value | string | The parsed value of the argument. Each type of argument has a different parsing. |
{
"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, /* codified format, see Timezone.code */
"weekday": number, /* uint8 format */
"weekdays": [
boolean
]
}
Property | Type | Description |
---|---|---|
end | string(datetime) | The optional time when the schedule stops recurring in local-time (not UTC). |
iterations | number(uint16) | The number of times this schedule has been invoked to generate results. |
kind | string(ReportRecurrenceType) | How often the report is automatically run. Daily, weekly, monthly, etc... |
lastEndDate | string(datetime) | The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once. |
lastResult | number(uint64) | The unique identifier of the last ReportResult generated by this schedule. |
lastStartDate | string(datetime) | The date/time stamp from the last result used to inform the nextStartDate and nextEndDate properties. This value is null when the schedule has not yet run once. |
nextEndDate | string(datetime) | This date/time is used as the endDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring. |
nextStartDate | string(datetime) | This date/time is used as the startDate ReportParameter for the next iteration of this recurring report. This value is null when the schedule is calculated to stop recurring. |
start | string(datetime) | When the schedule is to begin recurring in local-time (not UTC). |
timezone | string(codified) | The local timezone used to calculate recurring date/time ranges. See: Timezone.code |
weekday | number(uint8) | Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week. |
weekdays | array[boolean] | Used only for daily schedules, this 7 item, boolean array, determines if the schedule should recur on that day of the week. |
{
"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, /* codified format, see Timezone.code */
"totals": [
ReportDataTotal
],
"type": string, /* one of the ReportType values */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
archive | boolean | Preserve these results for later review. Results are regularly culled from the system. |
bounds | LatLngBounds | After processing, the boundary of the results are given so that a map can be focused on that area. |
company | number(uint64) | The company to which this report belongs See: Company.id |
completed | string(datetime) | The date/time this result was finished processing. |
created | string(datetime) | The date/time this result was requested. |
error | string max-length: 250 | A field which contains report error details if the status is failed. See: ReportResult.status |
filtered | array[number(uint64)] | When the report runs, a list of filtered places is calculated based on the ReportOption's place filtering expression. |
id | number(uint64) | Unique identifier |
name | string max-length: 100 | Name of this report. |
notes | string | Notes about this report. |
options | ReportOptions | Specified parameters for the report logic, targeted Assets, and filtering Places. |
progress | number(uint8) | The progress in processing/saving this result is a number between 0 and 100. |
runBy | string(email) max-length: 254 | The login of the user that ran this report. See: User.login |
schedule | number(uint64) | A reference to the schedule used to create this result.
This field is optional as not all results are created on a schedule. See: ReportSchedule.id |
scorecards | array[ReportDataScorecard] | Scorecards for all the targeted assets based on the scorecard rules. |
status | string(ReportStatus) | The processing status of this report. |
targeted | array[number(uint64)] | When the report runs, a list of targeted assets is calculated based on the ReportOption's targeting expression. |
template | number(uint64) | A reference to the Template used to create this result. This field is optional because templates are not necessarily required; they just make life a lot easier. See: ReportTemplate.id |
timezone | string(codified) | The timezone code used to adjust dates/times used in processing and saving this report. See: Timezone.code |
totals | array[ReportDataTotal] | After processing, the report totals the values from all summary instances for a quick overview of the kind of results generated. |
type | string(ReportType) | Refers to the type of logic used by this report. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"company": number, /* uint64 format */
"id": number, /* uint64 format */
"template": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this report results belonged. |
id | number(uint64) | Unique identifier of this report template. |
template | number(uint64) | The report template to which these report results belonged. |
{
"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, /* codified format, see Timezone.code */
"weekday": number, /* uint8 format */
"weekdays": [
boolean
]
},
"template": number, /* uint64 format, see ReportTemplate.id */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this report belongs See: Company.id |
enabled | boolean | Indicates whether this schedule is allowed to run. |
id | number(uint64) | Unique identifier |
name | string max-length: 100 | Name of this report. |
notes | string | Notes about this report. |
notify | ReportNotifications | A list of users and a targeting expression for assets which receive report results notifications. |
options | ReportOptions | Specified parameters for the report logic, targeted Assets, and filtering Places. |
owner | string(email) max-length: 254 | Login of the user who has ownership of this report schedule. See: User.login |
repetition | ReportRecurrence | The recurring schedule to generate report results. |
template | number(uint64) | A reference to the Template used to create this result. See: ReportTemplate.id |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"company": number, /* uint64 format */
"id": number, /* uint64 format */
"template": number /* uint64 format */
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this report schedule belonged. |
id | number(uint64) | Unique identifier of this report template. |
template | number(uint64) | The report template to which these report schedule belonged. |
{
"asset": number, /* uint64 format, see Asset.id */
"rulePoints": {
string: number /* double format */
},
"score": number /* double format */
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this scorecard belongs. See: Asset.id |
rulePoints | object{ | Points per rule |
score | number(double) | Final score calculated based on scorecard rules. |
{
"condition": string,
"duration": string, /* duration format */
"points": number /* double format */
}
Property | Type | Description |
---|---|---|
condition | string | Type of exception, example speeding, idling, etc. |
duration | string(duration) | Threshold per instance. If the threshold is 0, each instance is used in the calculation |
points | number(double) | Points applied against the base score per instance |
{
"baseScore": number, /* double format */
"parameters": [
{
"condition": string,
"duration": string, /* duration format */
"points": number /* double format */
}
]
}
Property | Type | Description |
---|---|---|
baseScore | number(double) | Base score for the scorecard. |
parameters | array[ReportScorecardParameter] | Infraction parameters used to generate the final score |
{
"asset": number, /* uint64 format, see Asset.id */
"distance": number, /* double format */
"endingReason": string, /* one of the ReportDataSummaryReason values */
"endingUtc": string, /* datetime format */
"firstState": {
"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 */
},
"instance": number, /* uint32 format */
"instancesCount": number, /* uint32 format */
"lastState": {
"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 */
},
"polyline": [
{
"lat": number, /* double format */
"lng": number /* double format */
}
],
"startingReason": string, /* one of the ReportDataSummaryReason values */
"startingUtc": string, /* datetime format */
"stateDetail": string
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this summary instance belongs. See: Asset.id |
distance | number(double) | The distance travelled in kilometres by the asset during this summary instance. |
endingReason | string(ReportDataSummaryReason) | The reason code that this summary instance ended. |
endingUtc | string(datetime) | Date/time stamp of the last event in this summary's sequence. |
firstState | Asset | The first asset state which begins this summary instance. |
instance | number(uint32) | Identifier of the summary instance in the report. |
instancesCount | number(uint32) | The number of events included in calculating this summary instance. |
lastState | Asset | The asset state that ended this summary instance. |
polyline | array[LatLng] | A simplified polyline of all the asset's positions in sequence. |
startingReason | string(ReportDataSummaryReason) | The reason code that this summary instance began. |
startingUtc | string(datetime) | Date/time stamp of the first event in this summary's sequence. |
stateDetail | string max-length: 100 | Code given to this summary instance for an asset. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this report belongs See: Company.id |
fill | string max-length: 22 | The fill/background colour of the icon. Should be a hex colour in the format #RRGGBB. |
graphic | string(codified) max-length: 22 | The name of the symbol for this report. |
id | number(uint64) | Unique identifier |
name | string max-length: 100 | Name of this report. |
notes | string | Notes about this report. |
options | ReportOptions | Specified parameters for the report logic, targeted Assets, and filtering Places. |
stroke | string max-length: 22 | Outline and graphic colour. Should be a hex colour in the format #RRGGBB. |
type | string(ReportType) | Refers to the type of logic used by this report. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this report template belonged. |
id | number(uint64) | Unique identifier of this report template. |
{
"asset": number, /* uint64 format, see Asset.id */
"distance": number, /* double format */
"duration": string, /* duration format */
"stateDetail": string,
"summaryCount": number, /* uint32 format */
"value": number, /* double format */
"valueType": string
}
Property | Type | Description |
---|---|---|
asset | number(uint64) | The asset to which this report total belongs. See: Asset.id |
distance | number(double) | The total distance travelled in kilometres of all summary instances. |
duration | string(duration) | The total duration of all summary instances. |
stateDetail | string max-length: 100 | Unique code given to the report total. |
summaryCount | number(uint32) | The number of summary instances included in this total. |
value | number(double) | The total value of all summary instances. |
valueType | string | The type of totalled value. |
{
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"passwordPolicy": {
"DEFAULT_MINIMUM_LENGTH": number, /* uint8 format */
"expireMode": string, /* one of the ExpiryModePolicy values */
"expireThreshold": number, /* uint8 format */
"includeLetters": boolean,
"includeNumbers": boolean,
"includeSpecial": boolean,
"includeUpperLower": boolean,
"MINIMUM_LENGTH": number, /* uint8 format */
"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
],
"DEFAULT_LIFETIME_MINUTES": number, /* int32 format */
"DEFAULT_MAX_SESSIONS": number, /* uint8 format */
"expireTimeout": number, /* uint16 format */
"idleAllowed": boolean,
"ipv4Ranges": [
string /* ipv4 format */
],
"maxSessions": number, /* uint8 format */
"multiUser": string /* one of the MultiUserPolicy values */
},
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belongs. See: Company.id |
contact | Contact | Your user's simplified contact card. Warning:This object will be serialized asContact instead of ContactSimple starting in January 2018. |
enabled | boolean | Indicates whether system access is disable. |
formats | object{ max-length of values: 20 | The format strings defining the preferred way to display ambiguous values. |
groups | array[UserGroup] | List of groups of which you are a member. |
language | string min-length: 2 max-length: 5 | Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US". |
login | string(email) min-length: 6 max-length: 254 | The unique public email address used to access the system. See: User.login |
measurements | object{ | Preferred way of displaying ambiguous numbers in the context of measurements. |
nickname | string max-length: 100 | Human friendly name for these credentials |
notify | array[UserNotifications] max-length: 7 | Definition of how and when to send alerts to the user. |
options | object{ max-length of values: 20 | Additional options which do not fit in with the formats or measurements preferences. |
passwordExpired | boolean | Indicated whether the credentials have expired according to the company's policy. |
passwordPolicy | PasswordPolicy | Your company's password complexity and expiry policy. |
permissions | array[UserPermission] | Individual permission rules which override the group rules. |
sessionPolicy | SessionPolicy | Your company's session lifetime policy. |
timezone | string(codified) | The user's local timezone. See: Timezone.code |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"ending": string, /* datetime format */
"kind": string, /* one of the BroadcastType values */
"message": string,
"serverTime": string, /* datetime format */
"starting": string /* datetime format */
}
Property | Type | Description |
---|---|---|
ending | string(datetime) | Timestamp of when the maintenance will end. |
kind | string(BroadcastType) | Downtime! |
message | string | Human readable message describing the broadcast. |
serverTime | string(datetime) | The UTC date/time of the server hosting the connection. |
starting | string(datetime) | Timestamp of when the maintenance window begins. |
{
"eta": string, /* datetime format */
"kind": string, /* one of the BroadcastType values */
"message": string,
"reload": boolean,
"serverTime": string /* datetime format */
}
Property | Type | Description |
---|---|---|
eta | string(datetime) | Timestamp of when the upgrade will be ready. |
kind | string(BroadcastType) | Upgrade to v4 system. |
message | string | Human readable message describing the broadcast. |
reload | boolean | True when system objects have changed structure. It is recommended that all resources are purged and reloaded. |
serverTime | string(datetime) | The UTC date/time of the server hosting the connection. |
{
"errorCode": number, /* one of the ErrorCode values */
"errorDetails": object,
"message": string,
"reqId": number /* uint32 format */
}
Property | Type | Description |
---|---|---|
errorCode | number(ErrorCode) | The unique, numeric error code when processing this request. |
errorDetails | object | An object to provide developers with a hint about the nature of the error. The key is not always present, and only available for some errors. |
message | string | An English description of the error. |
reqId | number(uint32) | The optional, client-generated unique identifier for correlating requests. The key is only present if a reqId was given for the associated request. |
{
"company": number, /* uint64 format */
"subscriptionTypes": [
string /* one of the SubscriptionType values */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company relevant to the notification types you want to receive. |
subscriptionTypes | array[string(SubscriptionType)] | List of notification types for the company. |
{
"company": number, /* uint64 format, see Company.id */
"enabled": boolean,
"formats": {
string /* codified format */ : string
},
"groups": [
number /* uint64 format, see UserGroup.id */
],
"insecure": boolean,
"ipRanges": [
string /* ipv4 format */
],
"key": string,
"language": string,
"measurements": {
string /* codified format */ : string /* one of the SystemsOfUnits values */
},
"nickname": string,
"notAfter": string, /* datetime format */
"notBefore": string, /* datetime format */
"notes": string,
"options": {
string /* codified format */ : 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 */
}
],
"referrers": [
string
],
"secret": string,
"services": [
string
],
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belongs. See: Company.id |
enabled | boolean | Indicates whether system access is disable. |
formats | object{ max-length of values: 20 | The format strings defining the preferred way to display ambiguous values. |
groups | array[number(uint64)] | A list of groups to which this machine account belongs. See: UserGroup.id |
insecure | boolean | When true, no access restrictions ( |
ipRanges | array[string(ipv4)] | Restrict service access to only the provided IP ranges. Currently we only support IPv4 anges using CIDR slash-notation. |
key | string max-length: 50 | The unique idenifier used to access the system. |
language | string min-length: 2 max-length: 5 | 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{ | Preferred way of displaying ambiguous numbers in the context of measurements. |
nickname | string max-length: 100 | Human friendly name for these credentials |
notAfter | string(datetime) | An optional timestamp that restricts this machine account from being used after the given date. |
notBefore | string(datetime) | An optional timestamp that restricts this machine account from being used before the given date. |
notes | string max-length: 8000 | Notes about this machine. |
options | object{ max-length of values: 20 | Additional options which do not fit in with the formats or measurements preferences. |
permissions | array[UserPermission] | Permission rules which override the group rules. |
referrers | array[string] max-length of values: 254 | Optional list of your managed domains from which this machine account can be used. |
secret | string max-length: 1000 | A token used to encode or validate requests. |
services | array[string] max-length of values: 254 | List of system service URIs that this machine account is permitted to access. |
timezone | string(codified) | The service account's local timezone. See: Timezone.code |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"company": number, /* uint64 format */
"key": string
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this Service Account belonged. |
key | string | Unique identifier of the Service Account. |
{
"active": boolean,
"company": number, /* uint64 format */
"created": string, /* datetime format */
"handle": string,
"ipAddress": string, /* ipv4 format */
"lastActivity": string, /* datetime format */
"login": string, /* email format */
"sockets": number, /* uint32 format */
"userAgent": string
}
Property | Type | Description |
---|---|---|
active | boolean | Indicates that there is at least one active WebSocket connection. |
company | number(uint64) | Unique identifier of the company to which this session's user belongs. |
created | string(datetime) | Date/time stamp from the moment this session was created. |
handle | string | The unique handle (not identifier) used to manipulate sessions. |
ipAddress | string(ipv4) | Last reported IP address used by the client. |
lastActivity | string(datetime) | Date/time stamp of the last command sent to the system. |
login | string(email) | This session's username. |
sockets | number(uint32) | The number of WebSocket connections in use with this session. |
userAgent | string | Client software identification. |
{
"company": number, /* uint64 format, see Company.id */
"contact": number, /* uint64 format, see Contact.id */
"enabled": boolean,
"formats": {
string /* codified format */ : string
},
"groups": [
number /* uint64 format, see UserGroup.id */
],
"language": string,
"login": string, /* email format */
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"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 */
}
],
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
],
"v[0]": uint32,
"v[1]": uint32
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belongs. See: Company.id |
contact | number(uint64) | Contact information for this user. See: Contact.id |
enabled | boolean | Indicates whether system access is disable. |
formats | object{ max-length of values: 20 | The format strings defining the preferred way to display ambiguous values. |
groups | array[number(uint64)] | A list of groups to which this user belongs. See: UserGroup.id |
language | string min-length: 2 max-length: 5 | Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US". |
login | string(email) min-length: 6 max-length: 254 | The unique public email address used to access the system. |
measurements | object{ | Preferred way of displaying ambiguous numbers in the context of measurements. |
nickname | string max-length: 100 | Human friendly name for these credentials |
notify | array[UserNotifications] max-length: 7 | Definition of how and when to send alerts to the user. |
options | object{ max-length of values: 20 | Additional options which do not fit in with the formats or measurements preferences. |
passwordExpired | boolean | Indicated whether the credentials have expired according to the company's policy. |
permissions | array[UserPermission] | Individual permission rules which override the group rules. |
timezone | string(codified) | The user's local timezone. See: Timezone.code |
v | array[number(uint32)] fixed length: 2 | Object version keys used to validate synchronization for different properties. |
v[0] | uint32 | Properties found in the UserGeneral object. |
v[1] | uint32 | Properties found in the UserAdvanced object. |
{
"company": number, /* uint64 format, see Company.id */
"groups": [
number /* uint64 format, see UserGroup.id */
],
"login": string, /* email format, see User.login */
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belongs. See: Company.id |
groups | array[number(uint64)] | A list of groups to which this user belongs. See: UserGroup.id |
login | string(email) min-length: 6 max-length: 254 | The unique public email address used to access the system. See: User.login |
permissions | array[UserPermission] | Individual permission rules which override the group rules. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belonged. |
login | string(email) | Unique identifier of the user. |
{
"company": number, /* uint64 format, see Company.id */
"contact": number, /* uint64 format, see Contact.id */
"enabled": boolean,
"formats": {
string /* codified format */ : string
},
"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": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
],
"options": {
string /* codified format */ : string
},
"passwordExpired": boolean,
"timezone": string, /* codified format, see Timezone.code */
"v": [
number /* uint32 format */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this user belongs. See: Company.id |
contact | number(uint64) | Contact information for this user. See: Contact.id |
enabled | boolean | Indicates whether system access is disable. |
formats | object{ max-length of values: 20 | The format strings defining the preferred way to display ambiguous values. |
language | string min-length: 2 max-length: 5 | Preferred region/language for the UI and notifications. Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US". |
login | string(email) min-length: 6 max-length: 254 | The unique public email address used to access the system. See: User.login |
measurements | object{ | Preferred way of displaying ambiguous numbers in the context of measurements. |
nickname | string max-length: 100 | Human friendly name for these credentials |
notify | array[UserNotifications] max-length: 7 | Definition of how and when to send alerts to the user. |
options | object{ max-length of values: 20 | Additional options which do not fit in with the formats or measurements preferences. |
passwordExpired | boolean | Indicated whether the credentials have expired according to the company's policy. |
timezone | string(codified) | The user's local timezone. See: Timezone.code |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
{
"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 */
]
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this group belongs. See: Company.id |
id | number(uint64) | Unique identifier of this group. |
name | string max-length: 100 | A name given to this group. |
notes | string | Notes about this group, and to whom this group should be applied. |
permissions | array[UserPermission] | Permissions for this group. |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
Property | Type | Description |
---|---|---|
company | number(uint64) | The company to which this group belonged. |
id | number(uint64) | Unique identifier of this group. |
{
"email": string, /* email format */
"enabled": boolean,
"end": string, /* duration format, see UserGeneral.timezone */
"name": string,
"offline": [
NotificationsMethod
],
"online": [
NotificationsMethod
],
"sms": number, /* uint64 format */
"start": string, /* duration format, see UserGeneral.timezone */
"weekdays": [
boolean /* see UserGeneral.timezone */
]
}
Property | Type | Description |
---|---|---|
string(email) min-length: 6 max-length: 254 | Email address where the sent is sent.
If not specified, the email address from the User's | |
enabled | boolean | A flag for whether or not this schedule is in use. |
end | string(duration) | End time portion of the schedule that defines a period of the day when the user wants to receive alerts.
The time value is defined in local time, not UTC. See: UserGeneral.timezone |
name | string max-length: 100 | A common name like "Weekdays" or "Off Hours". |
offline | array[NotificationsMethod] | A list of the types of methods to use to notify the user when they are not connected. |
online | array[NotificationsMethod] | A list of the types of methods to use to notify the user when they have an active WebSocket connection. |
sms | number(uint64) | SMS address where the alert is sent.
If not specified, the mobile phone number from the User's |
start | string(duration) | Start time portion of the schedule that defines a period of the day when the user wants to receive alerts.
The time value is defined in local time, not UTC. See: UserGeneral.timezone |
weekdays | array[boolean] | A 7 item, boolean array, determines if the user should be notified on that day of the week.
The days of the week are defined in local time, not UTC. See: UserGeneral.timezone |
{
"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 */
}
Property | Type | Description |
---|---|---|
company | number(uint64) | The company that this permission targets. See: Company.id |
labels | array[string] | Codified names of labels. If list is empty, this permission applies for all labels. See: LabelStyle.code |
level | string(PermissionLevel) | The level of access being defined. |
method | string(PermissionMethod) | The way the access is used. |
type | string(PermissionType) | The kind of permission or subscription. |
{
"fill": string,
"stroke": string
}
Property | Type | Description |
---|---|---|
fill | string max-length: 22 | The colour of the background. |
stroke | string max-length: 22 | The colour of the text or outline. |
{
"contactInfo": {
string: number /* uint64 format, see Contact.id */
},
"domain": string,
"favourite": string,
"gamut": {
string: {
"fill": string,
"stroke": string
}
},
"graphics": {
string: string
},
"icon": string,
"id": number, /* uint64 format, see Company.id */
"languages": [
string
],
"logo": string,
"notifyEmail": {
"incomingAddress": string,
"incomingLogin": string,
"incomingMessageNumber": number, /* uint32 format */
"incomingPort": number, /* uint16 format */
"incomingSecure": boolean,
"incomingType": string,
"outgoingAddress": string,
"outgoingLogin": string,
"outgoingPort": number, /* uint16 format */
"outgoingReplyTo": string, /* email format */
"outgoingSecure": boolean,
"outgoingType": string
},
"notifySms": {
"notifyLimit": number, /* uint16 format */
"phoneNumbers": {
string: array /* uint64 format */
}
},
"parent": number, /* uint64 format, see Company.id */
"recoverBody": string,
"recoverIsHtml": boolean,
"recoverSubject": string,
"serviceName": string,
"termsPreamble": string,
"termsUpdated": string, /* datetime format */
"v": [
number /* uint32 format */
],
"website": {
string: string
}
}
Property | Type | Description |
---|---|---|
contactInfo | object{ max-length of keys: 100 | A list of Contacts for company specific things like Technical Support, Billing, etc... See: Contact.id |
domain | string max-length: 100 | The URN and path to the instance of v4. It does not contain the protocol because all instances are required to be HTTPS. |
favourite | string max-length: 200 | The name of the icon file used for browser bookmarks. |
gamut | object{ max-length of keys: 25 | Colours used as templates for status tags, labels, and places. |
graphics | object{ max-length of keys: 25 max-length of values: 30 | A list of symbol names and their corresponding FontAwesome icon names. |
icon | string max-length: 200 | The name of the image uploaded as the logo (used for collapsed/mobile view). |
id | number(uint64) | Unique identifier of the Company. See: Company.id |
languages | array[string] max-length of values: 5 | A list of supported languages for your customers. |
logo | string max-length: 200 | The name of the image uploaded as the logo (used for regular view). |
notifyEmail | NotificationServerEmail | The server used for notification and conversational email messages sent and received by the system. |
notifySms | NotificationServerSms | Definition for load-balanced outbound SMS numbers for the reseller. |
parent | number(uint64) | The unique identifier of this company's parent organization. See: Company.id |
recoverBody | string | The body of the email sent to a user requesting a password reset. |
recoverIsHtml | boolean | |
recoverSubject | string | The subject of the email sent to a user requesting a password reset. |
serviceName | string max-length: 150 | The name of the branded service being provided to the seller's customers. |
termsPreamble | string | A preamble to the general terms and conditions offered by Fleet Freedom. |
termsUpdated | string(datetime) | The date and time when the terms were updated. This will promt users who are logging-in to re-agree to the new terms |
v | array[number(uint32)] | Object version keys used to validate synchronization for all object properties. |
website | object{ max-length of keys: 25 max-length of values: 22 | Themed colours used in the web-based UI. |
{
"incomingAddress": string,
"incomingLogin": string,
"incomingMessageNumber": number, /* uint32 format */
"incomingPort": number, /* uint16 format */
"incomingSecure": boolean,
"incomingType": string,
"outgoingAddress": string,
"outgoingLogin": string,
"outgoingPort": number, /* uint16 format */
"outgoingReplyTo": string, /* email format */
"outgoingSecure": boolean,
"outgoingType": string
}
Property | Type | Description |
---|---|---|
incomingAddress | string | The domain or IP address of the incoming email server. |
incomingLogin | string | The username used to login to the incoming email server. |
incomingMessageNumber | number(uint32) | IMAP message sequence number so only recent messages are retrieved. |
incomingPort | number(uint16) | The port number of the incoming email server. |
incomingSecure | boolean | Is the incoming email server using a secure SSL/TLS connection (it should). |
incomingType | string | The type of incoming protocol to use (IMAP or POP3). |
outgoingAddress | string | The domain or IP address of the outgoing email server. |
outgoingLogin | string | The username used to login to the outgoing email server. |
outgoingPort | number(uint16) | The port number of the outgoing email server. |
outgoingReplyTo | string(email) | An optional field which can be set as the "sent from" and/or "reply-to" address. |
outgoingSecure | boolean | Is the outgoing email server using a secure SSL/TLS connection (it should). |
outgoingType | string | The type of outgoing protocol to use (only SMTP). |
{
"notifyLimit": number, /* uint16 format */
"phoneNumbers": {
string: array /* uint64 format */
}
}
Property | Type | Description |
---|---|---|
notifyLimit | number(uint16) | A per-number/per-day limit on the amount of Notifications sent. |
phoneNumbers | object{ | All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve. |
Value | Description |
---|---|
0 | Success Operation completed without error |
1 | Unknown error An error by the client, or some other kind of unknown error. |
2 | Internal service error Service error not because of client input |
3 | Invalid data Client input data was not parsed properly |
4 | Invalid permission Not a known permission |
5 | Permission denied Operation not successful because access is restricted |
6 | Incorrect version key Version keys sent with request do not match service version. In these cases, treat the service version as most recent. |
61 | Unknown command What are you trying to do genius? |
62 | Timezone not found The |
80 | There was an error retrieving the address' coordinates Check the errorDetails for more information. |
81 | No coordinates could be found for the given address Ensure the address is correct, or try again without postal code. |
108 | Operation has not yet started The long-running operation is scheduled to start, and will when resources are ready. |
109 | Operation is running The long-running operation is currently executing. |
110 | Operation failed The long-running operation has failed; see message for details. |
125 | No change The object or operation has not changed since the last request. |
126 | No content The collection has no content or the operation produced none. |
Assets | |
20 | Asset not found |
21 | Asset not deleted |
22 | One or more assets in the list not found |
63 | Asset message not found |
64 | Dispatch task not found |
82 | There was an error calculating the directions or too many stops were given Check the errorDetails for more information. |
83 | Directions could not be calculated between two or more stops Ensure the each stop is correct, or try a shorter route. |
96 | Asset suspended |
97 | Asset not suspended |
100 | Dispatch task not deleted |
101 | Asset message not deleted |
Behaviours and Scripts | |
23 | Behaviour script not found |
24 | Behaviour script not deleted |
25 | Behaviour script currently in use by one or more behaviours In order to delete a Behaviour Script, all Behaviours implementing this script must be deleted first. |
26 | Behaviour not found |
27 | Behaviour not deleted |
104 | Provider Script currently in use by one or more configs In order to delete a Provider Script, all Provider Configs implementing this script must be deleted first. |
Billing | |
111 | Billing Profile not found |
112 | Billing Profile not deleted |
113 | Billing Hosting Rule not found |
114 | Billing Hosting Rule not deleted |
115 | Billing Hosting Discount not found |
116 | Billing Hosting Discount not deleted |
117 | Billing Hosting License not found |
118 | Billing Hosting License not deleted |
119 | Billing Report not found |
120 | Billing Report not deleted |
Companies and Policies | |
12 | Application not allowed The given UserAgent is not allowed |
13 | IPAddress not allowed IP restrictions are in place, and the client IP is not in the allowed list |
15 | Password doesn't comply with the password policy See the |
17 | New password must be different When changing a password, it must not be the same as the previous password. |
28 | Company not found |
29 | Company not deleted |
58 | LabelStyle code names must be unique |
59 | TagStyle code names must be unique |
Contacts and Directory | |
31 | Contact not found |
32 | Contact not deleted |
121 | Contact currently in use by one or more assets or users In order to delete a Contact, all assets and users referencing this contact must be altered/deleted first. |
File Hosting | |
33 | Icon not found |
34 | Icon not deleted |
68 | Picture not found |
69 | One or more pictures in the list not found |
70 | Picture not deleted |
90 | Unsupported MIME type |
91 | File is too large |
122 | Document not found |
123 | Document not deleted |
124 | One or more documents in the list not found |
Hours of Service | |
76 | Carrier not found |
77 | Carrier not deleted |
78 | Trip Inspection not found |
79 | Trip Inspection not deleted |
84 | Driver E-Log not found |
Maintenance | |
35 | Maintenance job not found |
36 | Maintenance job not deleted |
37 | Maintenance schedule not found |
38 | Maintenance schedule not deleted |
39 | Maintenance schedule currently in use by one or more maintenance jobs In order to delete a Maintenance Schedule, all Maintenance Jobs referencing this schedule must be deleted first. |
Places | |
40 | Place not found |
41 | Place not deleted |
42 | One or more places in the list not found |
Providers and Configurations | |
43 | Provider not found |
44 | Provider not deleted |
45 | One or more providers in the list not found |
46 | Cannot access deleted provider |
47 | Provider configuration template not found |
48 | Provider configuration not found |
49 | Provider configuration not deleted |
50 | Provider configuration currently in use by one or more providers In order to delete a Provider Configuration, all Providers using this configuration must be deleted first, or have their configuration changed. |
51 | Invalid Provider configuration options |
86 | Provider's registration identifier is invalid or not found |
87 | Verification hash does not match Provider's |
88 | Unknown or invalid verification code |
89 | Verification code timeout has elapsed |
92 | Unknown or invalid provider type |
98 | Provider suspended |
99 | Provider not suspended |
102 | Provider Script not found |
103 | Provider Script not deleted |
Reports and Templates | |
52 | Report Template not found |
53 | Report Template not deleted |
67 | Report Result not found |
75 | Report Result not deleted |
93 | Report Schedule not found |
94 | Report Schedule not deleted |
95 | Not ready to server summary or breakdown data |
Users and Groups | |
7 | Session expired User's session is expired or unknown |
8 | Please login Please login before all other operations |
9 | Session was forcibly killed User's session was ended by another user, or by company's session policy |
10 | Logged out The session has ended |
11 | Invalid credentials Is your caps-lock on? |
14 | Session active from another client Session is active from another live connection |
16 | Password expired; please change your password An expired password does not mean your session has expired. If you create a new session, it will ask you to update your password again. |
18 | Kill session failed Unable to end the session |
19 | Session not found |
30 | User group not found |
54 | User not found |
55 | User not deleted |
56 | Cannot access deleted user |
57 | Cannot delete yourself Don't do it! You have so much to live for! |
60 | One or more User groups in the list not found |
65 | User group currently in use by one or more users |
66 | User group not deleted |
71 | Permission escalation Unable to perform operation because results would escalate user's permissions |
72 | User with this login already exists |
73 | Session throttled Session or connection not allowed due to flooding. |
74 | One or more users in the list not found |
85 | The user has been disabled |
105 | Command throttled Command not processed due to flooding. |
127 | Service account not found |
128 | Service account not deleted |
129 | The service account cannot access the requested API |
White-labelling | |
106 | CompanyReseller not found This company does not have a reseller profile. |
107 | CompanyReseller not deleted This company's existing reseller profile is not deleted. |
Value | Description |
---|---|
enter | Occurs when an asset is outside a Place, then goes inside the boundary. |
exit | Occurs when an asset was inside the boundary of a Place, but then moves outside the boundary. |
inside | Occurs when the asset was inside the boundary before, and is still inside the boundary now. |
Value | Description |
---|---|
asset | Generic thing. |
person | Human (or alien) Person. |
trailer | A towed vehicle without an engine. |
vehicle | A vehicle that moves with its own power. |
Value | Description |
---|---|
err | Used for errors. |
info | Used for more important messages. |
log | Used for general information messages. |
warn | Used for warnings. |
Value | Description |
---|---|
boolean | True or false. |
json | Object or array literal. |
number | Numeric value (signed double-precision floating point number). |
string | Text. |
Value | Description |
---|---|
asset | Generic dot-on-a-map tracking |
dispatch | Tasks assignable to vehicles or persons |
elogs | FMCSA compliant E-Logs and Hours of Service |
mobile | Employee/driver tracking |
streetview | Dashcam and live images hosting |
vehicle | Vehicle tracking (includes VBus data, and engine hours) |
Value | Description |
---|---|
bewhere | BeWhere license fee |
calamp | CalAmp PULS fee |
smartwitness | SmartWitness data hosting fee |
Value | Description |
---|---|
CAD | Canadian dollars |
EURO | Eurozone currency |
USD | American dollars |
Value | Description |
---|---|
annually | Once per year |
monthly | Once a month |
quarterly | Every three months |
Value | Description |
---|---|
days | Passwords expire after a defined number of days. |
never | Passwords never expire. |
sessions | Passwords expire after a defined number of successful logins. |
Value | Description |
---|---|
allow | Allow users to create multiple simultaneous sessions. |
deny | Deny users from creating new sessions if they already have an active session. |
replace | Allow users to create a new session, but automatically kill the previous session. |
Value | Description |
---|---|
arrived | The asset has arrived at the task's location. |
cancelled | The task was cancelled by either the asset or a user. |
completed | The task is done. |
created | The task has been created, but not yet assigned to an asset. |
damaged | An item associated with this task is damaged. |
droppedOff | An item was dropped-off for this task. |
onRoute | The asset is on the way to the task's location next. |
pickedUp | An item was picked-up for this task. |
queued | The task has been given to an asset (and delivered to the asset's primary device). |
unsuccessful | The task couldn't be completed by the asset. |
waiting | The asset is waiting and can't complete the task. |
Value | Description |
---|---|
image | Image |
unknown | Unknown or other. |
video | Video |
Value | Description |
---|---|
drawings | An SVG only layer for special drawing controls. Icons should not use this layer. |
edits | An HTML only layer for special drawing controls. Icons should not use this layer. |
fills | An SVG only layer just above the roads used for solid Places and accuracy radius fill. |
labels | An HTML only layer intended for use by an icon's label. |
markers | An HTML only layer intended for use by an icon's main images. |
outlines | An SVG only layer intended for use by shape and accuracy radius outlines. |
shadows | An HTML only layer intended for use by an icon's drop-shadow. |
Value | Description |
---|---|
canada120h14d | Canada South 120 hour / 14 days (Cycle 2) |
canada120h14dN | Canada North 120 hour / 14 days (Cycle 2) |
canada70h7d | Canada South 70 hour / 7 days (Cycle 1) |
canada80h7d | Canada North 80 hour / 7 days (Cycle 1) |
canadaOilGas | Canada Oil and Gas |
unknown | Some other cycle |
usa60h7d | USA Federal 60 hour / 7 days |
usa60h7d_p | USA Federal 60 hour / 7 days (passenger) |
usa70h8d | USA Federal 70 hour / 8 days |
usa70h8d_p | USA Federal 70 hour / 8 days (passenger) |
usaAlaska70h7d | USA Alaska 70 hour / 7 days |
usaAlaska70h7d_p | USA Alaska 70 hour / 7 days (passenger) |
usaAlaska80h8d | USA Alaska 80 hour / 8 days |
usaAlaska80h8d_p | USA Alaska 80 hour / 8 days (passenger) |
usaCalifornia112h8d | USA California 112 hours / 8 days (farm products) |
usaCalifornia112h8d_p | USA California 112 hours / 8 days (passenger) |
usaCalifornia80h8d | USA California 80 hour / 8 days |
usaCalifornia80h8d_p | USA California 80 hour / 8 days (passenger) |
usaTexas70h7d | USA Texas 70 hour / 7 days |
Value | Description |
---|---|
canadaEmail | MTO via Email |
usaEmail | FMCSA via Email |
usaWebservice | FMCSA via Webservice portal |
Value | Description |
---|---|
tractor | Defect on the vehicle. |
trailer | Defect on one of the trailers. |
Value | Description |
---|---|
corrected | Issue fixed or resolved |
harmless | Issue does not affect operation |
satisfactory | Does not need to be corrected |
Value | Description |
---|---|
dataTransfer | Data transfer data diagnostic event |
engine | Engine synchronization data diagnostic event |
missingData | Missing required data elements data diagnostic event |
other | Other ELD identified diagnostic event |
power | Power data diagnostic event |
unidentified | Unidentified driving records data diagnostic event |
Value | Description |
---|---|
1 | Cycle set to "Cycle 1" |
2 | Cycle set to "Cycle 2" |
Value | Description |
---|---|
0 | Hours have not been defefred. |
1 | Hours deferred from Day 1. |
2 | Hours deferred from Day 2. |
Value | Description |
---|---|
-1 | Unknown duty status |
1 | An ELD malfunction logged |
2 | An ELD malfunction cleared |
3 | A data diagnostic event logged |
4 | An data diagnostic event cleared |
Value | Description |
---|---|
-1 | Unknown duty status |
1 | Driver's duty status changed to "Off-duty" |
2 | Driver's duty status changed to "Sleeper Berth" |
3 | Driver's duty status changed to "Driving" |
4 | Driver's duty status changed to "On-duty not driving" |
5 | Waiting status is an Off-duty for some cases in Oil and Gas cycle. |
Value | Description |
---|---|
-1 | Unknown duty status |
1 | Engine power-up with conventional location precision |
2 | Engine power-up with reduced location precision |
3 | Engine shut-down with conventional location precision |
4 | Engine shut-down with reduced location precision |
Value | Description |
---|---|
-1 | Unknown |
1 | Intermediate log with conventional location precision |
2 | Intermediate log with reduced location precision |
Value | Description |
---|---|
-1 | Unknown |
1 | Authenticated driver's ELD login activity |
2 | Authenticated driver's ELD logout activity |
Value | Description |
---|---|
-1 | Unknown |
0 | Driver indication for PC, YM and WT cleared |
1 | Driver indicates "Authorized Personal use of CMV" |
2 | Driver indicates Yard moves" |
Value | Description |
---|---|
1 | Operating zone set to "south of latitude 60°N in Canada" |
2 | Operating zone set to "north of latitude 60°N in Canada" |
3 | Operating zone set to "United States" |
Value | Description |
---|---|
automatic | Automatically recorded by ELD |
driver | Entered or edited by driver |
unidentified | Assumed from unidentified driver profile |
user | Edit requested by an authenticated user other than driver |
Value | Description |
---|---|
active | Active |
inactiveChanged | Inactive - changed |
inactiveChangeRejected | Inactive - change rejected |
inactiveChangeRequested | Inactive - change requested |
Value | Description |
---|---|
1 | A change in driver's duty-status. |
2 | An intermediate log |
3 | A change in driver's indication of authorized personal use of CMV or yard moves. |
4 | A driver's certification/re-certification of records. |
5 | A driver's login/logout activity. |
6 | CMV's engine power up/shutdown activity. |
7 | A malfunction or data diagnostic detection occurence. |
20 | Canadian cycle off-duty hours deferred. |
21 | Canadian cycle changed. |
22 | Canadian cycle operating zone changed. |
23 | Canadian cycle additional hours not recorded. |
Value | Description |
---|---|
E | Engine synchronization compliance malfunction |
L | Positioning compliance malfunction |
O | Other ELD detected malfunction |
P | Power compliance malfunction |
R | Data recording compliance malfunction |
S | Data transfer compliance malfunction |
T | Timing compliance malfunction |
Value | Description |
---|---|
break_24 | 24 Hour Break Required |
break_30 | 30 Minute Break Required |
consecutive_off_8 | Daily 8 Consecutive Hours Off Duty Required |
cycle_112 | 112 Hour Cycle Limit |
cycle_120 | 120 Hour Cycle Limit |
cycle_60 | 60 Hour Cycle Limit |
cycle_70 | 70 Hour Cycle Limit |
cycle_80 | 80 Hour Cycle Limit |
cycle_switching_36 | 36 Hours Break Required for Cycle Switching |
cycle_switching_72 | 72 Hours Break Required for Cycle Switching |
daily_break_10 | Daily 10 Hour Off-Duty Required |
daily_break_8 | Daily 8 Hour Off-Duty Required |
daily_driving_13 | Daily 13 Hour Driving Limit |
daily_duty_14 | Daily 14 Hour On-Duty Limit |
deferred_break_10 | 10 Consecutive Hours Off Duty Required on Day 2 |
deferred_break_12 | Off Duty Time Insufficient on Day 2 |
driving_10 | 10 Hour Driving Limit |
driving_11 | 11 Hour Driving Limit |
driving_13 | 13 Hour Driving Limit |
driving_15 | 15 Hour Driving Limit |
duty_14 | 14 Hour Shift Limit |
duty_15 | 15 Hour On-Duty Limit |
duty_16 | 16 Hour Shift Limit |
duty_18 | 18 Hour Shift Limit |
duty_20 | 20 Hour Shift Limit |
none | No violation |
oil_break_24 | 3 periods of 24 Hour Break Required |
Value | Description |
---|---|
cancelled | The job was cancelled or was not necessary. |
completed | Work is completed. |
pastdue | The work was scheduled, but not yet done. |
pending | The work will need to be performed soon. |
Value | Description |
---|---|
high | Sends before low and normal priority alerts. |
low | Sends when no other alerts are pending in the queue. |
normal | Sends in when there are no high priority alerts in the queue. |
Value | Description |
---|---|
acknowledged | Memo has been responded to or acknowledged by the recipient. |
bounceback | Memo sent, but returned with error from receiving server. |
created | Waiting to be sent. |
failed | Failed to send. |
processed | Sent or received. |
throttled | Failed to send because too many memos were sent. |
Value | Description |
---|---|
apn | Apple Push Notification Service |
gcm | Google Cloud Message |
pnd | Garmin/Magellan/etc (Personal Navigation Device) |
sms | Short Message Service (text message) |
socket | WebSocket alert message |
unknown | If the type of memo has not yet been determined, or there was an error determining its type. |
Value | Description |
---|---|
archive | The archive contains all previous messages, but must be queried from disk for retrieval. |
inbox | The inbox is loaded quickly from memory, but messages regularly move to the archive. |
Value | Description |
---|---|
point | A lat/long coordinate pair.
Places of this type do not contain the |
polygon | The |
radial | Defined as a radius around a lat/long pair used to create a circular boundary.
Places of this type do not contain the |
rectangle | The |
Value | Description |
---|---|
CAMERA | Dashcam picture and video recording events |
CELL | Cellular network information. |
DISPATCH | Task, clock-in/out, paired vehicle and driver information. |
GPS | GPS and location data. |
IO | Wiring data. |
STATUS | Provider status and sensor data. |
VBUS | OBD-II and J-Bus data. |
Value | Description |
---|---|
CAMERA | |
CAMERA_1 | |
CAMERA_2 | |
CAMERA_3 | |
CAMERA_4 | |
ACK_BYTES_IN | |
CELLUAR_IP_ADDRESS | |
CELLUAR_ROAMING | |
CELLUAR_SERVICE | |
CELLUAR_WAN_IP | |
CELLULAR_CARRIER | |
CELLULAR_COMM_STATE | |
CELL | |
CELLULAR_RSSI | |
DATA_AGE | |
DATA_BYTES_IN | |
DATA_BYTES_OUT | |
GPR_STATE | |
GSM_STATE | |
HOURS_DISCONNECTED_COUNTER | |
HOURS_ON_COUNTER | |
PASSTHROUGH_USER_MESSAGE | |
PASSTHROUGH_USER_MESSAGE_ID | |
PDP_STATE | |
PERCENT_LOST_GPRS | |
PERCENT_LOST_GSM | |
PERCENT_LOST_PDP | |
POLICY_FAULT_MESSAGEID | |
POLICY_FAULT_TEXT | |
SERVICE_FAULT_MESSAGEID | |
SERVICE_FAULT_TEXT | |
SERVICE_RESPONSE | |
SMS_MSG_IN_COUNTER | |
SMS_MSG_OUT_COUNTER | |
SMS_SPAM_MSG_IN_COUNTER | |
TERMINAL_STATUS | |
DISPATCH_TASK | A task is marked as active or "on-route" when the DispatchTask.id is sent. |
DRIVER_DRIVING | When the driver changes status to "driving" from another status. |
DRIVER_LOGIN | When the driver logs-in the terminal/vehicle. |
DRIVER_LOGOFF | When the driver logs-off the terminal/vehicle. |
DRIVER_OFFDUTY | When the driver changes status to "off-duty" from another status. |
DISPATCH | |
DRIVER_ONDUTY | When the driver changes status to "on-duty" from another status. |
DRIVER_SLEEPING | When the driver changes status to "sleeping" from another status. |
DRIVER_VEHICLE | When the driver chooses a specific vehicle during the log-in process. |
HOS_DRIVER | |
HOS_IS_CODRIVER | |
HOS_STATUS | |
HOS_VEHICLE | |
HOS_VIOLATION | |
COURSE | The heading or bearing over time. |
GEOFENCE_ID | ID of violated geofence |
GEOFENCE_VIOLATION | Geofence violation types(outside fence violation, inside fence violation) |
GPS_ACCELERATION | A virtual accelerometer calculated by the GPS system's positions |
GPS_ACCURACY | The approximate accuracy of the GPS fix |
GPS_ALTITUDE | Altitude above sea-level |
GPS_ANTENNA_STATUS | GPS antenna status could be related to power or unplugged states |
GPS_DECELERATION | A virtual accelerometer calculated by the GPS system's positions |
GPS_DISTANCE | Distance measured between two GPS fixes |
GPS_FIX_STATUS | Status or validity of the GPS fix |
GPS_FIX_TIME | Date/time stamp of the most recent GPS fix |
GPS_HDOP | Horizontal dilution of precision for 3D fixes |
GPS_HEADING | Direction of travel |
GPS | |
GPS_LATITUDE | Latitude in decimal degrees |
GPS_LONGITUDE | Longitude in decimal degrees |
GPS_LOST_TIME | Date/time stamp from when the device lost GPS signal |
GPS_ODOMETER | A virtual odometer accumulated by the GPS system's positions |
GPS_SATELLITES | The number of satellites used to obtain the GPS fix |
GPS_SPEED | Speed measured by GPS fix differentiation |
MAGNETIC_VARIATION | Difference in horizontal angle between true north and magnetic north |
PERCENT_LOST_GPS | Date/time stamp from when the device lost its precise GPS position |
PERCENT_LOST_GPS_QUALITY_FACTOR | Statistical amount of bad GPS data |
ANALOG_INPUT_0 | Analog voltage reading from wire zero, or external power voltage, or internal battery voltage |
ANALOG_INPUT_1 | Analog voltage reading from wire #1 |
ANALOG_INPUT_10 | Analog voltage reading from wire #10 |
ANALOG_INPUT_11 | Analog voltage reading from wire #11 |
ANALOG_INPUT_2 | Analog voltage reading from wire #2 |
ANALOG_INPUT_3 | Analog voltage reading from wire #3 |
ANALOG_INPUT_4 | Analog voltage reading from wire #4 |
ANALOG_INPUT_5 | Analog voltage reading from wire #5 |
ANALOG_INPUT_6 | Analog voltage reading from wire #6 |
ANALOG_INPUT_7 | Analog voltage reading from wire #7 |
ANALOG_INPUT_8 | Analog voltage reading from wire #8 |
ANALOG_INPUT_9 | Analog voltage reading from wire #9 |
BAROMETRIC_PRESSURE | |
BATTERY_LEVEL | |
IO | |
DIGITAL_INPUT_0 | Digital input wire zero, or external power, or internal battery power |
DIGITAL_INPUT_1 | Digital input wire #1 |
DIGITAL_INPUT_10 | Digital input wire #10 |
DIGITAL_INPUT_11 | Digital input wire #11 |
DIGITAL_INPUT_2 | Digital input wire #2 |
DIGITAL_INPUT_3 | Digital input wire #3 |
DIGITAL_INPUT_4 | Digital input wire #4 |
DIGITAL_INPUT_5 | Digital input wire #5 |
DIGITAL_INPUT_6 | Digital input wire #6 |
DIGITAL_INPUT_7 | Digital input wire #7 |
DIGITAL_INPUT_8 | Digital input wire #8 |
DIGITAL_INPUT_9 | Digital input wire #9 |
DIGITAL_INPUT_DTR | Legacy AirLink digital input wire #2 |
DIGITAL_INPUT_RTS | Legacy AirLink digital input wire #1 |
DIGITAL_OUTPUT_0 | Voltage output wire #0 |
DIGITAL_OUTPUT_1 | Voltage output wire #1 |
DIGITAL_OUTPUT_10 | Voltage output wire #10 |
DIGITAL_OUTPUT_11 | Voltage output wire #99 |
DIGITAL_OUTPUT_2 | Voltage output wire #2 |
DIGITAL_OUTPUT_3 | Voltage output wire #3 |
DIGITAL_OUTPUT_4 | Voltage output wire #4 |
DIGITAL_OUTPUT_5 | Voltage output wire #5 |
DIGITAL_OUTPUT_6 | Voltage output wire #6 |
DIGITAL_OUTPUT_7 | Voltage output wire #7 |
DIGITAL_OUTPUT_8 | Voltage output wire #8 |
DIGITAL_OUTPUT_9 | Voltage output wire #9 |
EXTERNAL_TEMPERATURE | Temperature measured outside of the modem casing. |
GPIO0 | Switchable input/output wire zero, or external power, or internal battery |
GPIO1 | Switchable input/output wire #1 |
GPIO2 | Switchable input/output wire #2 |
GPIO3 | Switchable input/output wire #3 |
GPIO4 | Switchable input/output wire #4 |
GPIO5 | Switchable input/output wire #5 |
GPIO6 | Switchable input/output wire #6 |
GPIO7 | Switchable input/output wire #7 |
GPIO8 | Switchable input/output wire #8 |
GPIO9 | Switchable input/output wire #9 |
HUMIDITY | |
IO | |
INTERNAL_TEMPERATURE | Temperature measured on the mainboard, or inside the modem casing. |
IO | |
LIGHT | |
IO | |
TEMPERATURE_SENSOR_1 | |
TEMPERATURE_SENSOR_2 | |
TEMPERATURE_SENSOR_3 | |
TEMPERATURE_SENSOR_4 | |
RFID | |
TAG_COUNT | |
TAG_LIST | |
STATUS,IO | |
ACCELEROMETER | A virtual accelerometer calculated by the GPS system's positions |
STATUS,IO | |
MOTION_STATUS | Motion status determined by the GPS speed and ignition |
APP_ID | Identifier of the application communicating with the service(s). |
APP_VERSION | Software/firmware version information. |
BOOT_VERSION | Boot or kernel version information. |
CONFIG_VERSION | |
STATUS | |
ESN | The device's ESN (Electronic Serial Number). |
EVENT_CODE | The provider-specific event code. |
EVENT_NAME | The provider-specific event name. See |
EVENT_TIME | The time of the event. |
GPS_HARDWARE | GPS chip information. |
HARDWARE_VERSION | Device model information. |
ICCID | The device's ICCID (Integrated Circuit Card ID) |
IMEI | The device's IMEI (International Mobile Station Equipment Identity). |
STATUS | |
IMPACT | |
IMSI | The device's IMSI (International Mobile Subscriber Identity). |
LAST_CONFIG_UPDATE | |
LAST_ID_REPORT | |
MAIN_FIRMWARE_VERSION | |
MIN | The device's MIN (Mobile Identification Number). |
MODEM_MODEL | Device model name. |
MODEM_MODEL_ID | Device model name. |
MODEM_NAME | Device friendly name. |
NEW_SIM_ID | |
NUMBER_OF_OTA_TRY | |
OBDII_FIRMWARE_VERSION | |
OS_NAME | Operating System name (appropriate for mobile phones powered by Android or iOS). |
OS_VERSION | Operating System version information. |
PHONE_NUMBER | Phone number |
POWER_UP_COUNTER | |
PREFERED_ROAMING_LIST | |
PREVIOUS_SIM_ID | |
RADIO_VERSION | |
STATUS | |
RAP_VERSION | |
REGISTRATION_ID | Unique string given to mobile apps for FCM notifications. |
RESET_COUNTER | |
SECONDARY_IMEI | The device's secondary IMEI. |
SEQUENCE_NUMBER | |
SEQUENCE_NUMBER_FIRST | |
SEQUENCE_NUMBER_LAST | |
SERIAL_NUMBER | A serial not used as ESN, IMEI, or similar. |
SOURCE | |
STATUS_POWERUP | Booting |
STATUS | |
STATUS_SLEEP | Low power mode |
STATUS_WAKEUP | High power mode |
AIR_TEMPERATURE | |
ANTI_ICE_RATE | |
BILLING | |
BLAST | |
CONTROLLER | |
DISTANCE_TRAVELLED_AFTER_MIL_ON | |
DRY_RATE | |
ENGINE_HOURS | |
EQUIVALENT_COMMAND_RATIO | |
FUEL_TYPE | |
J1708_ACCELERATOR_PEDAL_POSITION | |
J1708_BATTERY_VOLTAGE | |
J1708_DIAGNOSTIC_CODE | |
J1708_ENGINE_AVERAGE_FUEL_ECONOMY | |
J1708_ENGINE_COOLANT_PRESSURE | |
J1708_ENGINE_COOLANT_TEMP | |
J1708_ENGINE_OIL_PRESSURE | |
J1708_ENGINE_OIL_TEMP | |
J1708_ENGINE_SPEED | |
J1708_FUEL_RATE | |
J1708_ODOMETER | Odometer reading from J-Bus 1708 |
J1708_SEATBELT | |
J1708_STATUS | |
J1708_TOTAL_ENGINE_HOURS | |
J1708_TOTAL_FUEL | |
J1708_TOTAL_IDLE_FUEL | |
J1708_TOTAL_IDLE_HOURS | |
J1708_VEHICLE_SPEED | |
J1939_ACCELERATOR_PEDAL_POSITION | |
J1939_BATTERY_VOLTAGE | |
J1939_DIAGNOSTIC_CODE | |
J1939_ENGINE_AVERAGE_FUEL_ECONOMY | |
J1939_ENGINE_COOLANT_PRESSURE | |
J1939_ENGINE_COOLANT_TEMP | |
J1939_ENGINE_OIL_PRESSURE | |
J1939_ENGINE_OIL_TEMP | |
J1939_ENGINE_SPEED | |
J1939_FUEL_RATE | |
J1939_ODOMETER | Odometer reading from J-Bus 1939 |
J1939_SEATBELT | |
J1939_STATUS | |
J1939_TOTAL_ENGINE_HOURS | |
J1939_TOTAL_FUEL | |
J1939_TOTAL_IDLE_FUEL | |
J1939_TOTAL_IDLE_HOURS | |
J1939_TRANSMISSION_GEAR | |
J1939_TURN_SIGNAL | |
J1939_VEHICLE_SPEED | |
LEFT_WIRING | |
MARTERIAL_TYPE | |
VBUS | |
MIL_STATUS | |
OBDII_AIR_FLOW_RATE | |
OBDII_AIR_INTAKE_TEMPERATURE | |
OBDII_AMBIENT_AIR_TEMPERATURE | |
OBDII_BAROMETRIC_PRESSURE | |
OBDII_BATTERY_VOLTAGE | |
OBDII_BOOST_PRESSURE_INTAKE_MANIFOLD_PRESSURE | |
OBDII_DERIVED_ENGINE_STATE | |
OBDII_DISTANCE_SINCE_CODE_CLEARED | |
OBDII_DISTANCE_TRAVELLED_AFTER_MIL_ON | |
OBDII_DTC | Diagnotic Trouble Code |
OBDII_DTC_COUNT | The number of DTCs present |
OBDII_ENGINE_AVERAGE_FUEL_ECONOMY | |
OBDII_ENGINE_COOLANT_PRESSURE | |
OBDII_ENGINE_COOLANT_TEMP | |
OBDII_ENGINE_LOAD | |
OBDII_ENGINE_OIL_TEMP | |
OBDII_ENGINE_SPEED | |
OBDII_EQUIVALENT_COMMAND_RATIO | |
OBDII_FUEL_AIR_COMMANDED_EQUIVAILENCE_RATIO | |
OBDII_FUEL_LEVEL | |
OBDII_FUEL_LEVEL_REMAINING | |
OBDII_FUEL_PRESSURE | |
OBDII_FUEL_RAIL_PRESSURE | |
OBDII_FUEL_RATE | |
OBDII_FUEL_TYPE | |
OBDII_HIGH_BATTERY_VOLTAGE | |
OBDII_IGNITION_TIMING_ADVANCE | |
OBDII_INDICATORS | List of OBD-II indicators |
OBDII_INSTANT_FULE_RATE | |
OBDII_LONG_TERM_FUEL_TRIM_BANK_1 | |
OBDII_LONG_TERM_FUEL_TRIM_BANK_2 | |
OBDII_LOW_BATTERY_VOLTAGE | |
OBDII_MILES_SINCE_LAST_ALERT | Odometer reading from CAN-Bus since last DTC code was cleared |
OBDII_ODOMETER | Odometer reading from CAN-Bus |
OBDII_OEM_PARAMETERS | |
OBDII_OEM_PROTOCOL | |
OBDII_PARAMETERS | List of OBD-II parameters |
OBDII_PROTOCOL | ame or code of the OBD-II protocol in use. |
OBDII_SEATBELT | |
OBDII_SHROT_TERM_FUEL_TRIM_BANK_1 | |
OBDII_SHROT_TERM_FUEL_TRIM_BANK_2 | |
OBDII_THROTTLE_POSITION | |
OBDII_TOTAL_ENGINE_HOURS | |
OBDII_TRANSMISSION_GEAR | |
OBDII_TRIP_FUEL_CONSUMPTION | |
OBDII_TRIP_ODOMETER | |
OBDII_TURN_SIGNAL | |
OBDII_VEHICLE_SPEED | |
OBDII_WIDEBAND_AIR_FUEL_RATIO | |
OBDII_YMME | |
PAUSE | |
PLOW_PRIMARY | |
PLOW_SECONDARY | |
PREWET_RATE | |
RIGHT_WIRING | |
ROAD_TEMPERATURE | |
SPINNER_RATE | |
SPREADER_STATUS_BLAST | |
SPREADER_STATUS_COMMUNICATION | |
SPREADER_STATUS_LIQUID | |
SPREADER_STATUS_MARTERIAL | |
SPREADER_STATUS_PREWET | |
VBUS | |
SPREADER_STATUS_SOLID | |
TOTAL_LIQUID | |
TOTAL_PREWET | |
TOTAL_SOLID | |
UNIT_STATUS | |
VBUS_ACCELERATOR_PEDAL_POSITION | |
VBUS_BRAKE_SWITCH_STATUS | |
VBUS_TOTAL_FUEL_USED | |
VBUS | |
VIN | Vehicle Identification Number |
Value | Description |
---|---|
a | Amperage |
c | Degrees Celsius. Used for temperature |
cmps | Speed in centimetres per second |
cmps2 | Centimetres per second squared. Used for accelerometers. |
degree | Used for heading/bearing, latitude, and longitude |
f | Degrees Fahrenheit. Used for temperature |
gal | Volume in US gallons |
gf | G-force. Used for accelerometers. |
gram | Weight by gram |
hour | Used for times. |
k | Degrees Kelvin. Used for temperature |
kg | Weight by kilogram |
kgpkm | Dry rate in kilogram per kilometer |
kilometre | Distance |
kn | Speed in nautical miles per hour |
knps | Speed in nautical miles per second |
kph | Speed in kilometres per hour |
l | Volume in litres |
l100km | Fuel economy in litres per 100 kilometres |
lbs | Weight by pounds |
lm | Light by Lumens |
lph | Fuel consumption in litres per hour |
lpkm | Prew and anti ice rate in liter per kilometer |
meter | Distance |
mgf | Milli-G-force (thousandths). Used for accelerometers. |
mile | Distance |
minute | Used for times. |
mips | Speed in miles per second |
ml | Volume in millilitres |
mlph | Fuel consumption in millilitres per hour |
mpg | Fuel economy in miles per gallon |
mph | Speed in miles per hour |
mv | Voltage in millivolts |
percent | Percentage (%) |
rpm | Engine speed |
second | Used for times. |
v | Voltage |
Value | Description |
---|---|
ACCELERATION | Hard-acceleration detected |
DECELERATION | Hard-braking detected |
GPS_FOUND | GPS signal re-acquired. |
GPS_LOST | GPS fix was lost. |
HARSH_TURN | Hard-cornering detected |
IB_IN | Gen-X iButton clock-in |
IB_OUT | Gen-X iButton clock-out |
IDLING | Vehicle is stopped and the ignition is on. |
IGNITION_OFF | Vehicle's ignition turned off. |
IGNITION_ON | Vehicle's ignition turned on. |
IMPACT | Impact detected |
IN_REGION | Has entered a designated region or geofence |
LIGHT_OUT_OF_BAND | BeWhere Light sensor alert |
MOVING | Device is in motion |
OUT_REGION | Has left a designated region or geofence |
PARK | Vehicle has stopped and engaged parking brake or the transmission was set to "P". |
PERIODIC | Regular interval report. |
POWER_CONNECTED | External power was connected. |
POWER_DISCONNECTED | External power was disconnected. |
POWER_OFF | Modem is powering off or shutting down. |
POWER_UP | Modem has completed its power-on or boot routine. |
SHORT_POWER_OUT | Modem is shutting down immediately. |
SLEEP | Modem is going in to low-power state or sleep mode. |
SPEEDING | Device is speeding |
SPEEDING_STOP | Device stopped speeding |
STOP_MOVING | Device has stopped moving |
TAMPER_DETECT | Tamper detection sensor activated |
UNDEFINED | Unknown or undefined event name. |
VIN_FOUND | VIN has been retreived from VBus |
WAKE_UP | Modem is coming in to normal power consumption state, or wake mode. |
Value | Description |
---|---|
boolean | True or false. |
number | Numeric value (double-precision floating point number). |
text | Text. |
Value | Description |
---|---|
airlink | Sierra Wireless AirLink RAP protocol |
atrack | ATrack device protocols |
bewhere | BeWhere beacon protocols |
bluetree | Sixnet BlueTree BEP protocol |
calamp | CalAmp LMU/TTU modem protocols |
datatrans | TachWest DataTrans protocol |
enfora | Enfora (Novotel) modem protocols |
genx | Gen-X modem protocol |
json | Fleet Freedom JSON protocol |
lbs | Bell Mobility LBS |
lmu | CalAmp LMU series protocol |
mobile | Trak iT Wireless Mobile App |
smartwitness | SmartWitness dashcam formats |
spiderAT | Novotel Enfora SpiderAT protocol |
spiderMT | Novotel Enfora SpiderMT protocol |
titan | Certified Tracking protocol |
ttu | CalAmp TTU series protocol |
unknown | Your guess is as good as mine. It should never be this. |
Value | Description |
---|---|
cancelled | Sending of the new configuration was halted by a user. |
completed | New configuration successfully sent to provider. |
created | The new configuration has been created, but not yet sent to the provider. |
error | Something went wrong while trying to send configuration. |
inProgress | Currently sending configuration over-the-air to the provider. |
maxRetries | The maximum number of retries were attempted before giving up. |
otaSent | A message was sent to the provider asking it to check in. |
partial | Only a partial configuration was sent to the provider. |
pending | Provider is notified of new configuration, but has not yet checked in. |
unknown | Your guess is as good as mine. It should never be this. |
Value | Description |
---|---|
distance | The minimum distance travelled in a Summary Instance before it is included in the results. Supplied as a number of meters. |
duration | The minimum amount of time for a Summary nice before it is included in the results. Supplied as a duration string. |
prolonged | The maximum amount of time in a Summary Instance before it is split into two and the latter marked as an exception in the results. Supplied as a duration string. |
rubicon | The maximum distance travelled in a Summary Instance before it is split into two and the latter marked as an exception in the results. Supplied as a number of meters. |
tags | A list of status tags an Asset must have to be included in the results. Should be a comma separated string of codified tag names. |
timeOfDay | Time-span processed on each day. Only data within the time-span is included in the results. The times should be 2 space separated duration strings. |
Value | Description |
---|---|
places | All Places visited. |
regions | Every geographic region such as cities, provinces/states, and countries. |
tags | Analysis for each Status Tag applied to each asset. |
tasks | Life-time of each Task assigned to each asset. |
Value | Description |
---|---|
filterMatch | The asset started/stopped matching the report filter settings. For example, they left a province or entered a Place. |
outsideRange | If the report starting/ending date range overlaps the actual start of the state. |
split | The summary instance elapsed a Rubicon or prolonged parameter, and was split into two summary instances. |
stateMatch | The asset started/stopped matching the required state. For example, a status tag was added or removed. |
targeted | The targeting query starts or stops matching. For example, the Asset's labels were changed. |
Value | Description |
---|---|
exclusive | Exclude all results except those whose filters match. |
inclusive | Include any results for those whose filters match. |
none | Filtering is not enabled for the report. |
Value | Description |
---|---|
attributes | A list of attribute names an Asset must have to be included in the results. Should be a comma separated string of codified tag names. |
collate | A choice in the method used to calculate a Summary Instance's values. For an attribute report, the possible values are "instance" where if the attribute is present it is included, and "value" where each attribute's simple value becomes it's own summary instance. For a Tag Summary report, the possible values are "inclusive" where any of the given tags must match, and "exclusive" where all the given tags must match. |
distance | The minimum distance travelled in a Summary Instance before it is included in the results. Supplied as a number of meters. |
duration | The minimum amount of time for a Summary nice before it is included in the results.
Supplied as a |
endDate | The ending date/time range for events to be included in the results. The date should be a valid ISO-8601 string. |
prolonged | The maximum amount of time in a Summary Instance before it is split into two and the latter marked as an exception in the results.
Supplied as a |
rubicon | The maximum distance travelled in a Summary Instance before it is split into two and the latter marked as an exception in the results. Supplied as a number of meters. |
startDate | The staring date/time range for events to be included in the results. The date should be a valid ISO-8601 string. |
tags | A list of status tags an Asset must have to be included in the results. Should be a comma separated string of codified tag names. |
timeOfDay | Time-span processed on each day. Only data within the time-span is included in the results. The times should be 2 space separated duration strings. |
Value | Description |
---|---|
annually | Yearly at midnight in the local timezone based on the ReportRecurrence.start date. |
daily | Daily at midnight in the local timezone for the previous day based on the ReportRecurrence.weekdays. |
monthly | Monthly at midnight in the local timezone for the previous month based on the ReportRecurrence.start date. |
once | Runs only once. This type is used for large reports which need to run overnight. |
quarterly | Runs once every three months at midnight in the local timezone for the previous 3 months based on the ReportRecurrence.start date. |
weekly | Weekly at midnight in the local timezone for the previous 7 days based on the ReportRecurrence.weekday. |
Value | Description |
---|---|
completed | The results are available for retrieval. |
created | The report results have been requested, but not yet begun processing |
failed | There was an error processing the results; see the notes section for a description. |
queued | The report is waiting for required resources to begin running |
running | The results are currently being processed. |
saving | The results have been calculated, and are being saved for review. |
Value | Description |
---|---|
attributes | Attributes Summarizes the timeline based on the given attributes and thresholds. |
full | Full History Processes all history for the assets. |
messages | Messaging Processes the log of messages sent to and from the assets. |
places | Place Summary Summarizes the timeline based on places visited. |
regions | Regions Summarizes the timeline based on the regions (cities, provinces/states, countries) through which the assets travelled. |
tags | Tag Summary Summarizes the timeline based on the given tags. |
tasks | Task Lifetime Summarizes the timeline based on the asset's task's lifetimes. |
Value | Description |
---|---|
maintenance | Notification of impending maintenance window involving downtime. During a maintenance window, the service may go down and come back online repeatedly until the window ends. |
upgrade | Notification that an upgrade will be available. |
Type | Event Name | JSON Message | Description | |
---|---|---|---|---|
always sent | assetAlert | AssetAlert | ||
always sent | broadcast | BroadcastMaintenance BroadcastUpgrade | ||
assetAdvanced | assetAdvancedMerged | AssetAdvanced VehicleAdvanced | Assets' advanced properties such as position, attributes, and status tags. | |
assetGeneral | assetGeneralMerged | AssetGeneral PersonGeneral VehicleGeneral TrailerGeneral | Assets' general properties such as name, icon, and labels. | |
assetDeleted | AssetDeleted | Relevant details of an asset which was deleted. | ||
assetSuspended | AssetSuspended | Relevant details of an asset which was suspended. | ||
assetMessage | assetMessageMerged | Message | Messages from assets and Alerts to the session user. | |
assetMessageDeleted | MessageDeleted | Relevant details of a message which was deleted. | ||
behaviour | behaviourMerged | Behaviour | Configured behaviours. | |
behaviourDeleted | BehaviourDeleted | Relevant details of a behaviour which was deleted. | ||
behaviourLog | behaviourLogMerged | BehaviourLog | Behaviour log messages to help developers debug their scripts. | |
behaviourLogDeleted | BehaviourLogDeleted | Relevant details of a log message which was deleted. | ||
behaviourScript | behaviourScriptMerged | BehaviourScript | Behaviour script logic. | |
behaviourScriptDeleted | BehaviourScriptDeleted | Relevant details of a script which was deleted. | ||
billingDiscount | billingDiscountMerged | BillableHostingDiscount | Discount rules for assets. | |
billingDiscountDeleted | BillableHostingDiscountDeleted | Relevant details of a hosting Discount which was deleted. | ||
billingHosting | billingHostingMerged | BillableHostingRule | Billing rules for assets. | |
billingHostingDeleted | BillableHostingRuleDeleted | Relevant details of a hosting rule which was deleted. | ||
billingLicense | billingLicenseMerged | BillableHostingLicense | Hardware licenses for providers. | |
billingLicenseDeleted | BillableHostingLicenseDeleted | Relevant details of a hosting license which was deleted. | ||
billingProfile | billingProfileMerged | BillingProfile | Profiles used to generate billable orders for a customer. | |
billingProfileDeleted | BillingProfileDeleted | Relevant details of a billing profile which was deleted. | ||
billingReport | billingReportMerged | BillingReport | Reports generated for a billee company. | |
billingReportDeleted | BillingReportDeleted | Relevant details of a billing report which was deleted. | ||
companyGeneral | companyGeneralMerged | CompanyGeneral | Renaming and changing the nodes of a company. | |
companyDeleted | CompanyDeleted | Relevant details of a company which was deleted. | ||
companyLabels | companyLabelsMerged | CompanyLabels | Company's label and tag styles. | |
companyPolicies | companyPoliciesMerged | CompanyPolicies | Company's SessionPolicy and PasswordPolicy. | |
contact | contactMerged | Contact | Contact information. | |
contactDeleted | ContactDeleted | Relevant details of a contact which was deleted. | ||
dispatchTask | dispatchTaskMerged | DispatchTask | Assets' tasks information. | |
dispatchTaskDeleted | DispatchTaskDeleted | Relevant details of a task which was deleted. | ||
document | documentMerged | Document | Hosted document information. | |
documentDeleted | DocumentDeleted | Relevant details of a document which was deleted. | ||
hosCarrier | hosCarrierMerged | HosCarrier | Hours of Service carriers. | |
hosCarrierDeleted | HosCarrierDeleted | Relevant details of a carrier which was deleted. | ||
hosEvent | hosEventMerged | HosEvent | Driver's E-log event records. | |
hosEventDeleted | HosEventDeleted | |||
hosInspection | hosInspectionMerged | HosInspection | Driver vehicle inspection reports. | |
hosInspectionDeleted | HosInspectionDeleted | |||
icon | iconMerged | Icon | Synchronizes icon information. This does not automatically send the picture, that must be requested through the Pictures API. | |
iconDeleted | IconDeleted | Relevant details of an icon which was deleted. | ||
machine | machineMerged | Machine | API Credentials information and permissions. | |
machineDeleted | MachineDeleted | Relevant details of a Service Account which was deleted. | ||
maintenanceJob | maintenanceJobMerged | MaintenanceJob | Historical vehicle and trailer maintenance work. | |
maintenanceJobDeleted | MaintenanceJobDeleted | Relevant details of a maintenance job which was deleted. | ||
maintenanceSchedule | maintenanceScheduleMerged | MaintenanceSchedule | Recurring maintenance work for vehicles and trailers. | |
maintenanceScheduleDeleted | MaintenanceScheduleDeleted | Relevant details of a maintenance schedule which was deleted. | ||
picture | pictureMerged | Picture | Synchronizes picture information. This does not automatically send the picture, that must be requested through the Pictures API. | |
pictureDeleted | PictureDeleted | Relevant details of a picture which was deleted. | ||
placeGeneral | placeGeneralMerged | PlaceGeneral | Synchronizes place information | |
placeDeleted | PlaceDeleted | Relevant details of a place which was deleted. | ||
providerAdvanced | providerAdvancedMerged | ProviderAdvanced | Raw provider (device) data like GPS coordinates and parsed ODB-II values. | |
providerCommand | providerCommandMerged | |||
providerCommandDeleted | ProviderCommandDeleted | |||
providerConfig | providerConfigMerged | |||
providerConfigDeleted | ProviderConfigDeleted | Relevant details of a configuration which was deleted. | ||
providerConfiguration | providerConfigurationMerged | ProviderConfiguration | Provider (device) configurations. | |
providerConfigurationDeleted | ProviderConfigurationDeleted | Relevant details of a configuration which was deleted. | ||
providerGeneral | providerGeneralMerged | ProviderGeneral | Provider (device) information like name, notes, and selected asset. | |
providerDeleted | ProviderDeleted | Relevant details of a device which was deleted. | ||
providerSuspended | ProviderSuspended | Relevant details of an device which is suspended. | ||
providerRegistration | providerRegistrationMerged | ProviderRegistration | Pending Providers (devices) that have not yet been configured or provisioned. | |
providerRegistrationDeleted | ProviderRegistrationDeleted | Relevant details of a Provider Registration which was deleted. | ||
providerScript | providerScriptMerged | |||
providerScriptDeleted | ProviderScriptDeleted | Relevant details of a configuration which was deleted. | ||
reportResult | reportResultMerged | ReportResult | Historical asset details like breadcrumb trails. The full report results are not sent, only the totals. You need to use the Reports API to request the summary and breakdown. | |
reportResultDeleted | ReportResultDeleted | Relevant details of report results which was deleted. | ||
reportSchedule | reportScheduleMerged | |||
reportScheduleDeleted | ReportScheduleDeleted | Relevant details of report schedule which was deleted. | ||
reportTemplate | reportTemplateMerged | ReportTemplate | Report configurations | |
reportTemplateDeleted | ReportTemplateDeleted | Relevant details of a report template which was deleted. | ||
userAdvanced | userAdvancedMerged | UserAdvanced | User information such as permissions and group membership. | |
userGeneral | userGeneralMerged | UserGeneral | General user information such as name, contact information, and preferences. | |
userDeleted | UserDeleted | Relevant details of a user which was deleted. | ||
userGroup | userGroupMerged | UserGroup | Group information for easy access control. | |
userGroupDeleted | UserGroupDeleted | Relevant details of a group which was deleted. |
Value | Description |
---|---|
Carrier pigeon. | |
popup | A separate message sent across the WebSocket. |
sms | A text message (SMS). |
Value | Description |
---|---|
full | Full control to read, write, delete and create things. |
read | Read-only access, no changes allowed. |
update | Read and write access, but things cannot be deleted or new things created. |
Value | Description |
---|---|
grant | Permission is given. |
revoke | Permission is taken away. |
Value | Description |
---|---|
metric | Metric |
standard | US Standard. |
Input | Codified |
---|---|
Truck | truck |
Truck 13 | truck-13 |
Truck #19 | truck-19 |
Dave's Truck (#36) | daves-truck-36 |
Greg's "Rusty" Truck (#42) | gregs-rusty-truck-42 |
yyyy-MM-ddTHH:mm:ss[.fff]Z
Element | Description |
---|---|
yyyy | Four digit year. |
MM | Two digit month. |
dd | Two digit day of the month. |
T | A separator between date and time. |
HH | Two digit hours ranging from 00 to 23. |
mm | Two digit minute. |
ss | Two digit second. |
fff | Optional three digit millisecond. |
Z | A terminator representing the UTC timezone. |
[-][d.]H:mm[:ss[.fff]]
[-][d]
Element | Description |
---|---|
- | Optional minus sign to indicate a negative duration. |
d | Optional days, ranging from 0 to 10675199. |
H | Single or two digit hours ranging from 0 to 23. |
mm | Two digit minute. |
ss | Optional two digit second. |
fff | Optional three digit millisecond. When including milliseconds, the two-digit seconds are also required even if the value is 00. |
user@domain.tld
operator:terms terms
It's easiest to look at a few examples.
{
"id": 1234,
"name": "Truck",
"kind": "vehicle",
"labels": [
"east-coast",
"head-office"
]
}
{
"id": 4567,
"name": "Alex",
"kind": "person",
"labels": [
"drivers",
"head-office"
]
}
{
"id": 7890,
"name": "Mike",
"kind": "person",
"labels": [
"east-coast",
"service"
]
}
n.n.n.n[/r]
Element | Description |
---|---|
n | A number ranging from 0 to 255. |
r | CIDR notation to indicate a range of IPv4 addresses. The number ranges from 32 to 0. |
An implementation of Google's Encoded Polyline algorithm.
The algorithm is a lossy compression that stores a series of coordinates as a single string. All coordinates are rounded to five decimal places before encoding, but this should be accurate to within roughly one and a half meters.
Full details can be found on Google's Maps API site, as well as a utility to test encoding and decoding.
A string in the format of a Uniform Resource Locator.
Typically, these point to a website or web-page, though it is possible to be used to identify a WebSocket or other remote resources.