| GET | /optiroute | gets a list of optiroute points |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Plate | query | string | Yes | The plate. |
| CustomerId | query | Guid | Yes | The customer ID. |
| SourceTypes | query | IEnumerable<OptiRouteLPRSourceType> | Yes | Source Types: LPR = 0 |
| DateFrom | query | string | Yes | Start Date. |
| DateTo | query | string | Yes | End Date. |
| WeekDay | query | string [] | Yes | Array with week days |
| AmtDueRanges | query | string [] | Yes | Array with Range of amount due ['- 1', '101 - 300', '501 - 1000', '1001 - 999999999', '0 - 100', '301 - 500'] |
| NumRunAways | query | string [] | Yes | Array with the number of runaways from 0 to 6 |
| Status | query | int | Yes | The plate status 0 = Inactive, 1 = Active, -1 = All. |
| LPR |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EnforcementZoneList | form | List<EnforcementZone> | No | |
| OptiRouteResultList | form | List<OptiRouteMapResultItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EnforcementZoneId | form | Guid | No | |
| ZoneName | form | string | No | |
| Coordinates | form | string | No | |
| Points | form | string | No | |
| CustomerId | form | Guid | No | |
| WeekDays | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HotlistSrcLocIf | form | long | No | |
| ClientCode | form | string | No | |
| LicPlate | form | string | No | |
| LicState | form | string | No | |
| MakeModel | form | string | No | |
| Color | form | string | No | |
| AmtDue | form | decimal? | No | |
| HitStatus | form | string | No | |
| HitAction | form | string | No | |
| SrcType | form | string | No | |
| TypeDate | form | DateTime? | No | |
| TypeDateDay | form | string | No | |
| SourceLL | form | int? | No | |
| SourceLLName | form | string | No | |
| Latitude | form | string | No | |
| Longitude | form | string | No | |
| ParkingZone | form | string | No | |
| SourceAddress | form | int? | No | |
| AddressNum | form | int? | No | |
| Address | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| NumRunawaysSinceLastPayment | form | int? | No | |
| CurrentStatus | form | string | No | |
| DataSource | form | string | No | |
| FileDate | form | DateTime? | No | |
| LocImportSource | form | int? | No | |
| LocImportSourceName | form | string | No | |
| ImportDate | form | DateTime? | No | |
| LPRDataID | form | Guid? | No | |
| PlateStatus | form | int? | 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 /optiroute HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetEnforcementZoneResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<EnforcementZoneList>
<EnforcementZone>
<Coordinates>String</Coordinates>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<EnforcementZoneId>00000000-0000-0000-0000-000000000000</EnforcementZoneId>
<Points>String</Points>
<WeekDays>String</WeekDays>
<ZoneName>String</ZoneName>
</EnforcementZone>
</EnforcementZoneList>
<OptiRouteResultList>
<OptiRouteMapResultItem>
<Address>String</Address>
<AddressNum>0</AddressNum>
<AmtDue>0</AmtDue>
<City>String</City>
<ClientCode>String</ClientCode>
<Color>String</Color>
<CurrentStatus>String</CurrentStatus>
<DataSource>String</DataSource>
<FileDate>0001-01-01T00:00:00</FileDate>
<HitAction>String</HitAction>
<HitStatus>String</HitStatus>
<HotlistSrcLocIf>0</HotlistSrcLocIf>
<ImportDate>0001-01-01T00:00:00</ImportDate>
<LPRDataID>00000000-0000-0000-0000-000000000000</LPRDataID>
<Latitude>String</Latitude>
<LicPlate>String</LicPlate>
<LicState>String</LicState>
<LocImportSource>0</LocImportSource>
<LocImportSourceName>String</LocImportSourceName>
<Longitude>String</Longitude>
<MakeModel>String</MakeModel>
<NumRunawaysSinceLastPayment>0</NumRunawaysSinceLastPayment>
<ParkingZone>String</ParkingZone>
<PlateStatus>0</PlateStatus>
<SourceAddress>0</SourceAddress>
<SourceLL>0</SourceLL>
<SourceLLName>String</SourceLLName>
<SrcType>String</SrcType>
<State>String</State>
<TypeDate>0001-01-01T00:00:00</TypeDate>
<TypeDateDay>String</TypeDateDay>
<Zip>String</Zip>
</OptiRouteMapResultItem>
</OptiRouteResultList>
</GetEnforcementZoneResult>