| GET | /commoneligibilityresult/getcommoneligibility | Returns whether or not the vehicle has been booted recently. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EligibilityType | query | CommonEligibilityType | Yes | The eligibility type to check (Notice|Boot|Tow). |
| CustomerId | query | Guid | Yes | The Customer Id. |
| LicenseTag | query | string | Yes | The license tag. |
| LicenseState | query | string | No | The license state. |
| PlateType | query | string | No | The plate type. |
| Unspecified |
| Notice |
| Boot |
| Tow |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlateOfInterest | form | CommonEligiblePlate | No | |
| BootRecordCount | form | int | No | |
| IsTowable | form | bool | No | |
| IsRunaway | form | bool | No | |
| NetDue | form | decimal | No | |
| CustomerBootFee | form | decimal | No | |
| CustomerOtherFees | form | decimal | No | |
| TotalAmountDue | form | decimal | No | |
| Bills | form | List<CommonEligibleBill> | No | |
| ReasonsDisplay | form | string | No | |
| IsStolen | form | bool | No | |
| IsReleasedWithoutPayment | form | bool | No | |
| IsBootedRecently | form | bool | No | |
| IsBootEligible | form | bool | No | |
| IsNoticeEligible | form | bool | No | |
| BillsByPlate | form | Dictionary<string, List<CommonEligibleBill>> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LicenseTag | form | string | No | |
| LicenseState | form | string | No | |
| PlateType | form | string | No | |
| VIN | form | string | No | |
| Id | form | Guid | No | |
| MakeModel | form | string | No | |
| Color | form | string | No | |
| RegisteredName | form | string | No | |
| RegisteredAddress | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BillId | form | Guid | No | |
| ReferenceId | form | string | No | |
| CustomerAccountNumber | form | string | No | |
| OriginalAmountDue | form | decimal | No | |
| NetDue | form | decimal | No | |
| Plate | form | CommonEligiblePlate | No | |
| BillType | form | BillCategory | No | |
| BillTypeDisplay | form | string | No | |
| DateDue | form | DateTime | No | |
| EligibilityIsApplicable | form | bool | No | |
| IsNoticeEligible | form | bool | No | |
| IsBootEligible | form | bool | No | |
| IsTowEligible | form | bool | No |
| None |
| PaylockFee |
| BootFee |
| ParkingFine |
| Tax |
| TowFee |
| ImpoundFee |
| LateBootFee |
| DamagedBootFee |
| LostBootFee |
| ReturnedCheckFee |
| NoticeFee |
| PropertyTax |
| RedLightTicket |
| ConvenienceFee |
| SecurityFee |
| AdministrativeFee |
| BootReleaseFee |
| Poundage |
| ExecutionFee |
| SalesTax |
| MarshalExpense |
| CityDecal |
| SpeedingFine |
| TowDispatchFee |
| Miscellaneous |
| Affiliated |
| TpvaCCFee |
| HandicappedParkingFine |
| PaylockPlanServiceFee |
| AdditionalFine |
| OverheadTruck |
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 /commoneligibilityresult/getcommoneligibility HTTP/1.1 Host: api.paylock.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"plateOfInterest":{"licenseTag":"String","licenseState":"String","plateType":"String","vin":"String","id":"00000000000000000000000000000000","makeModel":"String","color":"String","registeredName":"String","registeredAddress":{"String":"String"}},"bootRecordCount":0,"isTowable":false,"isRunaway":false,"netDue":0,"customerBootFee":0,"customerOtherFees":0,"totalAmountDue":0,"bills":[{"billId":"00000000000000000000000000000000","referenceId":"String","customerAccountNumber":"String","originalAmountDue":0,"netDue":0,"plate":{"licenseTag":"String","licenseState":"String","plateType":"String","vin":"String","id":"00000000000000000000000000000000","makeModel":"String","color":"String","registeredName":"String","registeredAddress":{"String":"String"}},"billType":"None","billTypeDisplay":"String","dateDue":"\/Date(-62135596800000-0000)\/","eligibilityIsApplicable":false,"isNoticeEligible":false,"isBootEligible":false,"isTowEligible":false}],"reasonsDisplay":"String","isStolen":false,"isReleasedWithoutPayment":false,"isBootedRecently":false,"isBootEligible":false,"isNoticeEligible":false,"billsByPlate":{"String":[{"billId":"00000000000000000000000000000000","referenceId":"String","customerAccountNumber":"String","originalAmountDue":0,"netDue":0,"plate":{"licenseTag":"String","licenseState":"String","plateType":"String","vin":"String","id":"00000000000000000000000000000000","makeModel":"String","color":"String","registeredName":"String","registeredAddress":{"String":"String"}},"billType":"None","billTypeDisplay":"String","dateDue":"\/Date(-62135596800000-0000)\/","eligibilityIsApplicable":false,"isNoticeEligible":false,"isBootEligible":false,"isTowEligible":false}]}}