GET api/VehicleSchedules/RoutePathPoints?vehicleScheduleId={vehicleScheduleId}

Get Route path points for all routes for the vehicleSchedule

Request Information

URI Parameters

Name	Description	Type	Additional information
vehicleScheduleId		integer	Required

Body Parameters

None.

Response Information

Resource Description

VehicleScheduleRoutesDTO

Name	Description	Type	Additional information
VehicleScheduleId	VehicleSchedule ID	integer	None.
Routes	Routes	Collection of RouteDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "VehicleScheduleId": 1,
  "Routes": [
    {
      "RouteId": 1,
      "FromLocationId": 2,
      "ToLocationId": 3,
      "FromLocationDescription": "sample string 4",
      "ToLocationDescription": "sample string 5",
      "Description": "sample string 6",
      "Distance": 7.1,
      "TimeInSeconds": 8,
      "RoutePathPoints": [
        {
          "Sequence": 1,
          "Longitude": 1.1,
          "Latitude": 1.1
        },
        {
          "Sequence": 1,
          "Longitude": 1.1,
          "Latitude": 1.1
        }
      ]
    },
    {
      "RouteId": 1,
      "FromLocationId": 2,
      "ToLocationId": 3,
      "FromLocationDescription": "sample string 4",
      "ToLocationDescription": "sample string 5",
      "Description": "sample string 6",
      "Distance": 7.1,
      "TimeInSeconds": 8,
      "RoutePathPoints": [
        {
          "Sequence": 1,
          "Longitude": 1.1,
          "Latitude": 1.1
        },
        {
          "Sequence": 1,
          "Longitude": 1.1,
          "Latitude": 1.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<VehicleScheduleRoutesDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMS.Models">
  <Routes>
    <RouteDTO>
      <Description>sample string 6</Description>
      <Distance>7.1</Distance>
      <FromLocationDescription>sample string 4</FromLocationDescription>
      <FromLocationId>2</FromLocationId>
      <RouteId>1</RouteId>
      <RoutePathPoints>
        <RoutePathPointsDTO>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Sequence>1</Sequence>
        </RoutePathPointsDTO>
        <RoutePathPointsDTO>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Sequence>1</Sequence>
        </RoutePathPointsDTO>
      </RoutePathPoints>
      <TimeInSeconds>8</TimeInSeconds>
      <ToLocationDescription>sample string 5</ToLocationDescription>
      <ToLocationId>3</ToLocationId>
    </RouteDTO>
    <RouteDTO>
      <Description>sample string 6</Description>
      <Distance>7.1</Distance>
      <FromLocationDescription>sample string 4</FromLocationDescription>
      <FromLocationId>2</FromLocationId>
      <RouteId>1</RouteId>
      <RoutePathPoints>
        <RoutePathPointsDTO>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Sequence>1</Sequence>
        </RoutePathPointsDTO>
        <RoutePathPointsDTO>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Sequence>1</Sequence>
        </RoutePathPointsDTO>
      </RoutePathPoints>
      <TimeInSeconds>8</TimeInSeconds>
      <ToLocationDescription>sample string 5</ToLocationDescription>
      <ToLocationId>3</ToLocationId>
    </RouteDTO>
  </Routes>
  <VehicleScheduleId>1</VehicleScheduleId>
</VehicleScheduleRoutesDTO>