BootView WebApi

<back to all web services

UpdateBootLocationFromPage

The following routes are available for this service:
POST/boots/returnUpdates a boot location returned through return a boot page
UpdateBootLocationFromPage Parameters:
NameParameterData TypeRequiredDescription
BootNumberbodystringYesThe Boot serial number.
BootReturnLocationbodyGuidYesThe location where the Boot is being moved to.
emailbodystringYesThe email for a return receipt
UpdateBootLocationFromPageResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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 /boots/return HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBootLocationFromPage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <BootNumber>String</BootNumber>
  <BootReturnLocation>00000000-0000-0000-0000-000000000000</BootReturnLocation>
  <email>String</email>
</UpdateBootLocationFromPage>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateBootLocationFromPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Message>String</Message>
  <Success>false</Success>
</UpdateBootLocationFromPageResponse>