GET | /towHoldRecords | Find all the Tow Hold 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 Hold Records. |
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. |
FirstName | query | string | No | The first name of the motorist associated with the vehicle for this Tow Hold Record. |
LastName | query | string | No | The last name of the motorist associated with the vehicle for this Tow Hold Record. |
TowedFrom | query | DateTime | No | The earliest tow date. |
TowedTo | query | DateTime | No | The most recent tow date. |
StatusId | query | int | No | The Tow Hold 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<TowHoldRecordSearchResultItem> | 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 | |
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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <TowHoldRecordSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <PageIndex>0</PageIndex> <PageSize>0</PageSize> <Results> <TowHoldRecordSearchResultItem> <CarColor>String</CarColor> <CarMakeModel>String</CarMakeModel> <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId> <CustomerCode>String</CustomerCode> <FirstName>String</FirstName> <LastName>String</LastName> <LicenseState>String</LicenseState> <LicenseTag>String</LicenseTag> <NetDue>0</NetDue> <Phonenumber>String</Phonenumber> <StickerId>String</StickerId> <TowedOn>0001-01-01T00:00:00</TowedOn> <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId> </TowHoldRecordSearchResultItem> </Results> <TotalItems>0</TotalItems> </TowHoldRecordSearchResult>