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 .xml suffix or ?format=xml

HTTP + XML

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

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

<FindCustomerReturnLocations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <NameContains>String</NameContains>
</FindCustomerReturnLocations>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomerReturnLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerReturnLocation>
    <AdditionalInformation>String</AdditionalInformation>
    <Address>String</Address>
    <BootCount>0</BootCount>
    <Capacity>0</Capacity>
    <ContactName>String</ContactName>
    <CrossStreet>String</CrossStreet>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <IsDefault>false</IsDefault>
    <IsDeleted>false</IsDeleted>
    <IsMappable>false</IsMappable>
    <IsMotoristReturnLocation>false</IsMotoristReturnLocation>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <MapCity>String</MapCity>
    <MapPostalCode>String</MapPostalCode>
    <MapRegion>0</MapRegion>
    <MapState>String</MapState>
    <MapStreet>String</MapStreet>
    <Name>String</Name>
    <PhoneNumber>String</PhoneNumber>
    <PhoneNumber2>String</PhoneNumber2>
    <ReturnLocationTimings>
      <CustomerReturnLocationTiming>
        <DayCode>0</DayCode>
        <From>String</From>
        <ReturnLocationId>00000000-0000-0000-0000-000000000000</ReturnLocationId>
        <To>String</To>
      </CustomerReturnLocationTiming>
    </ReturnLocationTimings>
  </CustomerReturnLocation>
</ArrayOfCustomerReturnLocation>