BootView WebApi

<back to all web services

FindNoticeRecords

The following routes are available for this service:
GET/noticerecordsFind all the notice records that meet the search criteria
FindNoticeRecords Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the notice records.
FollowupqueryboolNoWhether the record is flagged for followup.
PaymentPlanqueryboolNoWhether there is a payment plan for this notice record.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
StickerIdquerystringNoThe sticker Id.
ParkingAreaIdqueryGuidNoThe parking area Id for which we want the notice records.
OfficerIdqueryGuidNoThe officer Id.
FirstNamequerystringNoThe first name of the motorist associated with the vehicle for this notice record.
LastNamequerystringNoThe last name of the motorist associated with the vehicle for this notice record.
LocationquerystringNoThe location.
NoticedFromqueryDateTimeNoThe earliest date of notice.
NoticedToqueryDateTimeNoThe most recent notice date.
NoticeTypeIdquerystringNoThe Notice Type Id.
NoticeProgramIdquerystringNoThe Notice Program Id.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return.
SortFieldquerystringNoThe sort field.
NoticeRecordSearchResult Parameters:
NameParameterData TypeRequiredDescription
PageIndexformintNo
PageSizeformintNo
TotalItemsformintNo
ResultsformList<NoticeRecordSearchResultItem>No
NoticeRecordSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
StickerIdformstringNo
CustomerCodeformstringNo
LicenseTagformstringNo
LicenseStateformstringNo
CarMakeModelformstringNo
CarColorformstringNo
FirstNameformstringNo
LastNameformstringNo
LocationformstringNo
PhonenumberformstringNo
NoticedOnformDateTimeNo
NetDueformdecimalNo
CollectionAttemptIdformGuidNo
VehicleIdformGuidNo

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.

POST /jsv/reply/FindNoticeRecords HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	followup: False,
	paymentPlan: False,
	licenseTag: String,
	licenseState: String,
	carMakeModel: String,
	carColor: String,
	stickerId: String,
	parkingAreaId: 00000000000000000000000000000000,
	officerId: 00000000000000000000000000000000,
	firstName: String,
	lastName: String,
	location: String,
	noticedFrom: 0001-01-01,
	noticedTo: 0001-01-01,
	noticeTypeId: String,
	noticeProgramId: String,
	pageIndex: 0,
	pageSize: 0,
	sortField: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
			noticedOn: 0001-01-01,
			netDue: 0,
			collectionAttemptId: 00000000000000000000000000000000,
			vehicleId: 00000000000000000000000000000000
		}
	]
}