RunTrip - SOAP 1.2 V1.1

RunTrip

SOAP 1.2

Version

Version 1.1, Basic, Standard, Enterprise

Method Signature

Trip RunTrip(Credentials c. Trip Trip)

The following is a sample SOAP 1.2 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: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RunTrip xmlns="http://promiles.com/">
      <c>
        <Username>string</Username>
        <Password>string</Password>
        <CompanyCode>string</CompanyCode>
      </c>
      <Trip>
        <Options>
          <Routing>
            <RoutingMethod>PRACTICAL or SHORTEST or INTERSTATE or NATIONAL_NETWORK</RoutingMethod>
            <SpeedOverrides xsi:nil="true" />
            <BorderOpen>boolean</BorderOpen>
            <DoRouteOptimization>boolean</DoRouteOptimization>
            <RouteOptimizationMethod>NO_OPTIMIZATION or DESTINATION_FIXED or RESEQUENCE_ALL</RouteOptimizationMethod>
            <IsHUBMode>boolean</IsHUBMode>
            <IsHazmat>boolean</IsHazmat>
            <AvoidTollRoads>boolean</AvoidTollRoads>
            <AllowRelaxRestrictions>boolean</AllowRelaxRestrictions>
          </Routing>
          <Itinerary>
            <MinutesAtOrigin>short</MinutesAtOrigin>
            <MinutesAtFuelStop>short</MinutesAtFuelStop>
            <MinutesAtDOTRest>short</MinutesAtDOTRest>
            <MinutesAtStop>short</MinutesAtStop>
            <MilesBetweenFuelStops>short</MilesBetweenFuelStops>
            <MinutesDrivingBetweenRests>short</MinutesDrivingBetweenRests>
            <ItineraryAnchorTime>dateTime</ItineraryAnchorTime>
            <AnchorTimeIsTripStart>boolean</AnchorTimeIsTripStart>
            <UseTeamMode>boolean</UseTeamMode>
            <MinutesUntilFirstDOTRest>short</MinutesUntilFirstDOTRest>
          </Itinerary>
          <FuelOptimization>
            <UnitMPG>decimal</UnitMPG>
            <UnitTankCapacity>short</UnitTankCapacity>
            <StartGallons>short</StartGallons>
            <DesiredEndGallons>short</DesiredEndGallons>
            <DistanceOOR>decimal</DistanceOOR>
            <MinimumGallonsToPurchase>short</MinimumGallonsToPurchase>
            <MinimumTankGallonsDesired>short</MinimumTankGallonsDesired>
            <Networks xsi:nil="true" />
            <UseAllStopsNetwork>boolean</UseAllStopsNetwork>
          </FuelOptimization>
        </Options>
        <FuelPurchases>
          <FuelPurchase>
            <PurchaseState>string</PurchaseState>
            <AmountPurchased>decimal</AmountPurchased>
            <IsLiters>boolean</IsLiters>
            <Station>string</Station>
            <City>string</City>
            <Invoice>string</Invoice>
            <FuelCost>decimal</FuelCost>
            <TypeOfFuel>DIESEL or BIO_DIESEL or GASOLINE</TypeOfFuel>
          </FuelPurchase>
          <FuelPurchase>
            <PurchaseState>string</PurchaseState>
            <AmountPurchased>decimal</AmountPurchased>
            <IsLiters>boolean</IsLiters>
            <Station>string</Station>
            <City>string</City>
            <Invoice>string</Invoice>
            <FuelCost>decimal</FuelCost>
            <TypeOfFuel>DIESEL or BIO_DIESEL or GASOLINE</TypeOfFuel>
          </FuelPurchase>
        </FuelPurchases>
        <VehicleAndLoadDescription>
          <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>
          <UseDefaultsForVehicleType>boolean</UseDefaultsForVehicleType>
          <LoadIsHazmat>boolean</LoadIsHazmat>
          <LoadIsHouseholdGoods>boolean</LoadIsHouseholdGoods>
          <LoadIsSandAndGravel>boolean</LoadIsSandAndGravel>
          <Height>decimal</Height>
          <TrailerLength>decimal</TrailerLength>
          <CompleteLength>decimal</CompleteLength>
          <GrossWeight>int</GrossWeight>
          <Width>decimal</Width>
          <NumberOfAxles>short</NumberOfAxles>
          <AxleWeight>int</AxleWeight>
          <EmptyWeight>int</EmptyWeight>
          <ExtremeAxleLength>decimal</ExtremeAxleLength>
          <HasKingpinLength>boolean</HasKingpinLength>
          <KingpinLengthToCenterTandem>decimal</KingpinLengthToCenterTandem>
          <KingpinLengthToEndTrailer>decimal</KingpinLengthToEndTrailer>
          <KingpinLengthToLastAxle>decimal</KingpinLengthToLastAxle>
          <TandemWeight>int</TandemWeight>
          <TridemWeight>int</TridemWeight>
        </VehicleAndLoadDescription>
        <GetDrivingDirections>boolean</GetDrivingDirections>
        <GetStateBreakout>boolean</GetStateBreakout>
        <GetFuelOptimization>boolean</GetFuelOptimization>
        <GetTripSummary>boolean</GetTripSummary>
        <GetItinerary>boolean</GetItinerary>
        <GetTruckStopsOnRoute>boolean</GetTruckStopsOnRoute>
        <GetTaxSummary>boolean</GetTaxSummary>
        <Results>
          <TripMiles>decimal</TripMiles>
          <TripMinutes>short</TripMinutes>
          <TollCharges>decimal</TollCharges>
          <TripCharges>decimal</TripCharges>
          <TripTaxes>decimal</TripTaxes>
          <AverageCostPerGallon>decimal</AverageCostPerGallon>
          <DrivingDirections>
            <DirectionRow xsi:nil="true" />
            <DirectionRow xsi:nil="true" />
          </DrivingDirections>
          <StateMileage>
            <StateBreakoutRow xsi:nil="true" />
            <StateBreakoutRow xsi:nil="true" />
          </StateMileage>
          <FuelOptimization>
            <UnitTankCapacity>decimal</UnitTankCapacity>
            <TripStartFuel>decimal</TripStartFuel>
            <UnitID>string</UnitID>
            <UnitMPG>decimal</UnitMPG>
            <IsOptimized>boolean</IsOptimized>
            <NetworkResults xsi:nil="true" />
          </FuelOptimization>
          <TripSummary>
            <TripSummaryRow xsi:nil="true" />
            <TripSummaryRow xsi:nil="true" />
          </TripSummary>
          <Itinerary>
            <ItineraryRow xsi:nil="true" />
            <ItineraryRow xsi:nil="true" />
          </Itinerary>
          <TruckStopsOnRoute>
            <TruckStop xsi:nil="true" />
            <TruckStop xsi:nil="true" />
          </TruckStopsOnRoute>
          <MapPoints>
            <MapPoint xsi:nil="true" />
            <MapPoint xsi:nil="true" />
          </MapPoints>
          <TaxSummary>
            <TotalMiles>decimal</TotalMiles>
            <MPG>decimal</MPG>
            <TotalTaxDue>decimal</TotalTaxDue>
            <GallonsBurned>decimal</GallonsBurned>
            <TotalIFTATax>decimal</TotalIFTATax>
            <TotalMileTax>decimal</TotalMileTax>
            <TotalTaxableMiles>decimal</TotalTaxableMiles>
            <TotalIFTASurcharge>decimal</TotalIFTASurcharge>
            <StateTaxSummary xsi:nil="true" />
          </TaxSummary>
          <HasRelaxedRestrictions>boolean</HasRelaxedRestrictions>
        </Results>
      </Trip>
    </RunTrip>
  </soap12:Body>
