FSIService Web Service

FSIService

Click here for a complete list of operations.

GetFuelSurchargeFull

Get a full cost analysis for a route.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /FSIService.asmx HTTP/1.1
Host: www.fuelsurchargeindex.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.fuelsurchargeindex.com/GetFuelSurchargeFull"

<?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>
    <GetFuelSurchargeFull xmlns="http://www.fuelsurchargeindex.com/">
      <FSIRequest>
        <Username xmlns="http://ProMiles.FSIInternal">string</Username>
        <Password xmlns="http://ProMiles.FSIInternal">string</Password>
        <CompanyCode xmlns="http://ProMiles.FSIInternal">string</CompanyCode>
        <MPG xmlns="http://ProMiles.FSIInternal">decimal</MPG>
        <RequestedFuelDate xmlns="http://ProMiles.FSIInternal">dateTime</RequestedFuelDate>
        <Adder xmlns="http://ProMiles.FSIInternal">decimal</Adder>
        <FuelSurchargeTrigger xmlns="http://ProMiles.FSIInternal">decimal</FuelSurchargeTrigger>
        <FuelType xmlns="http://ProMiles.FSIInternal">string</FuelType>
        <RouteMethod xmlns="http://ProMiles.FSIInternal">string</RouteMethod>
        <TripLegCollection xmlns="http://ProMiles.FSIInternal">
          <TripLeg>
            <LocationText>string</LocationText>
          </TripLeg>
          <TripLeg>
            <LocationText>string</LocationText>
          </TripLeg>
        </TripLegCollection>
        <AddMileTaxToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddMileTaxToTotal>
        <AddIFTASurchargeToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddIFTASurchargeToTotal>
        <AddStateTaxToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddStateTaxToTotal>
        <UseMajorChainsOnly xmlns="http://ProMiles.FSIInternal">boolean</UseMajorChainsOnly>
        <UseNetwork xmlns="http://ProMiles.FSIInternal">boolean</UseNetwork>
        <ExcludeMexico xmlns="http://ProMiles.FSIInternal">boolean</ExcludeMexico>
        <Network xmlns="http://ProMiles.FSIInternal">
          <NetworkStop>
            <OpisID>int</OpisID>
            <FuelType>string</FuelType>
            <Adder>decimal</Adder>
          </NetworkStop>
          <NetworkStop>
            <OpisID>int</OpisID>
            <FuelType>string</FuelType>
            <Adder>decimal</Adder>
          </NetworkStop>
        </Network>
      </FSIRequest>
    </GetFuelSurchargeFull>
  </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>
    <GetFuelSurchargeFullResponse xmlns="http://www.fuelsurchargeindex.com/">
      <GetFuelSurchargeFullResult>
        <IsSuccess xmlns="http://ProMiles.FSIInternal">boolean</IsSuccess>
        <ErrorDescription xmlns="http://ProMiles.FSIInternal">string</ErrorDescription>
        <ReportGeneratedDate xmlns="http://ProMiles.FSIInternal">dateTime</ReportGeneratedDate>
        <FuelDate xmlns="http://ProMiles.FSIInternal">dateTime</FuelDate>
        <MPG xmlns="http://ProMiles.FSIInternal">decimal</MPG>
        <FuelSurchargeTrigger xmlns="http://ProMiles.FSIInternal">decimal</FuelSurchargeTrigger>
        <Adder xmlns="http://ProMiles.FSIInternal">decimal</Adder>
        <TripOrigin xmlns="http://ProMiles.FSIInternal">string</TripOrigin>
        <TripDestination xmlns="http://ProMiles.FSIInternal">string</TripDestination>
        <TripMiles xmlns="http://ProMiles.FSIInternal">decimal</TripMiles>
        <CostPerGallon xmlns="http://ProMiles.FSIInternal">decimal</CostPerGallon>
        <CostPerMile xmlns="http://ProMiles.FSIInternal">decimal</CostPerMile>
        <TotalFuelCost xmlns="http://ProMiles.FSIInternal">decimal</TotalFuelCost>
        <FuelType xmlns="http://ProMiles.FSIInternal">string</FuelType>
        <TotalGallonsConsumed xmlns="http://ProMiles.FSIInternal">decimal</TotalGallonsConsumed>
        <TotalFuelTax xmlns="http://ProMiles.FSIInternal">decimal</TotalFuelTax>
        <CostInExcessOfTrigger xmlns="http://ProMiles.FSIInternal">decimal</CostInExcessOfTrigger>
        <FSCRevenue xmlns="http://ProMiles.FSIInternal">decimal</FSCRevenue>
        <TotalFSCRevenue xmlns="http://ProMiles.FSIInternal">decimal</TotalFSCRevenue>
        <StateDataCollection xmlns="http://ProMiles.FSIInternal">
          <StateData>
            <StateAbbreviation>string</StateAbbreviation>
            <StateName>string</StateName>
            <TaxRate>decimal</TaxRate>
            <MilesInState>decimal</MilesInState>
            <TotalTax>decimal</TotalTax>
            <PercentOfTotalTrip>decimal</PercentOfTotalTrip>
            <GallonsConsumedInState>decimal</GallonsConsumedInState>
            <FuelCostExTax>decimal</FuelCostExTax>
            <FuelCost>decimal</FuelCost>
            <WeightedFuelCostExTax>decimal</WeightedFuelCostExTax>
            <WeightedFuelCost>decimal</WeightedFuelCost>
            <IFTASurchargeTotal>decimal</IFTASurchargeTotal>
            <IFTASurchargeRate>decimal</IFTASurchargeRate>
            <MileTaxRate>decimal</MileTaxRate>
            <MileTaxTotal>decimal</MileTaxTotal>
          </StateData>
          <StateData>
            <StateAbbreviation>string</StateAbbreviation>
            <StateName>string</StateName>
            <TaxRate>decimal</TaxRate>
            <MilesInState>decimal</MilesInState>
            <TotalTax>decimal</TotalTax>
            <PercentOfTotalTrip>decimal</PercentOfTotalTrip>
            <GallonsConsumedInState>decimal</GallonsConsumedInState>
            <FuelCostExTax>decimal</FuelCostExTax>
            <FuelCost>decimal</FuelCost>
            <WeightedFuelCostExTax>decimal</WeightedFuelCostExTax>
            <WeightedFuelCost>decimal</WeightedFuelCost>
            <IFTASurchargeTotal>decimal</IFTASurchargeTotal>
            <IFTASurchargeRate>decimal</IFTASurchargeRate>
            <MileTaxRate>decimal</MileTaxRate>
            <MileTaxTotal>decimal</MileTaxTotal>
          </StateData>
        </StateDataCollection>
        <TruckStopDataCollection xmlns="http://ProMiles.FSIInternal">
          <TruckStopData>
            <TruckStopName>string</TruckStopName>
            <OPISID>int</OPISID>
            <StateAbbreviation>string</StateAbbreviation>
            <StateFullName>string</StateFullName>
            <City>string</City>
            <Location>string</Location>
            <Phone>string</Phone>
            <Price>decimal</Price>
            <Adder>decimal</Adder>
            <FuelType>string</FuelType>
          </TruckStopData>
          <TruckStopData>
            <TruckStopName>string</TruckStopName>
            <OPISID>int</OPISID>
            <StateAbbreviation>string</StateAbbreviation>
            <StateFullName>string</StateFullName>
            <City>string</City>
            <Location>string</Location>
            <Phone>string</Phone>
            <Price>decimal</Price>
            <Adder>decimal</Adder>
            <FuelType>string</FuelType>
          </TruckStopData>
        </TruckStopDataCollection>
        <StateTaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</StateTaxPerGallon>
        <IFTATaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</IFTATaxPerGallon>
        <MileTaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</MileTaxPerGallon>
        <TotalMileTax xmlns="http://ProMiles.FSIInternal">decimal</TotalMileTax>
        <TotalIFTASurcharge xmlns="http://ProMiles.FSIInternal">decimal</TotalIFTASurcharge>
        <CostPerGallonExTax xmlns="http://ProMiles.FSIInternal">decimal</CostPerGallonExTax>
      </GetFuelSurchargeFullResult>
    </GetFuelSurchargeFullResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /FSIService.asmx HTTP/1.1
