GET vehicle/route/{routename}/realtimeattributes?vehicleId={vehicleId}

Retrieve a list of realtime attributes for a vehicle or list of vehicles currently in operation. Use this method when retrieving information for all the vehicles or just a few

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vehicleId

string

None.
routename

string

None.

Body Parameters

None.

Response Information

Resource Description

VehicleRealtimeAttributes
NameDescriptionTypeAdditional information
VehicleId

Alphanumeric string representing the vehicle ID(ie.bus number)

 string

None.
CurrentRoute

Name of the route that the vehicle is currently servicing

 string

None.
LastPositionLatitude

Numeric value representing the last known position - latitude - of the vehicle in Decimal Degrees. Null if the position is not known.

 decimal number

None.
LastPositionLongitude

Numeric value representing the last known position - longitude - of the vehicle in Decimal Degrees. Null if the position is not known.

 decimal number

None.
DateTimePositionReported

Datetime indicating when the vehicle position was last reported (Dates and Times in PST/PDT when applicable). Null if the position is not being reported.

 date

None.
VehicleCapacity

Numeric value that represents the vehicle's maximum recommended passenger load. Null if this information is not available.

 integer

None.
CurrentPassengerCount

Integer value that represents the vehicle's current passenger count. Null if this information is not available.

 integer

None.
EstimatedOccupancyPercentage

Integer value that represents the vehicle's estimated occupancy percentage. Null if this information is not available.

 integer

None.
EstimatedOccupancyStatusColor

String value with the recommeded RGB color in hexadecimal format to represent the vehicle's current estimated occupancy. Null if passenger occupancy is not available.

 string

None.
EstimatedOccupancyStatus

String value describing the estimated occupancy status for the vehicle. Possible returned values are: Null - Occupancy status information is not available. Not Crowded - Vehicle has plenty of room to accommodate new passengers. Some Crowding - Vehicle already has a few passengers but can accomodate more. Crowded - Vehicle is about to or already passed the recommended passenger capacity limit.

 string

None.
DateTimeAPCReported

Datetime indicating when passenger occupancy status was last reported (Dates and Times in PST/PDT when applicable). Null if occupancy status is not being reported.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "VehicleId": "sample string 1",
  "CurrentRoute": "sample string 2",
  "LastPositionLatitude": 1.1,
  "LastPositionLongitude": 1.1,
  "DateTimePositionReported": "2023-06-05T20:54:08.3184381-07:00",
  "VehicleCapacity": 1,
  "CurrentPassengerCount": 1,
  "EstimatedOccupancyPercentage": 1,
  "EstimatedOccupancyStatusColor": "sample string 3",
  "EstimatedOccupancyStatus": "sample string 4",
  "DateTimeAPCReported": "2023-06-05T20:54:08.3184381-07:00"
}

text/html

Sample: 
{"VehicleId":"sample string 1","CurrentRoute":"sample string 2","LastPositionLatitude":1.1,"LastPositionLongitude":1.1,"DateTimePositionReported":"2023-06-05T20:54:08.3184381-07:00","VehicleCapacity":1,"CurrentPassengerCount":1,"EstimatedOccupancyPercentage":1,"EstimatedOccupancyStatusColor":"sample string 3","EstimatedOccupancyStatus":"sample string 4","DateTimeAPCReported":"2023-06-05T20:54:08.3184381-07:00"}

application/xml, text/xml

Sample: 
<VehicleRealtimeAttributes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ACTransit.Transit.Domain.Models">
  <CurrentPassengerCount>1</CurrentPassengerCount>
  <CurrentRoute>sample string 2</CurrentRoute>
  <DateTimeAPCReported>2023-06-05T20:54:08.3184381-07:00</DateTimeAPCReported>
  <DateTimePositionReported>2023-06-05T20:54:08.3184381-07:00</DateTimePositionReported>
  <EstimatedOccupancyPercentage>1</EstimatedOccupancyPercentage>
  <EstimatedOccupancyStatus>sample string 4</EstimatedOccupancyStatus>
  <EstimatedOccupancyStatusColor>sample string 3</EstimatedOccupancyStatusColor>
  <LastPositionLatitude>1.1</LastPositionLatitude>
  <LastPositionLongitude>1.1</LastPositionLongitude>
  <VehicleCapacity>1</VehicleCapacity>
  <VehicleId>sample string 1</VehicleId>
</VehicleRealtimeAttributes>