BootView WebApi

<back to all web services

FindCustomerReturnLocations

The following routes are available for this service:
GET/customers/{id}/returnlocationsGets a list of the given customer's return locations. Only returns the list if this user has access to this customer.
FindCustomerReturnLocations Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe customer id
NameContainsquerystringNoUse 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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /x-msgpack/reply/FindCustomerReturnLocations HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"id":"00000000000000000000000000000000","nameContains":"String"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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}]