BootView WebApi

<back to all web services

GetOptiRoutePoints

The following routes are available for this service:
GET/optiroutegets a list of optiroute points
GetOptiRoutePoints Parameters:
NameParameterData TypeRequiredDescription
PlatequerystringYesThe plate.
CustomerIdqueryGuidYesThe customer ID.
SourceTypesqueryIEnumerable<OptiRouteLPRSourceType>YesSource Types: LPR = 0
DateFromquerystringYesStart Date.
DateToquerystringYesEnd Date.
WeekDayquerystring []YesArray with week days
AmtDueRangesquerystring []YesArray with Range of amount due ['- 1', '101 - 300', '501 - 1000', '1001 - 999999999', '0 - 100', '301 - 500']
NumRunAwaysquerystring []YesArray with the number of runaways from 0 to 6
StatusqueryintYesThe plate status 0 = Inactive, 1 = Active, -1 = All.
OptiRouteLPRSourceType Enum:
LPR
GetEnforcementZoneResult Parameters:
NameParameterData TypeRequiredDescription
EnforcementZoneListformList<EnforcementZone>No
OptiRouteResultListformList<OptiRouteMapResultItem>No
EnforcementZone Parameters:
NameParameterData TypeRequiredDescription
EnforcementZoneIdformGuidNo
ZoneNameformstringNo
CoordinatesformstringNo
PointsformstringNo
CustomerIdformGuidNo
WeekDaysformstringNo
OptiRouteMapResultItem Parameters:
NameParameterData TypeRequiredDescription
HotlistSrcLocIfformlongNo
ClientCodeformstringNo
LicPlateformstringNo
LicStateformstringNo
MakeModelformstringNo
ColorformstringNo
AmtDueformdecimal?No
HitStatusformstringNo
HitActionformstringNo
SrcTypeformstringNo
TypeDateformDateTime?No
TypeDateDayformstringNo
SourceLLformint?No
SourceLLNameformstringNo
LatitudeformstringNo
LongitudeformstringNo
ParkingZoneformstringNo
SourceAddressformint?No
AddressNumformint?No
AddressformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
NumRunawaysSinceLastPaymentformint?No
CurrentStatusformstringNo
DataSourceformstringNo
FileDateformDateTime?No
LocImportSourceformint?No
LocImportSourceNameformstringNo
ImportDateformDateTime?No
LPRDataIDformGuid?No
PlateStatusformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>