Host: www.fuelsurchargeindex.org
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>
    <GetFuelSurchargeFull xmlns="http://www.fuelsurchargeindex.com/">
      <FSIRequest>
        <Username xmlns="http://ProMiles.FSIInternal">string</Username>
        <Password xmlns="http://ProMiles.FSIInternal">string</Password>
        <CompanyCode xmlns="http://ProMiles.FSIInternal">string</CompanyCode>
        <MPG xmlns="http://ProMiles.FSIInternal">decimal</MPG>
        <RequestedFuelDate xmlns="http://ProMiles.FSIInternal">dateTime</RequestedFuelDate>
        <Adder xmlns="http://ProMiles.FSIInternal">decimal</Adder>
        <FuelSurchargeTrigger xmlns="http://ProMiles.FSIInternal">decimal</FuelSurchargeTrigger>
        <FuelType xmlns="http://ProMiles.FSIInternal">string</FuelType>
        <RouteMethod xmlns="http://ProMiles.FSIInternal">string</RouteMethod>
        <TripLegCollection xmlns="http://ProMiles.FSIInternal">
          <TripLeg>
            <LocationText>string</LocationText>
          </TripLeg>
          <TripLeg>
            <LocationText>string</LocationText>
          </TripLeg>
        </TripLegCollection>
        <AddMileTaxToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddMileTaxToTotal>
        <AddIFTASurchargeToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddIFTASurchargeToTotal>
        <AddStateTaxToTotal xmlns="http://ProMiles.FSIInternal">boolean</AddStateTaxToTotal>
        <UseMajorChainsOnly xmlns="http://ProMiles.FSIInternal">boolean</UseMajorChainsOnly>
        <UseNetwork xmlns="http://ProMiles.FSIInternal">boolean</UseNetwork>
        <ExcludeMexico xmlns="http://ProMiles.FSIInternal">boolean</ExcludeMexico>
        <Network xmlns="http://ProMiles.FSIInternal">
          <NetworkStop>
            <OpisID>int</OpisID>
            <FuelType>string</FuelType>
            <Adder>decimal</Adder>
          </NetworkStop>
          <NetworkStop>
            <OpisID>int</OpisID>
            <FuelType>string</FuelType>
            <Adder>decimal</Adder>
          </NetworkStop>
        </Network>
      </FSIRequest>
    </GetFuelSurchargeFull>
  </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>
    <GetFuelSurchargeFullResponse xmlns="http://www.fuelsurchargeindex.com/">
      <GetFuelSurchargeFullResult>
        <IsSuccess xmlns="http://ProMiles.FSIInternal">boolean</IsSuccess>
        <ErrorDescription xmlns="http://ProMiles.FSIInternal">string</ErrorDescription>
        <ReportGeneratedDate xmlns="http://ProMiles.FSIInternal">dateTime</ReportGeneratedDate>
        <FuelDate xmlns="http://ProMiles.FSIInternal">dateTime</FuelDate>
        <MPG xmlns="http://ProMiles.FSIInternal">decimal</MPG>
        <FuelSurchargeTrigger xmlns="http://ProMiles.FSIInternal">decimal</FuelSurchargeTrigger>
        <Adder xmlns="http://ProMiles.FSIInternal">decimal</Adder>
        <TripOrigin xmlns="http://ProMiles.FSIInternal">string</TripOrigin>
        <TripDestination xmlns="http://ProMiles.FSIInternal">string</TripDestination>
        <TripMiles xmlns="http://ProMiles.FSIInternal">decimal</TripMiles>
        <CostPerGallon xmlns="http://ProMiles.FSIInternal">decimal</CostPerGallon>
        <CostPerMile xmlns="http://ProMiles.FSIInternal">decimal</CostPerMile>
        <TotalFuelCost xmlns="http://ProMiles.FSIInternal">decimal</TotalFuelCost>
        <FuelType xmlns="http://ProMiles.FSIInternal">string</FuelType>
        <TotalGallonsConsumed xmlns="http://ProMiles.FSIInternal">decimal</TotalGallonsConsumed>
        <TotalFuelTax xmlns="http://ProMiles.FSIInternal">decimal</TotalFuelTax>
        <CostInExcessOfTrigger xmlns="http://ProMiles.FSIInternal">decimal</CostInExcessOfTrigger>
        <FSCRevenue xmlns="http://ProMiles.FSIInternal">decimal</FSCRevenue>
        <TotalFSCRevenue xmlns="http://ProMiles.FSIInternal">decimal</TotalFSCRevenue>
        <StateDataCollection xmlns="http://ProMiles.FSIInternal">
          <StateData>
            <StateAbbreviation>string</StateAbbreviation>
            <StateName>string</StateName>
            <TaxRate>decimal</TaxRate>
            <MilesInState>decimal</MilesInState>
            <TotalTax>decimal</TotalTax>
            <PercentOfTotalTrip>decimal</PercentOfTotalTrip>
            <GallonsConsumedInState>decimal</GallonsConsumedInState>
            <FuelCostExTax>decimal</FuelCostExTax>
            <FuelCost>decimal</FuelCost>
            <WeightedFuelCostExTax>decimal</WeightedFuelCostExTax>
            <WeightedFuelCost>decimal</WeightedFuelCost>
            <IFTASurchargeTotal>decimal</IFTASurchargeTotal>
            <IFTASurchargeRate>decimal</IFTASurchargeRate>
            <MileTaxRate>decimal</MileTaxRate>
            <MileTaxTotal>decimal</MileTaxTotal>
          </StateData>
          <StateData>
            <StateAbbreviation>string</StateAbbreviation>
            <StateName>string</StateName>
            <TaxRate>decimal</TaxRate>
            <MilesInState>decimal</MilesInState>
            <TotalTax>decimal</TotalTax>
            <PercentOfTotalTrip>decimal</PercentOfTotalTrip>
            <GallonsConsumedInState>decimal</GallonsConsumedInState>
            <FuelCostExTax>decimal</FuelCostExTax>
            <FuelCost>decimal</FuelCost>
            <WeightedFuelCostExTax>decimal</WeightedFuelCostExTax>
            <WeightedFuelCost>decimal</WeightedFuelCost>
            <IFTASurchargeTotal>decimal</IFTASurchargeTotal>
            <IFTASurchargeRate>decimal</IFTASurchargeRate>
            <MileTaxRate>decimal</MileTaxRate>
            <MileTaxTotal>decimal</MileTaxTotal>
          </StateData>
        </StateDataCollection>
        <TruckStopDataCollection xmlns="http://ProMiles.FSIInternal">
          <TruckStopData>
            <TruckStopName>string</TruckStopName>
            <OPISID>int</OPISID>
            <StateAbbreviation>string</StateAbbreviation>
            <StateFullName>string</StateFullName>
            <City>string</City>
            <Location>string</Location>
            <Phone>string</Phone>
            <Price>decimal</Price>
            <Adder>decimal</Adder>
            <FuelType>string</FuelType>
          </TruckStopData>
          <TruckStopData>
            <TruckStopName>string</TruckStopName>
            <OPISID>int</OPISID>
            <StateAbbreviation>string</StateAbbreviation>
            <StateFullName>string</StateFullName>
            <City>string</City>
            <Location>string</Location>
            <Phone>string</Phone>
            <Price>decimal</Price>
            <Adder>decimal</Adder>
            <FuelType>string</FuelType>
          </TruckStopData>
        </TruckStopDataCollection>
        <StateTaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</StateTaxPerGallon>
        <IFTATaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</IFTATaxPerGallon>
        <MileTaxPerGallon xmlns="http://ProMiles.FSIInternal">decimal</MileTaxPerGallon>
        <TotalMileTax xmlns="http://ProMiles.FSIInternal">decimal</TotalMileTax>
        <TotalIFTASurcharge xmlns="http://ProMiles.FSIInternal">decimal</TotalIFTASurcharge>
        <CostPerGallonExTax xmlns="http://ProMiles.FSIInternal">decimal</CostPerGallonExTax>
      </GetFuelSurchargeFullResult>
    </GetFuelSurchargeFullResponse>
  </soap12:Body>
</soap12:Envelope>