BootView WebApi

<back to all web services

GetBootRecordStatuses

The following routes are available for this service:
GET/bootrecords/statusesGets boot record statuses.
BootRecordStatusType Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

GET /bootrecords/statuses HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","name":"String"}
d>YesWhether the new return location is mappable.MapStreetbodystringNoThe Map Street Address of the new return location.MapCitybodystringNoThe Map City of the new return location.MapStatebodystringNoThe Map State of the new return location.MapRegionbodyintNoThe Map Region of the new return location.MapPostalCodebodystringNoThe Map Postal Code of the new return location.CrossStreetbodystringNoThe location Cross Street descriptionLatitudebodydecimalNoLatitudeLongitudebodydecimalNoLongitudeIsDefaultbodyboolYesWhether the new return location is the default.IsMotoristReturnLocationbodyboolNoWhether the new return location is accessible to motoristsAdditionalInformationbodystringNoAdditional information to be shown by MyBootInfoReturnLocationTimingsbodyList<CustomerReturnLocationTiming>NoAn array of objects representing the operating hours of the returnLocation.CapacitybodyintNoThe maximum number of boots that can be stored at this location.ThresholdbodyintNoThe threshold of the location to be used for alerts and reports.BootCountbodyintNoHow many boots are currently at this location.
CustomerReturnLocationTiming Parameters:
NameParameterData TypeRequiredDescription
ReturnLocationIdformGuidNo
DayCodeformintNo
FromformstringNo
ToformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /customers/{customerId}/returnlocations HTTP/1.1 
Host: api.paylock.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"customerId":"00000000-0000-0000-0000-000000000000","name":"String","address":"String","phoneNumber":"String","phoneNumber2":"String","contactName":"String","isDeleted":false,"isMappable":false,"mapStreet":"String","mapCity":"String","mapState":"String","mapRegion":0,"mapPostalCode":"String","crossStreet":"String","latitude":0,"longitude":0,"isDefault":false,"isMotoristReturnLocation":false,"additionalInformation":"String","returnLocationTimings":[{"returnLocationId":"00000000000000000000000000000000","dayCode":0,"from":"String","to":"String"}],"capacity":0,"threshold":0,"bootCount":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

"00000000-0000-0000-0000-000000000000"