GET api/clients/{clientId}/trip/{tripId}

Gets information about a booked trip.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

ID of the client that the trip is for.

integer

Required

tripId

ID of the trip.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns information about the booked trip.

BookedTrip
NameDescriptionTypeAdditional information
TripType

Gets the type of the trip (Recurring/OneTime)

TripType

None.

Status

Gets or sets the current status of the trip.

TripStatus

None.

CreationDate

The date the trip was created

date

None.

ModifiedDate

The date the trip was modified

date

None.

FareToCollect

Gets or sets any remaining part of the fare that needs to be collected for this trip

decimal number

None.

PassengerFares

Gets or sets the fares for each passenger on the trip

Collection of PassengerFare

None.

Pickup

BookedTripLeg

None.

Dropoff

BookedTripLeg

None.

Date

date

None.

ClientID

integer

None.

MobilityAidCodes

Collection of string

None.

AdditionalPassengers

Collection of Passenger

None.

BookingPurposeCode

string

None.

BookingSubtypeCode

string

None.

ID

integer

None.

ItineraryID

integer

None.

CallbackPhoneNumber

string

None.

ServiceTypeId

integer

None.

Provider

TripProviderInfo

None.

UserDefinedFields

Dictionary of string [key] and Object [value]

None.

Comments

string

None.

DirectDistance

decimal number

None.

FundingProgramIds

Collection of integer

None.

SubscriptionId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "tripType": 0,
  "status": {
    "status": 0,
    "internalCode": "sample string 1"
  },
  "creationDate": "2021-06-24T02:11:21.2593221-06:00",
  "modifiedDate": "2021-06-24T02:11:21.2593221-06:00",
  "fareToCollect": 1.1,
  "passengerFares": [
    {
      "passengerType": {
        "code": "sample string 1",
        "name": "sample string 2",
        "defaultSpaceType": "sample string 3",
        "fareTypeId": 4
      },
      "spaceTypeCode": "sample string 1",
      "fare": 2.1
    },
    {
      "passengerType": {
        "code": "sample string 1",
        "name": "sample string 2",
        "defaultSpaceType": "sample string 3",
        "fareTypeId": 4
      },
      "spaceTypeCode": "sample string 1",
      "fare": 2.1
    }
  ],
  "pickup": {
    "estimatedTime": "00:00:00.1234567",
    "actualTime": "00:00:00.1234567",
    "status": {
      "status": 0,
      "internalCode": "sample string 1"
    },
    "location": {
      "id": 1,
      "description": "sample string 1",
      "category": "sample string 2",
      "name": "sample string 3",
      "latitude": 1.1,
      "longitude": 1.1,
      "streetNumber": "sample string 4",
      "onStreet": "sample string 5",
      "atStreet": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalCode": "sample string 9",
      "itemType": 0,
      "internalType": 0,
      "unit": "sample string 10",
      "comments": "sample string 11",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "sample string 2",
        "contactType": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "comments": "sample string 6",
        "details": [
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          },
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          }
        ]
      },
      "country": "sample string 13",
      "stopCode": "sample string 14"
    },
    "requestedTimeEarly": "00:00:00.1234567",
    "requestedTime": "00:00:00.1234567",
    "requestedTimeLate": "00:00:00.1234567",
    "negotiatedTimeEarly": "00:00:00.1234567",
    "negotiatedTime": "00:00:00.1234567",
    "negotiatedTimeLate": "00:00:00.1234567",
    "scheduledTimeEarly": "00:00:00.1234567",
    "scheduledTime": "00:00:00.1234567",
    "scheduledTimeLate": "00:00:00.1234567",
    "comments": "sample string 1",
    "phone": "sample string 2"
  },
  "dropoff": {
    "estimatedTime": "00:00:00.1234567",
    "actualTime": "00:00:00.1234567",
    "status": {
      "status": 0,
      "internalCode": "sample string 1"
    },
    "location": {
      "id": 1,
      "description": "sample string 1",
      "category": "sample string 2",
      "name": "sample string 3",
      "latitude": 1.1,
      "longitude": 1.1,
      "streetNumber": "sample string 4",
      "onStreet": "sample string 5",
      "atStreet": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalCode": "sample string 9",
      "itemType": 0,
      "internalType": 0,
      "unit": "sample string 10",
      "comments": "sample string 11",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "sample string 2",
        "contactType": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "comments": "sample string 6",
        "details": [
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          },
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          }
        ]
      },
      "country": "sample string 13",
      "stopCode": "sample string 14"
    },
    "requestedTimeEarly": "00:00:00.1234567",
    "requestedTime": "00:00:00.1234567",
    "requestedTimeLate": "00:00:00.1234567",
    "negotiatedTimeEarly": "00:00:00.1234567",
    "negotiatedTime": "00:00:00.1234567",
    "negotiatedTimeLate": "00:00:00.1234567",
    "scheduledTimeEarly": "00:00:00.1234567",
    "scheduledTime": "00:00:00.1234567",
    "scheduledTimeLate": "00:00:00.1234567",
    "comments": "sample string 1",
    "phone": "sample string 2"
  },
  "date": "2021-06-24T02:11:21.2633234-06:00",
  "clientID": 3,
  "mobilityAidCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "additionalPassengers": [
    {
      "passengerTypeCode": "sample string 1",
      "spaceTypeCode": "sample string 2",
      "fareTypeID": 1,
      "fundingProgramIds": [
        1,
        2
      ]
    },
    {
      "passengerTypeCode": "sample string 1",
      "spaceTypeCode": "sample string 2",
      "fareTypeID": 1,
      "fundingProgramIds": [
        1,
        2
      ]
    }
  ],
  "bookingPurposeCode": "sample string 4",
  "bookingSubtypeCode": "sample string 5",
  "id": 6,
  "itineraryID": 7,
  "callbackPhoneNumber": "sample string 8",
  "serviceTypeId": 1,
  "provider": {
    "providerId": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "providerStatus": 0
  },
  "userDefinedFields": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "comments": "sample string 9",
  "directDistance": 10.1,
  "fundingProgramIds": [
    1,
    2
  ],
  "subscriptionId": 11
}

