BootView WebApi

<back to all web services

FindTowHoldRecords

The following routes are available for this service:
GET/towHoldRecordsFind all the Tow Hold Records that meet the search criteria
FindTowHoldRecords Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the Tow Hold Records.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
FirstNamequerystringNoThe first name of the motorist associated with the vehicle for this Tow Hold Record.
LastNamequerystringNoThe last name of the motorist associated with the vehicle for this Tow Hold Record.
TowedFromqueryDateTimeNoThe earliest tow date.
TowedToqueryDateTimeNoThe most recent tow date.
StatusIdqueryintNoThe Tow Hold Record status id.
StickerIdquerystringNoThe sticker Id.
SortFieldquerystringNoThe sort field.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return.
HistoricalStatusIdqueryintNoHistorical status Id.
HistoricalFromqueryDateTimeNoThe earliest historical date of tow installation.
HistoricalToqueryDateTimeNoThe most recent historical tow installation date.
TowHoldRecordSearchResult Parameters:
NameParameterData TypeRequiredDescription
PageIndexformintNo
PageSizeformintNo
TotalItemsformintNo
ResultsformList<TowHoldRecordSearchResultItem>No
TowHoldRecordSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
StickerIdformstringNo
CustomerCodeformstringNo
LicenseTagformstringNo
LicenseStateformstringNo
CarMakeModelformstringNo
CarColorformstringNo
FirstNameformstringNo
LastNameformstringNo
PhonenumberformstringNo
TowedOnformDateTimeNo
CollectionAttemptIdformGuidNo
VehicleIdformGuidNo
NetDueformdecimalNo

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 /towHoldRecords HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"pageIndex":0,"pageSize":0,"totalItems":0,"results":[{"stickerId":"String","customerCode":"String","licenseTag":"String","licenseState":"String","carMakeModel":"String","carColor":"String","firstName":"String","lastName":"String","phonenumber":"String","towedOn":"\/Date(-62135596800000-0000)\/","collectionAttemptId":"00000000000000000000000000000000","vehicleId":"00000000000000000000000000000000","netDue":0}]}