diff --git a/src/site/markdown/api/where/elements/arrival-and-departure.md b/src/site/markdown/api/where/elements/arrival-and-departure.md index b1a34228a9..d63fd73de1 100644 --- a/src/site/markdown/api/where/elements/arrival-and-departure.md +++ b/src/site/markdown/api/where/elements/arrival-and-departure.md @@ -34,27 +34,27 @@ The `` element captures information about the arrival and ## Details -* routeId - the route id for the arriving vehicle -* tripId - the trip id for the arriving vehicle -* serviceDate - time, in ms since the unix epoch, of midnight for start of the service date for the trip. -* stopId - the stop id of the stop the vehicle is arriving at -* stopSequence - the index of the stop into the sequence of stops that make up the trip for this arrival. This value is 0-indexed, and is generated internally by OneBusAway (it is not the GTFS stop_sequence). The first stop in the trip will always have stopSequence = 0, while the last stop in the trip will always have stopSequence = totalStopsInTrip - 1. -* totalStopsInTrip - the total number of stops visited on the trip for this arrival. If the same stop is visited more than once in this trip, each visitation is counted towards the total. -* blockTripSequence - the index of this arrival's trip into the sequence of trips for the active block. Compare to `blockTripSequence` in the [OneBusAwayRestApi_TripStatusElementV2 tripStatus element] to determine where the arrival-and-departure is on the block in comparison to the active block location. -* routeShortName - the route short name that potentially overrides the route short name in the referenced [`` element](route.html) - *OPTIONAL* -* routeLongName - the route long name that potentially overrides the route long name in the referenced [`` element](route.html) - *OPTIONAL* -* tripHeadsign - the trip headsign that potentially overrides the trip headsign in the referenced [`` element](trip.html) - *OPTIONAL* -* arrivalEnabled - true if this transit vehicle is one that riders could arrive on -* departureEnabled - true if this transit vehicle is one that riders can depart on -* scheduledArrivalTime - scheduled arrival time, ms since unix epoch -* scheduledDepartureTime - scheduled departure time, ms since unix epoch -* frequency - information about [frequency based scheduling](frequency.html), if applicable to the trip - *OPTIONAL* -* predicted - true if we have real-time arrival info available for this trip -* predictedArrivalTime - predicted arrival time, ms since unix epoch, zero if no real-time available -* predictedDepartureTime - predicted departure time, ms since unix epoch, zero if no real-time available -* distanceFromStop - distance of the arriving transit vehicle from the stop, in meters -* numberOfStopsAway - the number of stops between the arriving transit vehicle and the current stop (doesn't include the current stop) -* tripStatus - [`` element](trip-status.html) giving trip-specific status for the arriving transit vehicle - *OPTIONAL* +* `routeId` - the route id for the arriving vehicle +* `tripId` - the trip id for the arriving vehicle +* `serviceDate` - time, in ms since the unix epoch, of midnight for start of the service date for the trip. +* `stopId` - the stop id of the stop the vehicle is arriving at +* `stopSequence` - the index of the stop into the sequence of stops that make up the trip for this arrival. This value is 0-indexed, and is generated internally by OneBusAway (it is not the GTFS stop_sequence). The first stop in the trip will always have `stopSequence = 0`, while the last stop in the trip will always have `stopSequence = totalStopsInTrip - 1`. +* `totalStopsInTrip` - the total number of stops visited on the trip for this arrival. If the same stop is visited more than once in this trip, each visitation is counted towards the total. +* `blockTripSequence` - the index of this arrival's trip into the sequence of trips for the active block. Compare to `blockTripSequence` in the [OneBusAwayRestApi_TripStatusElementV2 tripStatus element] to determine where the arrival-and-departure is on the block in comparison to the active block location. +* `routeShortName` - the route short name that potentially overrides the route short name in the referenced [`` element](route.html) - *OPTIONAL* +* `routeLongName` - the route long name that potentially overrides the route long name in the referenced [`` element](route.html) - *OPTIONAL* +* `tripHeadsign` - the trip headsign that potentially overrides the trip headsign in the referenced [`` element](trip.html) - *OPTIONAL* +* `arrivalEnabled` - true if this transit vehicle is one that riders could arrive on +* `departureEnabled` - true if this transit vehicle is one that riders can depart on +* `scheduledArrivalTime` - scheduled arrival time, ms since unix epoch +* `scheduledDepartureTime` - scheduled departure time, ms since unix epoch +* `frequency` - information about [frequency based scheduling](frequency.html), if applicable to the trip - *OPTIONAL* +* `predicted` - true if we have real-time arrival info available for this trip +* `predictedArrivalTime` - predicted arrival time, ms since unix epoch, zero if no real-time available +* `predictedDepartureTime` - predicted departure time, ms since unix epoch, zero if no real-time available +* `distanceFromStop` - distance of the arriving transit vehicle from the stop, in meters +* `numberOfStopsAway` - the number of stops between the arriving transit vehicle and the current stop (doesn't include the current stop) +* `tripStatus` - [`` element](trip-status.html) giving trip-specific status for the arriving transit vehicle - *OPTIONAL* ## Notes diff --git a/src/site/markdown/api/where/elements/block-configuration.md b/src/site/markdown/api/where/elements/block-configuration.md index c5d688bc90..1d08b2f972 100644 --- a/src/site/markdown/api/where/elements/block-configuration.md +++ b/src/site/markdown/api/where/elements/block-configuration.md @@ -44,28 +44,28 @@ In addition to service id information, the block configuration contains the list The `` element has the following sub-elements: -* activeServiceIds - a collection of strings indicating which service ids are active for the block configuration -* inactiveServiceIds - a collection of strings indicating which service ids are NOT active for the block configuration -* trips - the sequence of `` elements for each block trip in the configuration +* `activeServiceIds` - a collection of strings indicating which service ids are active for the block configuration +* `inactiveServiceIds` - a collection of strings indicating which service ids are NOT active for the block configuration +* `trips` - the sequence of `` elements for each block trip in the configuration The block trip has the following properties: -* tripId - id of the referenced [``](trip.html) element +* `tripId` - id of the referenced [``](trip.html) element * block stop times - see below * accumulated slack time - how much slack time from layovers has been accumulated from previous block trips in the block up to the start of this block -* distanceAlongBlock - how far along the block, in meters, is the start of this trip +* `distanceAlongBlock` - how far along the block, in meters, is the start of this trip Block stop times capture the individually scheduled stops along each trip. We provide the following fields: -* blockSequence - the index of the block stop time in the list of all scheduled stops for the block configuration -* distanceAlongBlock - how far along the block, in meters, this stop occurs -* accumulatedSlackTime - how much slack time from layovers has been accumulated previous along the block up until, but not including, this stop -* stopTime - reference to the general stop time for the trip - see below +* `blockSequence` - the index of the block stop time in the list of all scheduled stops for the block configuration +* `distanceAlongBlock` - how far along the block, in meters, this stop occurs +* `accumulatedSlackTime` - how much slack time from layovers has been accumulated previous along the block up until, but not including, this stop +* `stopTime` - reference to the general stop time for the trip - see below A stop time is a more general notion of a scheduled stop along a trip: -* stopId - id of the referenced [``](stop.html) element -* arrivalTime - time, in seconds from the start of the service date -* departureTime - time, in seconds from the start of the service date -* pickupType - see the [GTFS spec](http://code.google.com/transit/spec/transit_feed_specification.html#stop_times_txt___Field_Definitions) -* dropOffType - see the [GTFS spec](http://code.google.com/transit/spec/transit_feed_specification.html#stop_times_txt___Field_Definitions) +* `stopId` - id of the referenced [``](stop.html) element +* `arrivalTime` - time, in seconds from the start of the service date +* `departureTime` - time, in seconds from the start of the service date +* `pickupType` - see the [GTFS spec](http://code.google.com/transit/spec/transit_feed_specification.html#stop_times_txt___Field_Definitions) +* `dropOffType` - see the [GTFS spec](http://code.google.com/transit/spec/transit_feed_specification.html#stop_times_txt___Field_Definitions) diff --git a/src/site/markdown/api/where/elements/situation.md b/src/site/markdown/api/where/elements/situation.md index 6aff2c7616..3dd0750539 100644 --- a/src/site/markdown/api/where/elements/situation.md +++ b/src/site/markdown/api/where/elements/situation.md @@ -55,9 +55,9 @@ The `` element can be broken up into a couple of relevant sections: * `id` - the unique id for this service alert situation * `creationTime` - Unix timestamp of when this situation was created * reason for the service alert taken from TPEG codes - only one of these will be set - * `equipmentReason - ex. engineFailure - * `environmentReason - ex. heavySnowfall - * `personnelReason - ex. staffAbsence + * `equipmentReason` - ex. engineFailure + * `environmentReason` - ex. heavySnowfall + * `personnelReason` - ex. staffAbsence * `miscellaneousReason` - ex. securityAlert * `securityAlert` - free text field * descriptive text fields - each with a sub `` element, each also optional diff --git a/src/site/markdown/api/where/elements/trip-details.md b/src/site/markdown/api/where/elements/trip-details.md index 3c83ac620e..3e5869b89b 100644 --- a/src/site/markdown/api/where/elements/trip-details.md +++ b/src/site/markdown/api/where/elements/trip-details.md @@ -50,15 +50,15 @@ where applicable. For more details on the `` element, see the [`` section, which includes the following elements: -* timeZone - the id of the default time zone for this trip -* stopTimes - specific details about which stops are visited during the course of the trip and at what times. See `` below for more info. -* previousTripId - if this trip is part of a block and has an incoming trip from another route, this element will give the id of the incoming trip -* nextTrip - if this trip is part of a block and has an outgoing trip to another route, this element will give the id of the outgoing trip +* `timeZone` - the id of the default time zone for this trip +* `stopTimes` - specific details about which stops are visited during the course of the trip and at what times. See `` below for more info. +* `previousTripId` - if this trip is part of a block and has an incoming trip from another route, this element will give the id of the incoming trip +* `nextTrip` - if this trip is part of a block and has an outgoing trip to another route, this element will give the id of the outgoing trip Details about the `` element. Note that arrival and departure times are the scheduled times and do not reflect real-time arrival information, even if it's available: -* arrivalTime - time, in seconds since the start of the service date, when the trip arrives at the specified stop -* departureTime - time, in seconds since the start of the service date, when the trip arrives at the specified stop -* stopId - the stop id of the stop visited during the trip +* `arrivalTime` - time, in seconds since the start of the service date, when the trip arrives at the specified stop +* `departureTime` - time, in seconds since the start of the service date, when the trip arrives at the specified stop +* `stopId` - the stop id of the stop visited during the trip Finally, the `` element contains ids for any active [`` elements](situation.html) that currently apply to the trip. diff --git a/src/site/markdown/api/where/elements/trip-status.md b/src/site/markdown/api/where/elements/trip-status.md index a3624085fd..6bd12b8b8c 100644 --- a/src/site/markdown/api/where/elements/trip-status.md +++ b/src/site/markdown/api/where/elements/trip-status.md @@ -48,27 +48,27 @@ The `` element captures information about the current status of a t ## Details -* activeTripId - the trip id of the trip the vehicle is actively serving. All trip-specific values will be in reference to this active trip -* blockTripSequence - the index of the active trip into the sequence of trips for the active block. Compare to `blockTripSequence` in the [`` element](arrival-and-departure.html) to determine where the active block location is relative to an arrival-and-departure. -* serviceDate - time, in ms since the unix epoch, of midnight for start of the service date for the trip. -* frequency - information about [frequency based scheduling](frequency.html), if applicable to the trip - *OPTIONAL* -* scheduledDistanceAlongTrip - the distance, in meters, the transit vehicle is scheduled to have progress along the active trip. This is an optional value, and will only be present if the trip is in progress. *OPTIONAL* -* totalDistanceAlongTrip - the total length of the trip, in meters -* position - current position of the transit vehicle. This element is optional, and will only be present if the trip is actively running. If real-time arrival data is available, the position will take that into account, otherwise the position reflects the scheduled position of the vehicle. *OPTIONAL* -* orientation - the orientation of the transit vehicle, as an angle in degrees. Here, 0º is east, 90º is north, 180º is west, and 270º is south. This is an optional value that may be extrapolated from other data. *OPTIONAL* -* closestStop - the id of the closest stop to the current location of the transit vehicle, whether from schedule or real-time predicted location data +* `activeTripId` - the trip id of the trip the vehicle is actively serving. All trip-specific values will be in reference to this active trip +* `blockTripSequence` - the index of the active trip into the sequence of trips for the active block. Compare to `blockTripSequence` in the [`` element](arrival-and-departure.html) to determine where the active block location is relative to an arrival-and-departure. +* `serviceDate` - time, in ms since the unix epoch, of midnight for start of the service date for the trip. +* `frequency` - information about [frequency based scheduling](frequency.html), if applicable to the trip - *OPTIONAL* +* `scheduledDistanceAlongTrip` - the distance, in meters, the transit vehicle is scheduled to have progress along the active trip. This is an optional value, and will only be present if the trip is in progress. *OPTIONAL* +* `totalDistanceAlongTrip` - the total length of the trip, in meters +* `position` - current position of the transit vehicle. This element is optional, and will only be present if the trip is actively running. If real-time arrival data is available, the position will take that into account, otherwise the position reflects the scheduled position of the vehicle. *OPTIONAL* +* `orientation` - the orientation of the transit vehicle, as an angle in degrees. Here, 0º is east, 90º is north, 180º is west, and 270º is south. This is an optional value that may be extrapolated from other data. *OPTIONAL* +* `closestStop` - the id of the closest stop to the current location of the transit vehicle, whether from schedule or real-time predicted location data * closestStopTimeOffset - the time offset, in seconds, from the closest stop to the current position of the transit vehicle among the stop times of the current trip. If the number is positive, the stop is coming up. If negative, the stop has already been passed. -* nextStop and nextStopTimeOffset - these are similar to the existing closestStop and closestStopTimeOffset, except that it always captures the next stop, not the closest stop. Optional, as a vehicle may have progressed past the last stop in a trip. *OPTIONAL* -* occupancyStatus - name() values of GTFS-RT OccupancyStatus enum if available -* phase - the current journey phase of the trip (more docs to come) -* status - status modifiers for the trip (more docs to come) -* predicted - true if we have real-time arrival info available for this trip -* lastUpdateTime - the last known real-time update from the transit vehicle. Will be zero if we haven't heard anything from the vehicle. -* lastLocationUpdateTime - the last known real-time *location* update from the transit vehicle. This is different from `lastUpdateTime` in that it reflects the last know location update. An update from a vehicle might not contain location info, which means this field will not be updated. Will be zero if we haven't had a location update from the vehicle. -* lastKnownLocation - last known location of the transit vehicle. This differs from the existing `position` field, in that the position field is potential extrapolated forward from the last known position and other data. *OPTIONAL* -* lastKnownDistanceAlongTrip - the last known distance along trip value received in real-time from the transit vehicle. *OPTIONAL* -* lastKnownOrientation - the last known orientation value received in real-time from the transit vehicle. *OPTIONAL* -* distanceAlongTrip - the distance, in meters, the transit vehicle has progressed along the active trip. This is an optional value that will only be present if the underlying AVL system supplies it and is potential extrapolated from the last known reading to the current time. -* scheduleDeviation - if real-time arrival info is available, this lists the deviation from the schedule in seconds, where positive number indicates the trip is running late and negative indicates the trips is running early. If not real-time arrival info is available, this will be zero. -* vehicleId - if real-time arrival info is available, this lists the id of the transit vehicle currently running the trip. *OPTIONAL* -* situationIds - references to [`` elements](situation.html), for active service alerts applicable to this trip. *OPTIONAL* +* `nextStop` and `nextStopTimeOffset` - these are similar to the existing closestStop and closestStopTimeOffset, except that it always captures the next stop, not the closest stop. Optional, as a vehicle may have progressed past the last stop in a trip. *OPTIONAL* +* `occupancyStatus` - name() values of GTFS-RT OccupancyStatus enum if available +* `phase` - the current journey phase of the trip (more docs to come) +* `status` - status modifiers for the trip (more docs to come) +* `predicted` - true if we have real-time arrival info available for this trip +* `lastUpdateTime` - the last known real-time update from the transit vehicle. Will be zero if we haven't heard anything from the vehicle. +* `lastLocationUpdateTime` - the last known real-time *location* update from the transit vehicle. This is different from `lastUpdateTime` in that it reflects the last know location update. An update from a vehicle might not contain location info, which means this field will not be updated. Will be zero if we haven't had a location update from the vehicle. +* `lastKnownLocation` - last known location of the transit vehicle. This differs from the existing `position` field, in that the position field is potential extrapolated forward from the last known position and other data. *OPTIONAL* +* `lastKnownDistanceAlongTrip` - the last known distance along trip value received in real-time from the transit vehicle. *OPTIONAL* +* `lastKnownOrientation` - the last known orientation value received in real-time from the transit vehicle. *OPTIONAL* +* `distanceAlongTrip` - the distance, in meters, the transit vehicle has progressed along the active trip. This is an optional value that will only be present if the underlying AVL system supplies it and is potential extrapolated from the last known reading to the current time. +* `scheduleDeviation` - if real-time arrival info is available, this lists the deviation from the schedule in seconds, where positive number indicates the trip is running late and negative indicates the trips is running early. If not real-time arrival info is available, this will be zero. +* `vehicleId` - if real-time arrival info is available, this lists the id of the transit vehicle currently running the trip. *OPTIONAL* +* `situationIds` - references to [`` elements](situation.html), for active service alerts applicable to this trip. *OPTIONAL* diff --git a/src/site/markdown/api/where/elements/vehicle-status.md b/src/site/markdown/api/where/elements/vehicle-status.md index d264ace6be..6a44a4cda5 100644 --- a/src/site/markdown/api/where/elements/vehicle-status.md +++ b/src/site/markdown/api/where/elements/vehicle-status.md @@ -23,11 +23,11 @@ vehicle. ## Details -* vehicledId - the id of the vehicle -* lastUpdateTime - the last known real-time update from the transit vehicle -* lastLocationUpdateTime - the last known real-time update from the transit vehicle containing a location update -* location - the last known location of the vehicle -* tripId - the id of the vehicle's current trip, which can be used to look up the referenced [`` element](trip.html) in the `` section. -* tripStatus - [`` element](trip-status.html), providing additional status information for the vehicle's trip. +* `vehicledId` - the id of the vehicle +* `lastUpdateTime` - the last known real-time update from the transit vehicle +* `lastLocationUpdateTime` - the last known real-time update from the transit vehicle containing a location update +* `location` - the last known location of the vehicle +* `tripId` - the id of the vehicle's current trip, which can be used to look up the referenced [`` element](trip.html) in the `` section. +* `tripStatus` - [`` element](trip-status.html), providing additional status information for the vehicle's trip. A vehicle may not have an actively assigned trip. \ No newline at end of file