| GET | /customers/{id}/returnlocations | Gets a list of the given customer's return locations. Only returns the list if this user has access to this customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | Guid | Yes | The customer id |
| NameContains | query | string | No | Use this to search by a fragment of the Location name. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{id}/returnlocations HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
id: 00000000000000000000000000000000,
name: String,
address: String,
phoneNumber: String,
phoneNumber2: String,
contactName: String,
isDeleted: False,
mapStreet: String,
mapCity: String,
mapState: String,
mapRegion: 0,
mapPostalCode: String,
crossStreet: String,
latitude: 0,
longitude: 0,
isMappable: False,
isDefault: False,
additionalInformation: String,
returnLocationTimings:
[
{
returnLocationId: 00000000000000000000000000000000,
dayCode: 0,
from: String,
to: String
}
],
isMotoristReturnLocation: False,
capacity: 0,
threshold: 0,
bootCount: 0
}
]