PUT | /customers/{customerId}/returnlocations/{id} | Updates an existing return location. Fails if the return location doesn't exist. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer Id. |
Id | path | Guid | Yes | The return location Id. |
Name | body | string | Yes | The label or name of the return location. |
Address | body | string | No | The complete address of the return location. |
PhoneNumber | body | string | No | The phone number of the return location. |
PhoneNumber2 | body | string | No | The alternate phone number of the return location. |
ContactName | body | string | No | The contact name of the return location. |
IsDeleted | body | bool | Yes | Whether the return location is deleted. Default is false when not supplied. |
IsMappable | body | bool | Yes | Whether the new return location is mappable. |
MapStreet | body | string | No | The Map Street Address of the new return location. |
MapCity | body | string | No | The Map City of the new return location. |
MapState | body | string | No | The Map State of the new return location. |
MapRegion | body | int | No | The Map Region of the new return location. |
MapPostalCode | body | string | No | The Map Postal Code of the new return location. |
CrossStreet | body | string | No | The location Cross Street description |
Latitude | body | decimal | No | Latitude |
Longitude | body | decimal | No | Longitude |
AdditionalInformation | body | string | No | Additional information to be shown by MyBootInfo |
IsDefault | body | bool | Yes | Whether the new return location is the default. |
IsMotoristReturnLocation | body | bool | No | Whether the new return location is accessible to motorists |
ReturnLocationTimings | body | List<CustomerReturnLocationTiming> | No | An array of objects representing the operating hours of the returnLocation. |
Capacity | body | int | No | The maximum number of boots that can be stored at this location. |
Threshold | body | int | No | The threshold of the location to be used for alerts and reports |
BootCount | body | int | No | How many boots are currently at this location. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReturnLocationId | form | Guid | No | |
DayCode | form | int | No | |
From | form | string | No | |
To | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /customers/{customerId}/returnlocations/{id} HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerReturnLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<AdditionalInformation>String</AdditionalInformation>
<Address>String</Address>
<BootCount>0</BootCount>
<Capacity>0</Capacity>
<ContactName>String</ContactName>
<CrossStreet>String</CrossStreet>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<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>
<Threshold>0</Threshold>
</UpdateCustomerReturnLocation>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>