| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NoticeRecordSearchResult 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>
<NoticeRecordSearchResultItem>
<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>
<Location>String</Location>
<NetDue>0</NetDue>
<NoticedOn>0001-01-01T00:00:00</NoticedOn>
<Phonenumber>String</Phonenumber>
<StickerId>String</StickerId>
<VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
</NoticeRecordSearchResultItem>
</Results>
<TotalItems>0</TotalItems>
</NoticeRecordSearchResult>