| GET | /bootrecordsbytowstatus | Gets boot records by tow status. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerIds | query | List[] | Yes | The customer Id(s) for which we want the boot records. |
| TowStatus | query | BootRecordTowStatus | No | The tow status of the boot records. |
| TowedFrom | query | DateTime | No | The earliest date of tow eligibility to search. |
| TowedTo | query | DateTime | No | The most recent date of tow eligibility to search. |
| HoursUntilTowEligible | query | int | No | The number of hours until eligible. |
| SortField | query | string | No | The sort field for the boot records. |
| PageIndex | query | int | No | The page index. |
| PageSize | query | int | No | Number of results to return. |
| Name | Value |
|---|---|
| EligileForTow | 1 |
| QueuedForTow | 2 |
| TowDispatched | 3 |
| EligibleSoon | 4 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageIndex | form | int | No | |
| PageSize | form | int | No | |
| TotalItems | form | int | No | |
| Results | form | List<BootRecordByTowStatusSearchResultItem> | No | |
| EligibleSoonResults | form | List<BootRecordByEligibleSoonTowStatusSearchResultItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MunicipalityCode | form | string | No | |
| CollectionAttemptId | form | Guid | No | |
| StickerId | form | string | No | |
| VehicleId | form | Guid | No | |
| FullTag | form | string | No | |
| FullMakeColorTag | form | string | No | |
| Location | form | string | No | |
| Zone | form | string | No | |
| BootId | form | Guid | No | |
| BootSerialNumber | form | string | No | |
| HoursSinceBooting | form | int | No | |
| DaysHours | form | string | No | |
| NetDue | form | decimal | No | |
| IsOverdue | form | bool | No | |
| BootRecordId | form | Guid | No | |
| BootRecordStatusDate | form | DateTime | No | |
| BootInstalledOn | form | DateTime | No | |
| CustomerId | form | Guid | No | |
| QueuedForTowReason | form | string | No | |
| TowCompanyName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MunicipalityCode | form | string | No | |
| CollectionAttemptId | form | Guid | No | |
| StickerId | form | string | No | |
| VehicleId | form | Guid | No | |
| FullTag | form | string | No | |
| FullMakeColorTag | form | string | No | |
| TowEligibleDate | form | string | No | |
| AmountDue | form | decimal | No | |
| HoursBeforeEligible | form | string | No | |
| PhoneNumber | form | string | No | |
| CallerName | form | string | No | |
| Zone | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /bootrecordsbytowstatus HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
bootInstalledOn: 0001-01-01,
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
}
]
}