GET | /towrecords | Find all the tow records that meet the search criteria |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | query | Guid | No | The customer Id for which we want the tow records. |
Followup | query | bool | No | Whether the record is flagged for followup. |
LicenseTag | query | string | No | The license tag. |
LicenseState | query | string | No | The license state. |
CarMakeModel | query | string | No | The car make and model. |
CarColor | query | string | No | The car color. |
ParkingAreaId | query | Guid | No | The parking area Id for which we want the tow records. |
OfficerId | query | Guid | No | The officer Id. |
TowCompanyId | query | Guid | No | The tow company Id. |
FirstName | query | string | No | The first name of the motorist associated with the vehicle for this tow record. |
LastName | query | string | No | The last name of the motorist associated with the vehicle for this tow record. |
Location | query | string | No | The location. |
TowedFrom | query | DateTime | No | The earliest tow date. |
TowedTo | query | DateTime | No | The most recent tow date. |
StatusId | query | int | No | The tow record status id. |
StickerId | query | string | No | The sticker Id. |
SortField | query | string | No | The sort field. |
PageIndex | query | int | No | The page index. |
PageSize | query | int | No | Number of results to return. |
HistoricalStatusId | query | int | No | Historical status Id. |
HistoricalFrom | query | DateTime | No | The earliest historical date of tow installation. |
HistoricalTo | query | DateTime | No | The most recent historical tow installation date. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PageIndex | form | int | No | |
PageSize | form | int | No | |
TotalItems | form | int | No | |
Results | form | List<TowRecordSearchResultItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StickerId | form | string | No | |
CustomerCode | form | string | No | |
LicenseTag | form | string | No | |
LicenseState | form | string | No | |
CarMakeModel | form | string | No | |
CarColor | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Location | form | string | No | |
Phonenumber | form | string | No | |
TowedOn | form | DateTime | No | |
CollectionAttemptId | form | Guid | No | |
VehicleId | form | Guid | No | |
NetDue | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /towrecords 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","location":"String","phonenumber":"String","towedOn":"\/Date(-62135596800000-0000)\/","collectionAttemptId":"00000000-0000-0000-0000-000000000000","vehicleId":"00000000-0000-0000-0000-000000000000","netDue":0}]}