GET Addresses/GetRouteForExpenseItem?expenseId={expenseId}

Gets the journey route and mapping details for an Expense Id


Parameters

NameDescriptionAdditional information
expenseId 
The expense Id

Define this parameter in the request URI.

Response body formats

The RouteResponse with the route and mapping details

application/json, text/json

Sample: 
{
  "Item": {
    "Error": "sample string 1",
    "RoutingType": "sample string 2",
    "WayPoints": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "Steps": [
      {
        "StepNumber": 1,
        "Action": "sample string 2",
        "Description": "sample string 3",
        "TotalTimeFormatted": "sample string 4",
        "TotalDistance": 5,
        "Line": [
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          }
        ],
        "StepDistanceInFeet": 6.1,
        "StepDistanceFormatted": "sample string 7",
        "StepTimeFormatted": "sample string 8",
        "ActionImage": "sample string 9"
      },
      {
        "StepNumber": 1,
        "Action": "sample string 2",
        "Description": "sample string 3",
        "TotalTimeFormatted": "sample string 4",
        "TotalDistance": 5,
        "Line": [
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          }
        ],
        "StepDistanceInFeet": 6.1,
        "StepDistanceFormatted": "sample string 7",
        "StepTimeFormatted": "sample string 8",
        "ActionImage": "sample string 9"
      },
      {
        "StepNumber": 1,
        "Action": "sample string 2",
        "Description": "sample string 3",
        "TotalTimeFormatted": "sample string 4",
        "TotalDistance": 5,
        "Line": [
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          },
          {
            "Latitude": "sample string 1",
            "Longitude": "sample string 2"
          }
        ],
        "StepDistanceInFeet": 6.1,
        "StepDistanceFormatted": "sample string 7",
        "StepTimeFormatted": "sample string 8",
        "ActionImage": "sample string 9"
      }
    ],
    "TotalTimeFormatted": "sample string 3",
    "DistanceFormatted": "sample string 4"
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<RouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses.Addresses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Addresses" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:DistanceFormatted>sample string 4</d2p1:DistanceFormatted>
    <d2p1:Error>sample string 1</d2p1:Error>
    <d2p1:RoutingType>sample string 2</d2p1:RoutingType>
    <d2p1:Steps>
      <d2p1:RouteStep>
        <d2p1:Action>sample string 2</d2p1:Action>
        <d2p1:ActionImage>sample string 9</d2p1:ActionImage>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Line>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
        </d2p1:Line>
        <d2p1:StepDistanceFormatted>sample string 7</d2p1:StepDistanceFormatted>
        <d2p1:StepDistanceInFeet>6.1</d2p1:StepDistanceInFeet>
        <d2p1:StepNumber>1</d2p1:StepNumber>
        <d2p1:StepTimeFormatted>sample string 8</d2p1:StepTimeFormatted>
        <d2p1:TotalDistance>5</d2p1:TotalDistance>
        <d2p1:TotalTimeFormatted>sample string 4</d2p1:TotalTimeFormatted>
      </d2p1:RouteStep>
      <d2p1:RouteStep>
        <d2p1:Action>sample string 2</d2p1:Action>
        <d2p1:ActionImage>sample string 9</d2p1:ActionImage>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Line>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
        </d2p1:Line>
        <d2p1:StepDistanceFormatted>sample string 7</d2p1:StepDistanceFormatted>
        <d2p1:StepDistanceInFeet>6.1</d2p1:StepDistanceInFeet>
        <d2p1:StepNumber>1</d2p1:StepNumber>
        <d2p1:StepTimeFormatted>sample string 8</d2p1:StepTimeFormatted>
        <d2p1:TotalDistance>5</d2p1:TotalDistance>
        <d2p1:TotalTimeFormatted>sample string 4</d2p1:TotalTimeFormatted>
      </d2p1:RouteStep>
      <d2p1:RouteStep>
        <d2p1:Action>sample string 2</d2p1:Action>
        <d2p1:ActionImage>sample string 9</d2p1:ActionImage>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Line>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
          <d2p1:MileageJourneyCoordinate>
            <d2p1:Latitude>sample string 1</d2p1:Latitude>
            <d2p1:Longitude>sample string 2</d2p1:Longitude>
          </d2p1:MileageJourneyCoordinate>
        </d2p1:Line>
        <d2p1:StepDistanceFormatted>sample string 7</d2p1:StepDistanceFormatted>
        <d2p1:StepDistanceInFeet>6.1</d2p1:StepDistanceInFeet>
        <d2p1:StepNumber>1</d2p1:StepNumber>
        <d2p1:StepTimeFormatted>sample string 8</d2p1:StepTimeFormatted>
        <d2p1:TotalDistance>5</d2p1:TotalDistance>
        <d2p1:TotalTimeFormatted>sample string 4</d2p1:TotalTimeFormatted>
      </d2p1:RouteStep>
    </d2p1:Steps>
    <d2p1:TotalTimeFormatted>sample string 3</d2p1:TotalTimeFormatted>
    <d2p1:WayPoints xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </d2p1:WayPoints>
  </Item>
</RouteResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body