Update Location

curl --request PUT \
  --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

Update Location

PUT request to update location details.
The identifier for the location to be updated is included in the JSON body.
This is a partial update and only those details specified in the JSON body will be updated.
The updated address for the location can be specified as just the longitude and latitude coordinates or an address (roadNumber, road, city, postcode, country).
The type of a location can be updated from a circle to a polygon or from a polygon to a circle, by specifying the the geofence for the location 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 location details are in 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”.
JSON object structure for the address specified as longitude and latitude:

PUT

customer

{customerId}

location

Update Location

curl --request PUT \
  --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.

List Location Add Location

⌘I

API Documentation

Authorizations

Path Parameters

Body

Response