BootView WebApi

<back to all web services

GetBootRecordsByTowStatus

The following routes are available for this service:
GET/bootrecordsbytowstatusGets boot records by tow status.
GetBootRecordsByTowStatus Parameters:
NameParameterData TypeRequiredDescription
CustomerIdsqueryList[]YesThe customer Id(s) for which we want the boot records.
TowStatusqueryBootRecordTowStatusNoThe tow status of the boot records.
TowedFromqueryDateTimeNoThe earliest date of tow eligibility to search.
TowedToqueryDateTimeNoThe most recent date of tow eligibility to search.
HoursUntilTowEligiblequeryintNoThe number of hours until eligible.
SortFieldquerystringNoThe sort field for the boot records.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return.
BootRecordByTowStatusSearchResult Parameters:
NameParameterData TypeRequiredDescription
PageIndexformintNo
PageSizeformintNo
TotalItemsformintNo
ResultsformList<BootRecordByTowStatusSearchResultItem>No
EligibleSoonResultsformList<BootRecordByEligibleSoonTowStatusSearchResultItem>No
BootRecordByTowStatusSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
MunicipalityCodeformstringNo
CollectionAttemptIdformGuidNo
StickerIdformstringNo
VehicleIdformGuidNo
FullTagformstringNo
FullMakeColorTagformstringNo
LocationformstringNo
ZoneformstringNo
BootIdformGuidNo
BootSerialNumberformstringNo
HoursSinceBootingformintNo
DaysHoursformstringNo
NetDueformdecimalNo
IsOverdueformboolNo
BootRecordIdformGuidNo
BootRecordStatusDateformDateTimeNo
BootInstalledOnformDateTimeNo
CustomerIdformGuidNo
QueuedForTowReasonformstringNo
TowCompanyNameformstringNo
BootRecordByEligibleSoonTowStatusSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
MunicipalityCodeformstringNo
CollectionAttemptIdformGuidNo
StickerIdformstringNo
VehicleIdformGuidNo
FullTagformstringNo
FullMakeColorTagformstringNo
TowEligibleDateformstringNo
AmountDueformdecimalNo
HoursBeforeEligibleformstringNo
PhoneNumberformstringNo
CallerNameformstringNo
ZoneformstringNo

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/GetBootRecordsByTowStatus HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"customerIds":["00000000000000000000000000000000"],"towStatus":"EligileForTow","towedFrom":"\/Date(-62135596800000-0000)\/","towedTo":"\/Date(-62135596800000-0000)\/","hoursUntilTowEligible":0,"sortField":"String","pageIndex":0,"pageSize":0}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"pageIndex":0,"pageSize":0,"totalItems":0,"results":[{"municipalityCode":"String","collectionAttemptId":"00000000000000000000000000000000","stickerId":"String","vehicleId":"00000000000000000000000000000000","fullTag":"String","fullMakeColorTag":"String","location":"String","zone":"String","bootId":"00000000000000000000000000000000","bootSerialNumber":"String","hoursSinceBooting":0,"daysHours":"String","netDue":0,"isOverdue":false,"bootRecordId":"00000000000000000000000000000000","bootRecordStatusDate":"\/Date(-62135596800000-0000)\/","bootInstalledOn":"\/Date(-62135596800000-0000)\/","customerId":"00000000000000000000000000000000","queuedForTowReason":"String","towCompanyName":"String"}],"eligibleSoonResults":[{"municipalityCode":"String","collectionAttemptId":"00000000000000000000000000000000","stickerId":"String","vehicleId":"00000000000000000000000000000000","fullTag":"String","fullMakeColorTag":"String","towEligibleDate":"String","amountDue":0,"hoursBeforeEligible":"String","phoneNumber":"String","callerName":"String","zone":"String"}]}