application/xml, text/xml

Sample:
<BookedTrip xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <AdditionalPassengers>
    <Passenger>
      <FareTypeID>1</FareTypeID>
      <FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FundingProgramIds>
      <PassengerTypeCode>sample string 1</PassengerTypeCode>
      <SpaceTypeCode>sample string 2</SpaceTypeCode>
    </Passenger>
    <Passenger>
      <FareTypeID>1</FareTypeID>
      <FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FundingProgramIds>
      <PassengerTypeCode>sample string 1</PassengerTypeCode>
      <SpaceTypeCode>sample string 2</SpaceTypeCode>
    </Passenger>
  </AdditionalPassengers>
  <BookingPurposeCode>sample string 4</BookingPurposeCode>
  <BookingSubtypeCode>sample string 5</BookingSubtypeCode>
  <CallbackPhoneNumber>sample string 8</CallbackPhoneNumber>
  <ClientID>3</ClientID>
  <Comments>sample string 9</Comments>
  <Date>2021-06-24T02:11:21.2633234-06:00</Date>
  <DirectDistance>10.1</DirectDistance>
  <Dropoff>
    <Comments>sample string 1</Comments>
    <Location>
      <AtStreet>sample string 6</AtStreet>
      <Category>sample string 2</Category>
      <City>sample string 7</City>
      <Comments>sample string 11</Comments>
      <Contact>
        <Comments>sample string 6</Comments>
        <ContactType>sample string 3</ContactType>
        <Details>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
        </Details>
        <FirstName>sample string 4</FirstName>
        <ID>1</ID>
        <LastName>sample string 5</LastName>
        <ReferenceId>sample string 2</ReferenceId>
      </Contact>
      <Country>sample string 13</Country>
      <Description>sample string 1</Description>
      <ID>1</ID>
      <InternalType>Location</InternalType>
      <IsGeocoded>true</IsGeocoded>
      <ItemType>Location</ItemType>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 3</Name>
      <OnStreet>sample string 5</OnStreet>
      <PostalCode>sample string 9</PostalCode>
      <State>sample string 8</State>
      <StopCode>sample string 14</StopCode>
      <StreetNumber>sample string 4</StreetNumber>
      <Unit>sample string 10</Unit>
    </Location>
    <NegotiatedTime>PT0.1234567S</NegotiatedTime>
    <NegotiatedTimeEarly>PT0.1234567S</NegotiatedTimeEarly>
    <NegotiatedTimeLate>PT0.1234567S</NegotiatedTimeLate>
    <Phone>sample string 2</Phone>
    <RequestedTime>PT0.1234567S</RequestedTime>
    <RequestedTimeEarly>PT0.1234567S</RequestedTimeEarly>
    <RequestedTimeLate>PT0.1234567S</RequestedTimeLate>
    <ScheduledTime>PT0.1234567S</ScheduledTime>
    <ScheduledTimeEarly>PT0.1234567S</ScheduledTimeEarly>
    <ScheduledTimeLate>PT0.1234567S</ScheduledTimeLate>
    <ActualTime>PT0.1234567S</ActualTime>
    <EstimatedTime>PT0.1234567S</EstimatedTime>
    <Status>
      <InternalCode>sample string 1</InternalCode>
      <Status>Unscheduled</Status>
    </Status>
  </Dropoff>
  <FundingProgramIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FundingProgramIds>
  <ID>6</ID>
  <ItineraryID>7</ItineraryID>
  <MobilityAidCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MobilityAidCodes>
  <Pickup>
    <Comments>sample string 1</Comments>
    <Location>
      <AtStreet>sample string 6</AtStreet>
      <Category>sample string 2</Category>
      <City>sample string 7</City>
      <Comments>sample string 11</Comments>
      <Contact>
        <Comments>sample string 6</Comments>
        <ContactType>sample string 3</ContactType>
        <Details>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
        </Details>
        <FirstName>sample string 4</FirstName>
        <ID>1</ID>
        <LastName>sample string 5</LastName>
        <ReferenceId>sample string 2</ReferenceId>
      </Contact>
      <Country>sample string 13</Country>
      <Description>sample string 1</Description>
      <ID>1</ID>
      <InternalType>Location</InternalType>
      <IsGeocoded>true</IsGeocoded>
      <ItemType>Location</ItemType>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 3</Name>
      <OnStreet>sample string 5</OnStreet>
      <PostalCode>sample string 9</PostalCode>
      <State>sample string 8</State>
      <StopCode>sample string 14</StopCode>
      <StreetNumber>sample string 4</StreetNumber>
      <Unit>sample string 10</Unit>
    </Location>
    <NegotiatedTime>PT0.1234567S</NegotiatedTime>
    <NegotiatedTimeEarly>PT0.1234567S</NegotiatedTimeEarly>
    <NegotiatedTimeLate>PT0.1234567S</NegotiatedTimeLate>
    <Phone>sample string 2</Phone>
    <RequestedTime>PT0.1234567S</RequestedTime>
    <RequestedTimeEarly>PT0.1234567S</RequestedTimeEarly>
    <RequestedTimeLate>PT0.1234567S</RequestedTimeLate>
    <ScheduledTime>PT0.1234567S</ScheduledTime>
    <ScheduledTimeEarly>PT0.1234567S</ScheduledTimeEarly>
    <ScheduledTimeLate>PT0.1234567S</ScheduledTimeLate>
    <ActualTime>PT0.1234567S</ActualTime>
    <EstimatedTime>PT0.1234567S</EstimatedTime>
    <Status>
      <InternalCode>sample string 1</InternalCode>
      <Status>Unscheduled</Status>
    </Status>
  </Pickup>
  <Provider>
    <Description>sample string 3</Description>
    <Name>sample string 2</Name>
    <ProviderId>1</ProviderId>
    <ProviderStatus>None</ProviderStatus>
  </Provider>
  <ServiceTypeId>1</ServiceTypeId>
  <SubscriptionId>11</SubscriptionId>
  <UserDefinedFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </UserDefinedFields>
  <CreationDate>2021-06-24T02:11:21.2593221-06:00</CreationDate>
  <FareToCollect>1.1</FareToCollect>
  <ModifiedDate>2021-06-24T02:11:21.2593221-06:00</ModifiedDate>
  <PassengerFares>
    <PassengerFare>
      <Fare>2.1</Fare>
      <PassengerType>
        <Code>sample string 1</Code>
        <DefaultSpaceType>sample string 3</DefaultSpaceType>
        <FareTypeId>4</FareTypeId>
        <Name>sample string 2</Name>
      </PassengerType>
      <SpaceTypeCode>sample string 1</SpaceTypeCode>
    </PassengerFare>
    <PassengerFare>
      <Fare>2.1</Fare>
      <PassengerType>
        <Code>sample string 1</Code>
        <DefaultSpaceType>sample string 3</DefaultSpaceType>
        <FareTypeId>4</FareTypeId>
        <Name>sample string 2</Name>
      </PassengerType>
      <SpaceTypeCode>sample string 1</SpaceTypeCode>
    </PassengerFare>
  </PassengerFares>
  <Status>
    <InternalCode>sample string 1</InternalCode>
    <Status>Unscheduled</Status>
  </Status>
  <TripType>Unknown</TripType>
</BookedTrip>