</soap12:Envelope>


HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RunTripResponse xmlns="http://promiles.com/">
      <RunTripResult>
        <Options>
          <Routing>
            <RoutingMethod>PRACTICAL or SHORTEST or INTERSTATE or NATIONAL_NETWORK</RoutingMethod>
            <SpeedOverrides xsi:nil="true" />
            <BorderOpen>boolean</BorderOpen>
            <DoRouteOptimization>boolean</DoRouteOptimization>
            <RouteOptimizationMethod>NO_OPTIMIZATION or DESTINATION_FIXED or RESEQUENCE_ALL</RouteOptimizationMethod>
            <IsHUBMode>boolean</IsHUBMode>
            <IsHazmat>boolean</IsHazmat>
            <AvoidTollRoads>boolean</AvoidTollRoads>
            <AllowRelaxRestrictions>boolean</AllowRelaxRestrictions>
          </Routing>
          <Itinerary>
            <MinutesAtOrigin>short</MinutesAtOrigin>
            <MinutesAtFuelStop>short</MinutesAtFuelStop>
            <MinutesAtDOTRest>short</MinutesAtDOTRest>
            <MinutesAtStop>short</MinutesAtStop>
            <MilesBetweenFuelStops>short</MilesBetweenFuelStops>
            <MinutesDrivingBetweenRests>short</MinutesDrivingBetweenRests>
            <ItineraryAnchorTime>dateTime</ItineraryAnchorTime>
            <AnchorTimeIsTripStart>boolean</AnchorTimeIsTripStart>
            <UseTeamMode>boolean</UseTeamMode>
            <MinutesUntilFirstDOTRest>short</MinutesUntilFirstDOTRest>
          </Itinerary>
          <FuelOptimization>
            <UnitMPG>decimal</UnitMPG>
            <UnitTankCapacity>short</UnitTankCapacity>
            <StartGallons>short</StartGallons>
            <DesiredEndGallons>short</DesiredEndGallons>
            <DistanceOOR>decimal</DistanceOOR>
            <MinimumGallonsToPurchase>short</MinimumGallonsToPurchase>
            <MinimumTankGallonsDesired>short</MinimumTankGallonsDesired>
            <Networks xsi:nil="true" />
            <UseAllStopsNetwork>boolean</UseAllStopsNetwork>
          </FuelOptimization>
        </Options>
        <FuelPurchases>
          <FuelPurchase>
            <PurchaseState>string</PurchaseState>
            <AmountPurchased>decimal</AmountPurchased>
            <IsLiters>boolean</IsLiters>
            <Station>string</Station>
            <City>string</City>
            <Invoice>string</Invoice>
            <FuelCost>decimal</FuelCost>
            <TypeOfFuel>DIESEL or BIO_DIESEL or GASOLINE</TypeOfFuel>
          </FuelPurchase>
          <FuelPurchase>
            <PurchaseState>string</PurchaseState>
            <AmountPurchased>decimal</AmountPurchased>
            <IsLiters>boolean</IsLiters>
            <Station>string</Station>
            <City>string</City>
            <Invoice>string</Invoice>
            <FuelCost>decimal</FuelCost>
            <TypeOfFuel>DIESEL or BIO_DIESEL or GASOLINE</TypeOfFuel>
          </FuelPurchase>
        </FuelPurchases>
        <VehicleAndLoadDescription>
          <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>
          <UseDefaultsForVehicleType>boolean</UseDefaultsForVehicleType>
          <LoadIsHazmat>boolean</LoadIsHazmat>
          <LoadIsHouseholdGoods>boolean</LoadIsHouseholdGoods>
          <LoadIsSandAndGravel>boolean</LoadIsSandAndGravel>
          <Height>decimal</Height>
          <TrailerLength>decimal</TrailerLength>
          <CompleteLength>decimal</CompleteLength>
          <GrossWeight>int</GrossWeight>
          <Width>decimal</Width>
          <NumberOfAxles>short</NumberOfAxles>
          <AxleWeight>int</AxleWeight>
          <EmptyWeight>int</EmptyWeight>
          <ExtremeAxleLength>decimal</ExtremeAxleLength>
          <HasKingpinLength>boolean</HasKingpinLength>
          <KingpinLengthToCenterTandem>decimal</KingpinLengthToCenterTandem>
          <KingpinLengthToEndTrailer>decimal</KingpinLengthToEndTrailer>
          <KingpinLengthToLastAxle>decimal</KingpinLengthToLastAxle>
          <TandemWeight>int</TandemWeight>
          <TridemWeight>int</TridemWeight>
        </VehicleAndLoadDescription>
        <GetDrivingDirections>boolean</GetDrivingDirections>
        <GetStateBreakout>boolean</GetStateBreakout>
        <GetFuelOptimization>boolean</GetFuelOptimization>
        <GetTripSummary>boolean</GetTripSummary>
        <GetItinerary>boolean</GetItinerary>
        <GetTruckStopsOnRoute>boolean</GetTruckStopsOnRoute>
        <GetTaxSummary>boolean</GetTaxSummary>
        <Results>
          <TripMiles>decimal</TripMiles>
          <TripMinutes>short</TripMinutes>
          <TollCharges>decimal</TollCharges>
          <TripCharges>decimal</TripCharges>
          <TripTaxes>decimal</TripTaxes>
          <AverageCostPerGallon>decimal</AverageCostPerGallon>
          <DrivingDirections>
            <DirectionRow xsi:nil="true" />
            <DirectionRow xsi:nil="true" />
          </DrivingDirections>
          <StateMileage>
            <StateBreakoutRow xsi:nil="true" />
            <StateBreakoutRow xsi:nil="true" />
          </StateMileage>
          <FuelOptimization>
            <UnitTankCapacity>decimal</UnitTankCapacity>
            <TripStartFuel>decimal</TripStartFuel>
            <UnitID>string</UnitID>
            <UnitMPG>decimal</UnitMPG>
            <IsOptimized>boolean</IsOptimized>
            <NetworkResults xsi:nil="true" />
          </FuelOptimization>
          <TripSummary>
            <TripSummaryRow xsi:nil="true" />
            <TripSummaryRow xsi:nil="true" />
          </TripSummary>
          <Itinerary>
            <ItineraryRow xsi:nil="true" />
            <ItineraryRow xsi:nil="true" />
          </Itinerary>
          <TruckStopsOnRoute>
            <TruckStop xsi:nil="true" />
            <TruckStop xsi:nil="true" />
          </TruckStopsOnRoute>
          <MapPoints>
            <MapPoint xsi:nil="true" />
            <MapPoint xsi:nil="true" />
          </MapPoints>
          <TaxSummary>
            <TotalMiles>decimal</TotalMiles>
            <MPG>decimal</MPG>
            <TotalTaxDue>decimal</TotalTaxDue>
            <GallonsBurned>decimal</GallonsBurned>
            <TotalIFTATax>decimal</TotalIFTATax>
            <TotalMileTax>decimal</TotalMileTax>
            <TotalTaxableMiles>decimal</TotalTaxableMiles>
            <TotalIFTASurcharge>decimal</TotalIFTASurcharge>
            <StateTaxSummary xsi:nil="true" />
          </TaxSummary>
          <HasRelaxedRestrictions>boolean</HasRelaxedRestrictions>
        </Results>
      </RunTripResult>
    </RunTripResponse>
  </soap12:Body>
</soap12:Envelope>

Related

TripResultsTrip