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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"enforcementZoneList":[{"enforcementZoneId":"00000000000000000000000000000000","zoneName":"String","coordinates":"String","points":"String","customerId":"00000000000000000000000000000000","weekDays":"String"}],"optiRouteResultList":[{"hotlistSrcLocIf":0,"clientCode":"String","licPlate":"String","licState":"String","makeModel":"String","color":"String","amtDue":0,"hitStatus":"String","hitAction":"String","srcType":"String","typeDate":"\/Date(-62135596800000-0000)\/","typeDateDay":"String","sourceLL":0,"sourceLLName":"String","latitude":"String","longitude":"String","parkingZone":"String","sourceAddress":0,"addressNum":0,"address":"String","city":"String","state":"String","zip":"String","numRunawaysSinceLastPayment":0,"currentStatus":"String","dataSource":"String","fileDate":"\/Date(-62135596800000-0000)\/","locImportSource":0,"locImportSourceName":"String","importDate":"\/Date(-62135596800000-0000)\/","lprDataID":"00000000000000000000000000000000","plateStatus":0}]}