Add Location
/location
Add Location
POST request to add a new location with a geo-fence boundary that can be either CIRCULAR or POLYGON. There cannot be an existing location with the same name as the location being created.
The maximum number of POI that can be created in your account is limited based on the number of vehicles in your fleet.
- if your fleet size is less than 1,000 then you can create up to 250,000 locations
- if your fleet size is more than 1,000, then the maximum is reduced on a sliding scale depending on the number of vehicles in your fleet
- longitude and latitude coordinates - An address lookup is done to determine values for roadNumber, road, city, postcode and country. The formattedAddress is constructed as a comma separated set of values from roadNumber, road, city, postcode and country.
- roadNumber, road, city, postcode, country - Values for city, postcode and country are mandatory and must be included in the input JSON object. The formattedAddress is constructed as a comma separated set of values from roadNumber, road, city, postcode and country. A lookup is done to determine the longitude and latitude coordinates.
The geofence for the location can be specified as either:
- radius - A geofence for the location is a circle. The radius for the circle must be between 0.001 and 1.
- polygon - The geofence for the location is a polygon which is specified as an array of longitude and latitude pairs. There must be at least three longitude and latitude pairs specified. The geofence boundary is closed by automatically linking the first longitude and latitude pair to the last longitude and latitude pair specified.
POST
Add Location
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json;charset=UTF-8
Pattern:
^[\w]*$Geographic coordinate with latitude and longitude values.
Required array length:
3 - 2147483647 elementsMaximum string length:
50Maximum string length:
20Pattern:
^\+?\d+$Maximum string length:
50Maximum string length:
50Maximum string length:
140Response
200 - application/json;charset=UTF-8
Successful operation
Pattern:
^[\w]*$Geographic coordinate with latitude and longitude values.
Required array length:
3 - 2147483647 elementsMaximum string length:
50Maximum string length:
20Pattern:
^\+?\d+$Maximum string length:
50Maximum string length:
50Maximum string length:
140