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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	bootNumber: String,
	bootReturnLocation: 00000000000000000000000000000000,
	email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	message: String
}