Add Location

curl --request POST \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/location \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "categoryName": "<string>",
  "id": "<string>",
  "address": {
    "roadNumber": "<string>",
    "road": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "coordinate": {
    "longitude": 123,
    "latitude": 123
  },
  "radius": 123,
  "polygon": [
    {
      "longitude": 123,
      "latitude": 123
    }
  ],
  "reference": "<string>",
  "phoneNumber": "<string>",
  "contact": "<string>",
  "email": "<string>",
  "notes": "<string>"
}
'

{
  "name": "<string>",
  "categoryName": "<string>",
  "id": "<string>",
  "address": {
    "roadNumber": "<string>",
    "road": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "coordinate": {
    "longitude": 123,
    "latitude": 123
  },
  "radius": 123,
  "polygon": [
    {
      "longitude": 123,
      "latitude": 123
    }
  ],
  "reference": "<string>",
  "phoneNumber": "<string>",
  "contact": "<string>",
  "email": "<string>",
  "notes": "<string>"
}

/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.

The address for the location can be specified as either:

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.
If both an address and longitude/latitude values are specified, then no check is performed to validate that the address matches the longitude/latitude values.
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.
The geofence for a location can overlap the geofence for another location.
The geofence for this location can overlap up to 5 locations.
The details for the new location are sent as a JSON object included in the HTTP body.
Ensure you have set the content-type of the request body to “application/json;charset=UTF-8”.

POST

customer

{customerId}

location

Add Location

curl --request POST \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/location \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "categoryName": "<string>",
  "id": "<string>",
  "address": {
    "roadNumber": "<string>",
    "road": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "coordinate": {
    "longitude": 123,
    "latitude": 123
  },
  "radius": 123,
  "polygon": [
    {
      "longitude": 123,
      "latitude": 123
    }
  ],
  "reference": "<string>",
  "phoneNumber": "<string>",
  "contact": "<string>",
  "email": "<string>",
  "notes": "<string>"
}
'

{
  "name": "<string>",
  "categoryName": "<string>",
  "id": "<string>",
  "address": {
    "roadNumber": "<string>",
    "road": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "coordinate": {
    "longitude": 123,
    "latitude": 123
  },
  "radius": 123,
  "polygon": [
    {
      "longitude": 123,
      "latitude": 123
    }
  ],
  "reference": "<string>",
  "phoneNumber": "<string>",
  "contact": "<string>",
  "email": "<string>",
  "notes": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId

string

required

Body

application/json

name

string

required

Unique name for the location.

categoryName

string

required

Name of an existing location category.

string

address

object

Address object of the location.

Show child attributes

coordinate

object

Show child attributes

radius

number<double>

Radius (in km) of the location boundary.
Must be between 0.001 and 1.
Must be specified if polygon details are not specified.

polygon

object[]

Array of points that define the geo-fence boundary of the polygon.
Must be specified if radius is not specified.

Show child attributes

reference

string

phoneNumber

string

contact

string

A valid email address for this location.
Cannot be more than 50 characters.

notes

string

Notes for this location, Cannot be more than 140 characters.

Response

200 - application/json

Successful operation

name

string

required

Unique name for the location.

categoryName

string

required

Name of an existing location category.

string

address

object

Address object of the location.

Show child attributes

coordinate

object

Show child attributes

radius

number<double>

Radius (in km) of the location boundary.
Must be between 0.001 and 1.
Must be specified if polygon details are not specified.

polygon

object[]

Array of points that define the geo-fence boundary of the polygon.
Must be specified if radius is not specified.

Show child attributes

reference

string

phoneNumber

string

contact

string

A valid email address for this location.
Cannot be more than 50 characters.

notes

string

Notes for this location, Cannot be more than 140 characters.

Update Location Delete Location

⌘I

API Documentation

Authorizations

Path Parameters

Body

Response