GET vehicle/characteristics?vehicleId={vehicleId}
Retrieve known characteristics for an active vehicle, a list of active vehicles or all active vehicles.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
vehicleId | string |
None. |
Body Parameters
None.
Response Information
Resource Description
VehicleCharacteristicsName | Description | Type | Additional information |
---|---|---|---|
VehicleId |
Alphanumeric string representing the vehicle ID(ie.bus number). |
string |
None. |
IsActive |
Boolean value indicating if the vehicle is operative. |
boolean |
None. |
Description |
Contains a brief description of the vehicle such as maker and propulsion type. |
string |
None. |
VehicleType |
Alphanumeric code that represents the type of vehicle. |
string |
None. |
VehicleTypeDescription |
Contains a brief description of the type of vehicle. |
string |
None. |
Make |
String indicating the maker of the vehicle. |
string |
None. |
SerialNumber |
String indicating the serial number of the vehicle. |
string |
None. |
LicenseNumber |
String indicating the license number of the vehicle (when available). |
string |
None. |
Length |
String value indicating the the vehicle length in feet. |
string |
None. |
PropulsionType |
String value that represents the propulsion type of the vehicle - Fuel Cell, Diesel, Electric, etc. |
string |
None. |
HasWiFi |
Boolean value that indicates if the vehicle has WiFi available onboard. |
boolean |
None. |
HasAC |
Boolean value that indicates if the vehicle has Air Conditioning onboard. |
boolean |
None. |
StandingCapacity |
Numeric value that indicates the recommended number of standing passengers that the vehicle can carry as per maker specifications. Null if not known. |
string |
None. |
SeatingCapacity |
Numeric value that indicates the recommended number of seated passengers that the vehicle can carry as per maker specifications. Null if not known. |
string |
None. |
LimitCapacity |
This numeric value indicates the actual number of passengers that the vehicle can carry as determined by the Transit Agency. This value can change over time in order to addapt to any recommendations from local or federal regulation authorities When available, it supercedes any of the maker's recommended specifications regarding vehicle capacity. |
string |
None. |
Response Formats
application/json, text/json
{ "VehicleId": "sample string 1", "IsActive": true, "Description": "sample string 3", "VehicleType": "sample string 4", "VehicleTypeDescription": "sample string 5", "Make": "sample string 6", "SerialNumber": "sample string 7", "LicenseNumber": "sample string 8", "Length": "sample string 9", "PropulsionType": "sample string 10", "HasWiFi": true, "HasAC": true, "StandingCapacity": "sample string 13", "SeatingCapacity": "sample string 14", "LimitCapacity": "sample string 15" }
text/html
{"VehicleId":"sample string 1","IsActive":true,"Description":"sample string 3","VehicleType":"sample string 4","VehicleTypeDescription":"sample string 5","Make":"sample string 6","SerialNumber":"sample string 7","LicenseNumber":"sample string 8","Length":"sample string 9","PropulsionType":"sample string 10","HasWiFi":true,"HasAC":true,"StandingCapacity":"sample string 13","SeatingCapacity":"sample string 14","LimitCapacity":"sample string 15"}
application/xml, text/xml
<VehicleCharacteristics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ACTransit.Transit.Domain.Models"> <Description>sample string 3</Description> <HasAC>true</HasAC> <HasWiFi>true</HasWiFi> <IsActive>true</IsActive> <Length>sample string 9</Length> <LicenseNumber>sample string 8</LicenseNumber> <LimitCapacity>sample string 15</LimitCapacity> <Make>sample string 6</Make> <PropulsionType>sample string 10</PropulsionType> <SeatingCapacity>sample string 14</SeatingCapacity> <SerialNumber>sample string 7</SerialNumber> <StandingCapacity>sample string 13</StandingCapacity> <VehicleId>sample string 1</VehicleId> <VehicleType>sample string 4</VehicleType> <VehicleTypeDescription>sample string 5</VehicleTypeDescription> </VehicleCharacteristics>