Point
A Point corresponds to a user-defined “location” on the map, and is typically used in reporting summaries, or in the creation of alarms. Often referred to as POI.
URL Structure is:
https://api.trackunit.com/public/Point
GetPoint
Will list parameters on a specified point.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier |
Errors
Error Code | Description |
---|---|
pointNotFound | Point with supplied “Id” was not found. |
Columns
Refer to the following table for description of columns:
Name | Data type | Unit of measurement | Nullability | Note |
---|---|---|---|---|
id | String | N/A | FALSE | Unique identifier |
name | String | N/A | FALSE | |
note | String | N/A | TRUE | |
icon | String | N/A | TRUE | |
location | Location | N/A | FALSE | |
address | Address | N/A | TRUE |
Request (example)
{
"id": "71067"
}
Response
{
"list": [
{
"id": "71067",
"name": "Region West",
"note": "Company headquarters",
"icon": "16x16/about.png",
"location": {
"latitude": 51.20118,
"longitude": 6.777766
},
"address": {
"country": "DE",
"zipCode": "40237",
"city": "Düsseldorf",
"streetAddress": "Sohnstr. 159"
}
}
]
}
CreatePoint
Will create a new point.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
name * | String | N/A | Name of point. |
note | String | N/A | |
location * | Location | N/A | |
address | Address | N/A |
Request (example)
{
"name": "Berlin depot",
"location":{
"latitude":52.530112,
"longitude":13.522968
}
}
Response
{
"id": "71094"
}
UpdatePoint
Will update parameters on an existing point.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier. |
name | String | N/A | Name of point. |
note | String | N/A | |
location | Location | N/A | |
address | Address | N/A |
Request (example)
{
"id": "71067",
"name": "Region North"
}
Response
{}
DeletePoint
Will delete an existing point.
Parameters
Name | Data type | Unit of measurement | Note |
---|---|---|---|
id * | String | N/A | Unique identifier. |
Request (example)
{
"id": "71067"
}
Response
{}
Updated less than a minute ago