Skip to main content
GET
/
customer
/
{customerId}
/
location
/
current
List Location
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/location/current \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "address": {
    "formattedAddress": "<string>",
    "road": "<string>",
    "roadNumber": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>",
    "roadType": "<string>"
  },
  "coordinate": {
    "longitude": 123,
    "latitude": 123
  },
  "customerId": "<string>",
  "customerReference": "<string>",
  "categoryId": "<string>",
  "categoryName": "<string>",
  "radiusKm": 123,
  "polygon": [
    {
      "longitude": 123,
      "latitude": 123
    }
  ],
  "type": "<string>",
  "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

Query Parameters

​
name
string

Location name search string.
This is a case insensitive partial match.
A location will match if the specified name is found anywhere in the location name.

​
address
string

Location address search string.
This is a case insensitive partial match.
A location will match if the specified address is found anywhere in formatedAddress.

​
category
string

A location category name.
This is a case sensitive exact match search.

​
reference
string

Location reference search string.
This is a case insensitive partial match.
A location will match if the specified reference is found anywhere in reference.

​
phoneNumber
string

Location phone number search string.
This is a partial match.
A location will match

​
pageIndex
integer

Specifies the pagination page index.
Pages are zero indexed, i.e.
the first page has an index value of zero.

​
pageSize
integer

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

Response

200 - application/json

Successful operation

​
id
string

Unique, unchangeable system generated identifier (alphanumeric) of the location.

​
name
string

Name of the location.

​
address
object
​
coordinate
object
​
customerId
string

MCF customer identifier (alphanumeric).

​
customerReference
string

MCF customer reference.

​
categoryId
string

Unique, unchangeable system generated identifier (alphanumeric) for the location category.

​
categoryName
string

The name of the location category.

​
radiusKm
number<double>
​
polygon
object[]

Array of points that define the geo-fence boundary of the polygon.
Only included if the location has a type of POLYGON.

​
type
string

Specifies if the geo-fence boundary for this location has been defined as a circle or a polygon; can be POLYGON or CIRCULAR.

​
reference
string

A reference for this location.
Included in the response if a reference has been specified for this location.

​
phoneNumber
string

A phone number for this location.
Included in the response if a phone number has been specified for this location.

​
contact
string

A contact for this location.
Included in the response if a contact has been specified for this location.

​
email
string

An email address for this location.
Included in the response if an email address has been specified for this location.

​
notes
string

The notes for this location.
Included in the response if notes have been specified for this location.