BootView WebApi

<back to all web services

GetCommonEligibility

The following routes are available for this service:
GET/commoneligibilityresult/getcommoneligibilityReturns whether or not the vehicle has been booted recently.
GetCommonEligibility Parameters:
NameParameterData TypeRequiredDescription
EligibilityTypequeryCommonEligibilityTypeYesThe eligibility type to check (Notice|Boot|Tow).
CustomerIdqueryGuidYesThe Customer Id.
LicenseTagquerystringYesThe license tag.
LicenseStatequerystringNoThe license state.
PlateTypequerystringNoThe plate type.
CommonEligibilityType Enum:
Unspecified
Notice
Boot
Tow
CommonEligibilityResult Parameters:
NameParameterData TypeRequiredDescription
PlateOfInterestformCommonEligiblePlateNo
BootRecordCountformintNo
IsTowableformboolNo
IsRunawayformboolNo
NetDueformdecimalNo
CustomerBootFeeformdecimalNo
CustomerOtherFeesformdecimalNo
TotalAmountDueformdecimalNo
BillsformList<CommonEligibleBill>No
ReasonsDisplayformstringNo
IsStolenformboolNo
IsReleasedWithoutPaymentformboolNo
IsBootedRecentlyformboolNo
IsBootEligibleformboolNo
IsNoticeEligibleformboolNo
BillsByPlateformDictionary<string, List<CommonEligibleBill>>No
CommonEligiblePlate Parameters:
NameParameterData TypeRequiredDescription
LicenseTagformstringNo
LicenseStateformstringNo
PlateTypeformstringNo
VINformstringNo
IdformGuidNo
MakeModelformstringNo
ColorformstringNo
RegisteredNameformstringNo
RegisteredAddressformDictionary<string, string>No
CommonEligibleBill Parameters:
NameParameterData TypeRequiredDescription
BillIdformGuidNo
ReferenceIdformstringNo
CustomerAccountNumberformstringNo
OriginalAmountDueformdecimalNo
NetDueformdecimalNo
PlateformCommonEligiblePlateNo
BillTypeformBillCategoryNo
BillTypeDisplayformstringNo
DateDueformDateTimeNo
EligibilityIsApplicableformboolNo
IsNoticeEligibleformboolNo
IsBootEligibleformboolNo
IsTowEligibleformboolNo
BillCategory Enum:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
			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: 0001-01-01,
				eligibilityIsApplicable: False,
				isNoticeEligible: False,
				isBootEligible: False,
				isTowEligible: False
			}
		]
	}
}