GET api/Route

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Route
NameDescriptionTypeAdditional information
ID

integer

None.

RouteId

integer

None.

RouteLoginId

integer

None.

RouteName

string

None.

FareTypes

Collection of FareType

None.

Active

boolean

None.

VersionNumber

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "RouteId": 2,
    "RouteLoginId": 3,
    "RouteName": "sample string 4",
    "FareTypes": [
      {
        "FareTypeId": 1,
        "FareDescription": "sample string 2",
        "Chargeable": true,
        "Amount": 4.1,
        "RouteId": 5,
        "IsContactless": true,
        "Validate": true,
        "ShowButton": true,
        "ButtonLocation": 9,
        "StopsValid": [
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          },
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          }
        ],
        "Active": true,
        "VersionNumber": 11
      },
      {
        "FareTypeId": 1,
        "FareDescription": "sample string 2",
        "Chargeable": true,
        "Amount": 4.1,
        "RouteId": 5,
        "IsContactless": true,
        "Validate": true,
        "ShowButton": true,
        "ButtonLocation": 9,
        "StopsValid": [
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          },
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          }
        ],
        "Active": true,
        "VersionNumber": 11
      }
    ],
    "Active": true,
    "VersionNumber": 6
  },
  {
    "ID": 1,
    "RouteId": 2,
    "RouteLoginId": 3,
    "RouteName": "sample string 4",
    "FareTypes": [
      {
        "FareTypeId": 1,
        "FareDescription": "sample string 2",
        "Chargeable": true,
        "Amount": 4.1,
        "RouteId": 5,
        "IsContactless": true,
        "Validate": true,
        "ShowButton": true,
        "ButtonLocation": 9,
        "StopsValid": [
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          },
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          }
        ],
        "Active": true,
        "VersionNumber": 11
      },
      {
        "FareTypeId": 1,
        "FareDescription": "sample string 2",
        "Chargeable": true,
        "Amount": 4.1,
        "RouteId": 5,
        "IsContactless": true,
        "Validate": true,
        "ShowButton": true,
        "ButtonLocation": 9,
        "StopsValid": [
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          },
          {
            "StopId": 1,
            "StopName": "sample string 2",
            "Lat": 3.1,
            "Long": 4.1,
            "Active": true,
            "VersionNumber": 6
          }
        ],
        "Active": true,
        "VersionNumber": 11
      }
    ],
    "Active": true,
    "VersionNumber": 6
  }
]

application/xml, text/xml

Sample:
<ArrayOfRoute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FareFrontEndData">
  <Route>
    <Active>true</Active>
    <VersionNumber>6</VersionNumber>
    <FareTypes>
      <FareType>
        <Active>true</Active>
        <VersionNumber>11</VersionNumber>
        <Amount>4.1</Amount>
        <ButtonLocation>9</ButtonLocation>
        <Chargeable>true</Chargeable>
        <FareDescription>sample string 2</FareDescription>
        <FareTypeId>1</FareTypeId>
        <IsContactless>true</IsContactless>
        <RouteId>5</RouteId>
        <ShowButton>true</ShowButton>
        <StopsValid>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
        </StopsValid>
        <Validate>true</Validate>
      </FareType>
      <FareType>
        <Active>true</Active>
        <VersionNumber>11</VersionNumber>
        <Amount>4.1</Amount>
        <ButtonLocation>9</ButtonLocation>
        <Chargeable>true</Chargeable>
        <FareDescription>sample string 2</FareDescription>
        <FareTypeId>1</FareTypeId>
        <IsContactless>true</IsContactless>
        <RouteId>5</RouteId>
        <ShowButton>true</ShowButton>
        <StopsValid>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
        </StopsValid>
        <Validate>true</Validate>
      </FareType>
    </FareTypes>
    <ID>1</ID>
    <RouteId>2</RouteId>
    <RouteLoginId>3</RouteLoginId>
    <RouteName>sample string 4</RouteName>
  </Route>
  <Route>
    <Active>true</Active>
    <VersionNumber>6</VersionNumber>
    <FareTypes>
      <FareType>
        <Active>true</Active>
        <VersionNumber>11</VersionNumber>
        <Amount>4.1</Amount>
        <ButtonLocation>9</ButtonLocation>
        <Chargeable>true</Chargeable>
        <FareDescription>sample string 2</FareDescription>
        <FareTypeId>1</FareTypeId>
        <IsContactless>true</IsContactless>
        <RouteId>5</RouteId>
        <ShowButton>true</ShowButton>
        <StopsValid>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
        </StopsValid>
        <Validate>true</Validate>
      </FareType>
      <FareType>
        <Active>true</Active>
        <VersionNumber>11</VersionNumber>
        <Amount>4.1</Amount>
        <ButtonLocation>9</ButtonLocation>
        <Chargeable>true</Chargeable>
        <FareDescription>sample string 2</FareDescription>
        <FareTypeId>1</FareTypeId>
        <IsContactless>true</IsContactless>
        <RouteId>5</RouteId>
        <ShowButton>true</ShowButton>
        <StopsValid>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
          <Stop>
            <Active>true</Active>
            <VersionNumber>6</VersionNumber>
            <Lat>3.1</Lat>
            <Long>4.1</Long>
            <StopId>1</StopId>
            <StopName>sample string 2</StopName>
          </Stop>
        </StopsValid>
        <Validate>true</Validate>
      </FareType>
    </FareTypes>
    <ID>1</ID>
    <RouteId>2</RouteId>
    <RouteLoginId>3</RouteLoginId>
    <RouteName>sample string 4</RouteName>
  </Route>
</ArrayOfRoute>