BootView WebApi

<back to all web services

CreateCustomerReturnLocation

The following routes are available for this service:
POST/customers/{customerId}/returnlocationsCreates a new return location entry for this Customer.
CreateCustomerReturnLocation Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer Id.
NamebodystringYesThe label or name of the return location.
AddressbodystringNoThe complete address of the return location.
PhoneNumberbodystringNoThe phone number of the return location.
PhoneNumber2bodystringNoThe alternate phone number of the return location.
ContactNamebodystringNoThe contact name of the return location.
IsDeletedbodyboolYesWhether the return location is deleted. Default is false when not supplied.
IsMappablebodyboolYesWhether 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 description
LatitudebodydecimalNoLatitude
LongitudebodydecimalNoLongitude
IsDefaultbodyboolYesWhether the new return location is the default.
IsMotoristReturnLocationbodyboolNoWhether the new return location is accessible to motorists
AdditionalInformationbodystringNoAdditional information to be shown by MyBootInfo
ReturnLocationTimingsbodyList<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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

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

POST /x-msgpack/reply/CreateCustomerReturnLocation HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"customerId":"00000000000000000000000000000000","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/x-msgpack
Content-Length: length

"00000000000000000000000000000000"