Geofences
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
Responses | Example Value
[
{
"boundingBox": {
"maxX": 0,
"maxY": 0,
"minX": 0,
"minY": 0
},
"circleShape": {
"center": {
"latitude": 0,
"longitude": 0
},
"radius": 0
},
"description": "string",
"id": 0,
"name": "string",
"polygonShape": {
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"routeShape": {
"radius": 0,
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"shapeType": "Polygon"
}
]
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
geofenceid:long * required
integer
(query)
Geofenceid of the Geofence you want to work with.
Responses | Example Value
{
"boundingBox": {
"maxX": 0,
"maxY": 0,
"minX": 0,
"minY": 0
},
"circleShape": {
"center": {
"latitude": 0,
"longitude": 0
},
"radius": 0
},
"description": "string",
"id": 0,
"name": "string",
"polygonShape": {
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"routeShape": {
"radius": 0,
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"shapeType": "Polygon"
}
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
geofenceid:long * required
integer
(query)
Id of the geofence.
UpdatesFrom
string
(query)
Returns status of all users that has been active after or equal to this timestamp (As defined by date-time - RFC3339)
Sample date-time: 1996-12-19T16:39:57-08:00
This represents 39 minutes and 57 seconds after the 16th hour of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
Kind
string
(query)
Filters the result set by user kind.
Name
string
(query)
Filters the result set by name. The comparison is case insensitive, and is applied with wildcards before and after the search string.
Responses | Example Value
[
{
"calculatedSpeed": 0,
"description": "string",
"deviceActivity": "string",
"devices": [
{
"aPN": "string",
"created": "string",
"deviceDefinitionID": 0,
"devicePassword": "string",
"email": "string",
"gPRSPassword": "string",
"gPRSUsername": "string",
"hidePosition": true,
"iD": 0,
"iMEI": "string",
"lastIP": "string",
"lastPort": 0,
"latitude": 0,
"longitude": 0,
"mobileNetworkID": 0,
"msgFieldDictionaryID": 0,
"mSISDN": {
"raw": "string"
},
"name": "string",
"oneWireVariables": [
{
"deviceDefinitionID": 0,
"deviceID": 0,
"oneWireID": "string",
"variableName": "string"
}
],
"ownerEmail": "string",
"ownerID": 0,
"ownerName": "string",
"ownerUsername": "string",
"profileId": 0,
"protocolID": "string",
"protocolVersionID": 0,
"proximity": 0,
"staticIP": "string",
"staticPort": 0,
"timeStamp": "string"
}
],
"driverID": "string",
"email": "string",
"icon": {
"iconGUID": "string",
"iconOffsetX": 0,
"iconOffsetY": 0,
"rotatable": true
},
"id": 0,
"lastTransport": "string",
"name": "string",
"originalApplicationID": 0,
"phoneNumber": "string",
"surname": "string",
"trackPoint": {
"position": {
"altitude": 0,
"latitude": 0,
"longitude": 0
},
"uTC": "string",
"valid": true,
"velocity": {
"groundSpeed": 0,
"heading": 0
}
},
"username": "string",
"userTemplateID": 0
}
]
Groups
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
Responses | Example Value
[
{
"applicationId": 0,
"description": "string",
"id": 0,
"name": "string",
"usersIds": [
0
]
}
]
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
groupid:int * required
integer
(query)
Id of the target group.
UpdatesFrom
string
(query)
Returns status of all users that has been active after or equal to this timestamp (As defined by date-time - RFC3339)
Sample date-time: 1996-12-19T16:39:57-08:00
This represents 39 minutes and 57 seconds after the 16th hour of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
Kind
string
(query)
Filters the result set by user kind.
Name
string
(query)
Filters the result set by name. The comparison is case insensitive, and is applied with wildcards before and after the search string.
Responses | Example Value
[
{
"calculatedSpeed": 0,
"description": "string",
"deviceActivity": "string",
"devices": [
{
"aPN": "string",
"created": "string",
"deviceDefinitionID": 0,
"devicePassword": "string",
"email": "string",
"gPRSPassword": "string",
"gPRSUsername": "string",
"hidePosition": true,
"iD": 0,
"iMEI": "string",
"lastIP": "string",
"lastPort": 0,
"latitude": 0,
"longitude": 0,
"mobileNetworkID": 0,
"msgFieldDictionaryID": 0,
"mSISDN": {
"raw": "string"
},
"name": "string",
"oneWireVariables": [
{
"deviceDefinitionID": 0,
"deviceID": 0,
"oneWireID": "string",
"variableName": "string"
}
],
"ownerEmail": "string",
"ownerID": 0,
"ownerName": "string",
"ownerUsername": "string",
"profileId": 0,
"protocolID": "string",
"protocolVersionID": 0,
"proximity": 0,
"staticIP": "string",
"staticPort": 0,
"timeStamp": "string"
}
],
"driverID": "string",
"email": "string",
"icon": {
"iconGUID": "string",
"iconOffsetX": 0,
"iconOffsetY": 0,
"rotatable": true
},
"id": 0,
"lastTransport": "string",
"name": "string",
"originalApplicationID": 0,
"phoneNumber": "string",
"surname": "string",
"trackPoint": {
"position": {
"altitude": 0,
"latitude": 0,
"longitude": 0
},
"uTC": "string",
"valid": true,
"velocity": {
"groundSpeed": 0,
"heading": 0
}
},
"username": "string",
"userTemplateID": 0
}
]
GeofenceGroups
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
Responses | Example Value
[
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}
]
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
geofencegroupid:long * required
integer
(path)
GeofenceGroupid of the GeofenceGroup you want to work with
Responses | Example Value
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| FromIndex integer (query) |
The starting index of the page (exclusive) |
| PageSize integer (query) |
The size of the page |
Responses | Example Value
[
{
"boundingBox": {
"maxX": 0,
"maxY": 0,
"minX": 0,
"minY": 0
},
"circleShape": {
"center": {
"latitude": 0,
"longitude": 0
},
"radius": 0
},
"description": "string",
"id": 0,
"name": "string",
"polygonShape": {
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"routeShape": {
"radius": 0,
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"shapeType": "Polygon"
}
]
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| geofenceid:long * required integer (query) |
Geofenceid of the Geofence you want to work with. |
Responses | Example Value
{
"boundingBox": {
"maxX": 0,
"maxY": 0,
"minX": 0,
"minY": 0
},
"circleShape": {
"center": {
"latitude": 0,
"longitude": 0
},
"radius": 0
},
"description": "string",
"id": 0,
"name": "string",
"polygonShape": {
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"routeShape": {
"radius": 0,
"vertices": [
{
"latitude": 0,
"longitude": 0
}
]
},
"shapeType": "Polygon"
}
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| FromIndex integer (query) |
The starting index of the page (exclusive) |
| PageSize integer (query) |
The size of the page |
| geofenceid:long * required integer (query) |
Id of the geofence. |
| UpdatesFrom string (query) |
Returns status of all users that has been active after or equal to this timestamp (As defined by date-time - RFC3339) Sample date-time: 1996-12-19T16:39:57-08:00 This represents 39 minutes and 57 seconds after the 16th hour of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z in UTC. |
| Kind string (query) |
Filters the result set by user kind. |
| Name string (query) |
Filters the result set by name. The comparison is case insensitive, and is applied with wildcards before and after the search string. |
Responses | Example Value
[
{
"calculatedSpeed": 0,
"description": "string",
"deviceActivity": "string",
"devices": [
{
"aPN": "string",
"created": "string",
"deviceDefinitionID": 0,
"devicePassword": "string",
"email": "string",
"gPRSPassword": "string",
"gPRSUsername": "string",
"hidePosition": true,
"iD": 0,
"iMEI": "string",
"lastIP": "string",
"lastPort": 0,
"latitude": 0,
"longitude": 0,
"mobileNetworkID": 0,
"msgFieldDictionaryID": 0,
"mSISDN": {
"raw": "string"
},
"name": "string",
"oneWireVariables": [
{
"deviceDefinitionID": 0,
"deviceID": 0,
"oneWireID": "string",
"variableName": "string"
}
],
"ownerEmail": "string",
"ownerID": 0,
"ownerName": "string",
"ownerUsername": "string",
"profileId": 0,
"protocolID": "string",
"protocolVersionID": 0,
"proximity": 0,
"staticIP": "string",
"staticPort": 0,
"timeStamp": "string"
}
],
"driverID": "string",
"email": "string",
"icon": {
"iconGUID": "string",
"iconOffsetX": 0,
"iconOffsetY": 0,
"rotatable": true
},
"id": 0,
"lastTransport": "string",
"name": "string",
"originalApplicationID": 0,
"phoneNumber": "string",
"surname": "string",
"trackPoint": {
"position": {
"altitude": 0,
"latitude": 0,
"longitude": 0
},
"uTC": "string",
"valid": true,
"velocity": {
"groundSpeed": 0,
"heading": 0
}
},
"username": "string",
"userTemplateID": 0
}
]
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| FromIndex integer (query) |
The starting index of the page (exclusive) |
| PageSize integer (query) |
The size of the page |
Responses | Example Value
[
{
"applicationId": 0,
"description": "string",
"id": 0,
"name": "string",
"usersIds": [
0
]
}
]
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| FromIndex integer (query) |
The starting index of the page (exclusive) |
| PageSize integer (query) |
The size of the page |
| groupid:int * required integer (query) |
Id of the target group. |
| UpdatesFrom string (query) |
Returns status of all users that has been active after or equal to this timestamp (As defined by date-time - RFC3339) Sample date-time: 1996-12-19T16:39:57-08:00 This represents 39 minutes and 57 seconds after the 16th hour of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z in UTC. |
| Kind string (query) |
Filters the result set by user kind. |
| Name string (query) |
Filters the result set by name. The comparison is case insensitive, and is applied with wildcards before and after the search string. |
Responses | Example Value
[
{
"calculatedSpeed": 0,
"description": "string",
"deviceActivity": "string",
"devices": [
{
"aPN": "string",
"created": "string",
"deviceDefinitionID": 0,
"devicePassword": "string",
"email": "string",
"gPRSPassword": "string",
"gPRSUsername": "string",
"hidePosition": true,
"iD": 0,
"iMEI": "string",
"lastIP": "string",
"lastPort": 0,
"latitude": 0,
"longitude": 0,
"mobileNetworkID": 0,
"msgFieldDictionaryID": 0,
"mSISDN": {
"raw": "string"
},
"name": "string",
"oneWireVariables": [
{
"deviceDefinitionID": 0,
"deviceID": 0,
"oneWireID": "string",
"variableName": "string"
}
],
"ownerEmail": "string",
"ownerID": 0,
"ownerName": "string",
"ownerUsername": "string",
"profileId": 0,
"protocolID": "string",
"protocolVersionID": 0,
"proximity": 0,
"staticIP": "string",
"staticPort": 0,
"timeStamp": "string"
}
],
"driverID": "string",
"email": "string",
"icon": {
"iconGUID": "string",
"iconOffsetX": 0,
"iconOffsetY": 0,
"rotatable": true
},
"id": 0,
"lastTransport": "string",
"name": "string",
"originalApplicationID": 0,
"phoneNumber": "string",
"surname": "string",
"trackPoint": {
"position": {
"altitude": 0,
"latitude": 0,
"longitude": 0
},
"uTC": "string",
"valid": true,
"velocity": {
"groundSpeed": 0,
"heading": 0
}
},
"username": "string",
"userTemplateID": 0
}
]
GeofenceGroups
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
FromIndex
integer
(query)
The starting index of the page (exclusive)
PageSize
integer
(query)
The size of the page
Responses | Example Value
[
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}
]
Parameters
Name
Description
applicationid:int* required
integer
(path)
ID of the application you want to work with.
geofencegroupid:long * required
integer
(path)
GeofenceGroupid of the GeofenceGroup you want to work with
Responses | Example Value
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| FromIndex integer (query) |
The starting index of the page (exclusive) |
| PageSize integer (query) |
The size of the page |
Responses | Example Value
[
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}
]
Parameters
| Name | Description |
|---|---|
| applicationid:int* required integer (path) |
ID of the application you want to work with. |
| geofencegroupid:long * required integer (path) |
GeofenceGroupid of the GeofenceGroup you want to work with |
Responses | Example Value
{
"colour": "string",
"description": "string",
"geofenceIds": [
0
],
"id": 0,
"name": "string",
"pinned": true,
"priority": 0,
"useInGeocoding": true
}