SimpleTrip

PRIME SOAP API Documentation

Description

Version

Version 4.2

Parameter Type Notes
TripID string
TripLegs List<TripLeg> 20 trip legs maximum
ResponseStatus ResponseType
TripStartDate DateTime
TripEndDate DateTime
UnitID String
UnitMPG Decimal
TrailerID String
Driver String
GetMapPoints bool Indicates whether or not to return the MapPoints for use with JavaScript mapping.
StartOdometer Decimal Informational only. Does not affect routing.
EndOdometer Decimal Informational only. Does not affect routing.
Comments String Comments that you wish to keep with the trip object. You may wish to attach these to the trip after it has been processed.
ResponseMessage String
RoutingMethod RouteMethod
BorderOpen Boolean
AvoidTollRoads Boolean
TripMiles Decimal
TripMinutes Int32
DrivingDirections List<DirectionRow>
StateMileage List<StateBreakoutRow>
MapPoints List<MapPoint>
VehicleType VehicleType
AllowRelaxedRestrictions Boolean By default, if a trip cannot be routed due to a truck configuration clashing with road restrictions, the trip will simply fail to route. This often occurs when an addressed trip starts or ends on a street prohibited to trucks. If AllowRelaxRestrictions is set to true, the engine will override certain restrictions so that the trip can be routed. If this occurs, the HasRelaxedResults flag will be set to true.
HasRelaxedRestrictions Boolean Marked as true if the router had to override restrictions to route the trip with the truck configuration sent in.
DoRouteOptimization Boolean
RouteOptimizationMethod RouteOptimizeType
TollCharges Decimal Charges accumulated for traveling over toll roads
TripCharges Decimal Charges accumulated as a result of setting the PerMileRate or FlatRate parameters in the TripLeg object

Notes

None

Related

TripLeg ResponseType RouteMethod DirectionRow StateBreakoutRow MapPoint VehicleType