TestRouteGeofence
SOAP 1.1
Version
Version 1.1, Basic, Standard, Enterprise
Method Signature
GeoFenceTestedLocation[] TestRouteGeofence(Credentials c, Location[] TestLocations, SimpleTrip Trip, Decimal MilesOOR)
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Example Code
POST /Webservices/v1/PRIMEEnterpriseV1.asmx HTTP/1.1
Host: prime.promiles.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://promiles.com/TestRouteGeofence"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestRouteGeofence xmlns="http://promiles.com/">
<c>
<Username>string</Username>
<Password>string</Password>
<CompanyCode>string</CompanyCode>
</c>
<TestLocations>
<Location>
<ProMilesLocationID>int</ProMilesLocationID>
<Address>string</Address>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<LocationText>string</LocationText>
<Label>string</Label>
<Type>PROMILES or TRUCKSTOPS or REST_AREAS or WEIGH_SCALES</Type>
<LocationProperties>
<LocationProperty xsi:nil="true" />
<LocationProperty xsi:nil="true" />
</LocationProperties>
</Location>
<Location>
<ProMilesLocationID>int</ProMilesLocationID>
<Address>string</Address>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<LocationText>string</LocationText>
<Label>string</Label>
<Type>PROMILES or TRUCKSTOPS or REST_AREAS or WEIGH_SCALES</Type>
<LocationProperties>
<LocationProperty xsi:nil="true" />
<LocationProperty xsi:nil="true" />
</LocationProperties>
</Location>
</TestLocations>
<Trip>
<RoutingMethod>PRACTICAL or SHORTEST or INTERSTATE or NATIONAL_NETWORK</RoutingMethod>
<BorderOpen>boolean</BorderOpen>
<AvoidTollRoads>boolean</AvoidTollRoads>
<TripMiles>decimal</TripMiles>
<TripMinutes>int</TripMinutes>
<DrivingDirections>
<DirectionRow>
<Maneuver>string</Maneuver>
<DistanceAtStart>decimal</DistanceAtStart>
<LegDistance>decimal</LegDistance>
<LegIndex>int</LegIndex>
<Time>int</Time>
<Road>string</Road>
<IsToll>boolean</IsToll>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<TollCharge>decimal</TollCharge>
</DirectionRow>
<DirectionRow>
<Maneuver>string</Maneuver>
<DistanceAtStart>decimal</DistanceAtStart>
<LegDistance>decimal</LegDistance>
<LegIndex>int</LegIndex>
<Time>int</Time>
<Road>string</Road>
<IsToll>boolean</IsToll>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<TollCharge>decimal</TollCharge>
</DirectionRow>
</DrivingDirections>
<StateMileage>
<StateBreakoutRow>
<State>string</State>
<TotalMiles>decimal</TotalMiles>
<TollMiles>decimal</TollMiles>
<NonTollMiles>decimal</NonTollMiles>
</StateBreakoutRow>
<StateBreakoutRow>
<State>string</State>
<TotalMiles>decimal</TotalMiles>
<TollMiles>decimal</TollMiles>
<NonTollMiles>decimal</NonTollMiles>
</StateBreakoutRow>
</StateMileage>
<MapPoints>
<MapPoint>
<Lat>decimal</Lat>
<Lon>decimal</Lon>
</MapPoint>
<MapPoint>
<Lat>decimal</Lat>
<Lon>decimal</Lon>
</MapPoint>
</MapPoints>
<VehicleType>Truck2Axle or Truck3Axle or Tractor2AxleBobtail or Tractor3AxleBobtail or Tractor2AxleTrailer1Axle or Tractor2AxleTrailer2Axle or Tractor3AxleTrailer1Axle or Tractor3AxleTrailer2Axle or Tractor3AxleTrailerSplit2Axle or Tractor3AxleTrailer3Axle or Tractor2AxleDouble or Tractor3AxleDouble or Tractor2Axle6Tires</VehicleType>
<AllowRelaxRestrictions>boolean</AllowRelaxRestrictions>
<HasRelaxedRestrictions>boolean</HasRelaxedRestrictions>
<TollCharges>decimal</TollCharges>
<TripCharges>decimal</TripCharges>
</Trip>
<MilesOOR>decimal</MilesOOR>
</TestRouteGeofence>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestRouteGeofenceResponse xmlns="http://promiles.com/">
<TestRouteGeofenceResult>
<GeoFenceTestedLocation>
<IsInsideGeofence>boolean</IsInsideGeofence>
<DistanceFromGeofenceEdge>decimal</DistanceFromGeofenceEdge>
<TestedLocation>
<ProMilesLocationID>int</ProMilesLocationID>
<Address>string</Address>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<LocationText>string</LocationText>
<Label>string</Label>
<Type>PROMILES or TRUCKSTOPS or REST_AREAS or WEIGH_SCALES</Type>
<LocationProperties xsi:nil="true" />
</TestedLocation>
</GeoFenceTestedLocation>
<GeoFenceTestedLocation>
<IsInsideGeofence>boolean</IsInsideGeofence>
<DistanceFromGeofenceEdge>decimal</DistanceFromGeofenceEdge>
<TestedLocation>
<ProMilesLocationID>int</ProMilesLocationID>
<Address>string</Address>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
<Latitude>decimal</Latitude>
<Longitude>decimal</Longitude>
<LocationText>string</LocationText>
<Label>string</Label>
<Type>PROMILES or TRUCKSTOPS or REST_AREAS or WEIGH_SCALES</Type>
<LocationProperties xsi:nil="true" />
</TestedLocation>
</GeoFenceTestedLocation>
</TestRouteGeofenceResult>
</TestRouteGeofenceResponse>
</soap:Body>
</soap:Envelope>