RailState Data Dictionary
The following are data elements that when detected can be assigned to an applicable RailState sighting. Data elements can be retrieved from either the UI or API, or both, as indicated in the availability column.
Where a data element is not detected, a null may be returned.
Not all UMLER derived data elements are available for all equipment types. For more technical details please reach out to your commercial representative, or support+UI@railstate.com or support+API@railstate.com
| Data Element | Description | Availability |
Active Train Trip | An indication that the train is on an active trip (vs prior cycle). A train is no longer active if it is on its next cycle or times out | API and UI |
Bottom Outlet Count | The number of bottom outlets or washouts on the equipment (UMLER B142) | API and UI |
Car Count | The count of cars as detected in the sighting (not distinguishing individual platforms for intermodal cars) | UI |
Car ID | The equipment ID as detected by RailState and validated in UMLER (UMLER 0001) | API and UI |
Car Position | The position of the identified equipment in relation to the full train composition during detection | UI |
Car/Platform Count | The count of cars and platforms as detected in the sighting (distinguishing individual platforms for intermodal cars) | UI |
Compartment Count | The number of individual compartments the equipment contains (UMLER A052) | API and UI |
Composition | A summary of the types and count of railcar equipment detected within a specific Train Trip ID detection | UI |
Container ID | The domestic or international container ID as detected by RailState, where available | API and UI |
Container Position | The detected position of the container on the well car, such as 'Bottom Front' | API and UI |
Container Types | The observed container type, such as 'Container 53 Feet', 'Trailer 20 Feet' | API and UI |
(Container) Type Code | The 4-character size and type code of international containers (presently not populated, shown as null) | API and UI |
Containers | A summary of containers detected on the equipment | API and UI |
Cubic Capacity [Cubic Feet] | The maximum interior capacity of the equipment, presented in cubic feet (UMLER A067) | API and UI |
Detection Duration [Minutes] | The time passed from start of train detection until the time in which the train detection ended (the train cleared the sensor) | UI |
Detection End (Site Local) | Time when the train finished passing the sensor, reported in the timezone in which the reporting sensor is located | API and UI |
Detection End (User Local) | Time when the train finished passing the sensor, in the timezone as set in the user's UI settings | UI |
Detection End (UTC) | Time when the train finished passing the sensor, reported in UTC (Coordinated Universal Time) | API and UI |
Detection Time (Site Local) | Time of the detection reported in the timezone in which the reporting sensor is located | API and UI |
Detection Time (User Local) | Time of the detection reported in the timezone as set in the user's UI settings | UI |
Detection Time (UTC) | Time of the detection reported in UTC (Coordinated Universal Time) | API and UI |
Direction | The rail timetable direction of the train at time of detection (Note: this does not always align with cardinal direction) | API and UI |
EPA Emissions Tier Level | The EPA emissions Tier level assigned to the locomotive equipment (UMLER B081) | API and UI |
Equipment Builder | The original manufacturer of the equipment, as registered (UMLER A035) | API and UI |
Equipment Lessee | The company leasing the equipment, as presented as a reporting mark, where reported and available (UMLER LESE) | API and UI |
Equipment Lists | An indicator if equipment identified in a list created by user is present within a train or consiste record. | UI |
Equipment Owner | The railroad or private company owning the equipment, as presented as a reporting mark | API and UI |
Equipment Type Code | The 4-character alphanumeric code that can be deciphered to outline attributes of the equipment (UMLER UMET) | API and UI |
Est. Cubic Capacity [Cubic Feet] | A train-level estimate of the max. interior capacity for relevant equipment contained on the train, presented in cubic feet | API and UI |
Est. Gross Weight [Tons] | A train-level estimate of the max. weight on rail of the equipment and the load contained on the train, as presented in short tons | API and UI |
Est. Length [Feet] | A train-level estimate for the outside length of the train, in feet, end to end | API and UI |
Est. Liquid Capacity [Gallons] | A train-level estimate of the max. interior capacity of the train, for relevant equipment contained, presented in gallons | API and UI |
Est. Load Limit [Tons] | A train-level estimate of the max. weight that can be loaded into the equipment contained on the train, presented in short tons | API and UI |
Est. Tare Weight [Tons] | A train-level estimate of the max. equipment weight when empty contained on the train, presented in short tons | API and UI |
Gross Weight [Tons] | The maximum permissible weight on rail of the equipment and the load, as presented in short tons (UMLER A266) | API and UI |
Hazard Class | The Hazard Class associated with the HazMat UN Number detected on the equipment during the sighting | API and UI |
HazMat | Information about detected hazardous materials as determined by placard information, or indication of empty placard holder | UI |
HazMat UN Number | The UN number of the hazardous material as detected on the equipment during the sighting | API and UI |
Horsepower | The horsepower of the locomotive, as registered (UMLER A123) | API and UI |
Initial Train Trip Site | The first sensor site in which RailState assigned the train ID. (Where outside of users' geographic permissions it will show 'Restricted') | UI |
Issues / Warnings | A list of detection irregularities indicating potential data issues, such as partial sightings (API see 'Issues'; UI see 'Warnings') | API and UI |
Last Train Trip Site | The last sensor site in which RailState saw the assigned the train ID. (Where outside of users' geographic permissions it will show 'Restricted') | UI |
Length [Feet] | The outside length of the equipment, in feet, coupler to coupler (UMLER OSLG) | API and UI |
Liquid Capacity [Gallons] | The maximum interior capacity of the equipment, presented in gallons (UMLER A297) | API and UI |
List of Cars | A list of cars ordered as they appeared in the train during detection | API and UI |
Load Limit [Tons] | The maximum permissible weight that can be loaded into the equipment, presented in short tons | API and UI |
Loaded | The empty/loaded status of the railcar where able to distinguish based on car type or direction of travel logic (null if unknown) | API and UI |
Loco. Model Number | The manufacturer model number of the locomotive, as registered (UMLER A068) | API and UI |
Railcar Owner | The owner of the railcar or locomotive, as registered (UMLER UMOW) | API and UI |
Sensor Active | An indicator signifying whether or not the sensor is active at present time | API |
Sensor Active Date/Tm | List of time intervals when the sensor was active | API |
Sensor Country | The country in which the sensor is located | API |
Sensor Latitude | Latitude of sensor location (in degrees) | API |
Sensor Longitude | Longitude of sensor location (in degrees) | API |
Sensor Name / Site | A human-readable name assigned to a sensor ID by RailState. Usually the name of the nearest railroad station. | API and UI |
Sensor Overview | A list of data about a sensor | API |
Sensor Railways (Operating) | List of railroad(s) operating on the rail line(s) monitored by the identified sensor | API |
Sensor Railways (Owner) | List of railroad(s) owning the rail line(s) monitored by the identified sensor | API |
Sensor Region | The US state or Canadian province in which the sensor is located | API |
Sensor Status History | A history of the status of a sensor | API |
Sensor Timezone | The local timezone where the sensor is located | API |
Sighting ID | A unique identifier assigned by RailState to identify a unique detection of a train at a sensor | API and UI |
Site / Sensor ID | A unique value used within RailState to identify the sensor site (associated with a Site Name and State/Prov.) | API and UI |
Speed / Instantaneous Speed | The approximate speed, in miles per hour, that the train was travelling at time of detection at the RailState sensor site | API and UI |
Tare Weight [Tons] | The equipment weight when empty, presented in short tons (UMLER A259) | API and UI |
Train (Trip) ID | A unique identifier assigned by RailState to a train set that has been detected at one or more sightings | API and UI |
Train Operator | The rail carrier physically operating the train movement at time of sighting, based on the paint scheme of leading locomotives | API and UI |
Train Set ID | As set with the original Train Trip ID when detected, the Train Set ID stays with the identified train as it cycles back and forth | API and UI |
Train Sighting Last Modified | The date/time in UTC of the last update to the train sighting (focus of API would be to include records updated since last call) | API |
Train Tag | A user-defined value that helps within an organization to easily identify and call upon trains in terms relevant to their business | UI |
Train Type | The type of the train as determined by RailState at time of detection, such as 'Coal Unit', 'Manifest' based on car type mix. | API and UI |
As is the nature with machine learning and computer vision, functionality, and as such capture rates and classification, improves over time as learning from data sets occurs. Factors outside of our control may also skew accuracy metrics on text attributes, as the data we collect would be unreadable by the human eye to begin with.