| GET | /noticerecords | Find all the notice records that meet the search criteria |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | query | Guid | No | The customer Id for which we want the notice records. |
| Followup | query | bool | No | Whether the record is flagged for followup. |
| PaymentPlan | query | bool | No | Whether there is a payment plan for this notice record. |
| 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. |
| StickerId | query | string | No | The sticker Id. |
| ParkingAreaId | query | Guid | No | The parking area Id for which we want the notice records. |
| OfficerId | query | Guid | No | The officer Id. |
| FirstName | query | string | No | The first name of the motorist associated with the vehicle for this notice record. |
| LastName | query | string | No | The last name of the motorist associated with the vehicle for this notice record. |
| Location | query | string | No | The location. |
| NoticedFrom | query | DateTime | No | The earliest date of notice. |
| NoticedTo | query | DateTime | No | The most recent notice date. |
| NoticeTypeId | query | string | No | The Notice Type Id. |
| NoticeProgramId | query | string | No | The Notice Program Id. |
| PageIndex | query | int | No | The page index. |
| PageSize | query | int | No | Number of results to return. |
| SortField | query | string | No | The sort field. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageIndex | form | int | No | |
| PageSize | form | int | No | |
| TotalItems | form | int | No | |
| Results | form | List<NoticeRecordSearchResultItem> | 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 | |
| Location | form | string | No | |
| Phonenumber | form | string | No | |
| NoticedOn | form | DateTime | No | |
| NetDue | form | decimal | No | |
| CollectionAttemptId | form | Guid | No | |
| VehicleId | form | Guid | No |
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 /noticerecords HTTP/1.1 Host: api.paylock.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":"\/Date(-62135596800000-0000)\/","netDue":0,"collectionAttemptId":"00000000-0000-0000-0000-000000000000","vehicleId":"00000000-0000-0000-0000-000000000000"}]}