GTFS Realtime - Service Alerts - Yarra Trams
GTFS Realtime Yarra Trams Service Alerts data feed provides real time information about disruptions affecting tram services including cancellations or unforeseen events affecting a stop, route or the entire network in Melbourne, Victoria. Note: This API endpoint has a rate limit of 20-27 calls per minute (depending on the data size) and caching time of 30 seconds. To obtain an 'API Key' please continue to signup using our Data Exchange Platform (https://data-exchange.vicroads.vic.gov.au/).
There are no views created for this resource yet.
Data Dictionary
| Field Name | Name | Type | Description | Fixed Values |
|---|---|---|---|---|
| header | Feed Header | FeedHeader() | Metadata about a feed, included in feed messages. | |
| entity | Feed Entity | FeedEntity() | A definition (or update) of an entity in the transit feed. If the entity is not being deleted, exactly one of trip_update, vehicle, and alert fields should be populated. This field can be repeated as many times as needed. | |
| header.gtfs_realtime_version | GTFS Realtime Version | STRING() | Version of the feed specification. The current version is 2.0. | |
| header.incrementality | Incrementality | ENUM() | Determines whether the current fetch is incremental. Options include: -FULL_DATASET: this feed update will overwrite all preceding realtime information for the feed. Thus this update is expected to provide a full snapshot of all known realtime information. -DIFFERENTIAL: currently, this mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized. |
FULL_DATASET, DIFFERENTIAL |
| header.timestamp | Feed Header Timestamp | int64() | This timestamp identifies the moment when the content of this feed has been created (in server time). In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). To avoid time skew between systems producing and consuming realtime information it is strongly advised to derive timestamp from a time server. It is completely acceptable to use Stratum 3 or even lower strata servers since time differences up to a couple of seconds are tolerable. | |
| entity.id | Feed Entity ID | STRING() | Feed-unique identifier for this entity. The ids are used only to provide incrementality support. The actual entities referenced by the feed must be specified by explicit selectors (see EntitySelector below for more info). | |
| entity.is_deleted | Feed Entity Is Deleted | BOOLEAN() | Whether this entity is to be deleted. Should be provided only for feeds with Incrementality of DIFFERENTIAL - this field should NOT be provided for feeds with Incrementality of FULL_DATASET. | |
| entity.alert | Feed Entity Alert | Alert() | An alert, indicating some sort of incident in the public transit network. | |
| alert.active_period.start | Alert Active Period Start | int64() | Start time, in POSIX time (i.e., number of seconds since January 1st, 1970 00:00:00 UTC). If missing, the interval starts at minus infinity. If a TimeRange is provided, either start or end must be provided - both fields cannot be empty. | |
| alert.informed_entity | Alert Informed Entity | EntitySelector() | Entities whose users we should notify of this alert. At least one informed_entity must be provided. This field can be repeated as many times as needed. | |
| alert.cause | Alert Cause | ENUM() | Cause of this alert. Options include: -UNKNOWN_CAUSE -OTHER_CAUSE -TECHNICAL_PROBLEM -STRIKE -DEMONSTRATION -ACCIDENT -HOLIDAY -WEATHER -MAINTENANCE -CONSTRUCTION -POLICE_ACTIVITY -MEDICAL_EMERGENCY |
UNKNOWN_CAUSE, OTHER_CAUSE, TECHNICAL_PROBLEM, STRIKE, DEMONSTRATION, ACCIDENT, HOLIDAY, WEATHER, MAINTENANCE, CONSTRUCTION, POLICE_ACTIVITY, MEDICAL_EMERGENCY |
| alert.effect | Alert Effect | ENUM() | The effect of this problem on the affected entity. Options include: -NO_SERVICE -REDUCED_SERVICE -SIGNIFICANT_DELAYS -DETOUR -ADDITIONAL_SERVICE -MODIFIED_SERVICE -OTHER_EFFECT -UNKNOWN_EFFECT -STOP_MOVED |
NO_SERVICE, REDUCED_SERVICE, SIGNIFICANT_DELAYS, DETOUR, ADDITIONAL_SERVICE, MODIFIED_SERVICE, OTHER_EFFECT, UNKNOWN_EFFECT, STOP_MOVED, NO_EFFECT, ACCESSIBILITY_ISSUE |
| alert.url | Alert URL | TranslatedString() | The URL which provides additional information about the alert. | |
| alert.header_text | Alert Header Text | TranslatedString() | Header for the alert. This plain-text string will be highlighted, for example in boldface. | |
| alert.severity | Alert Severity | () | The severity of the alert | UNKNOWN_SEVERITY, INFO, WARNING, SEVERE |
| alert.informed_entity.route_id | Alert Informed Entity Route ID | STRING() | The route_id from the GTFS that this selector refers to. If direction_id is provided, route_id must also be provided. | |
| alert.informed_entity.trip | Alert Informed Entity Trip | TripDescriptor() | The trip instance from the GTFS that this selector refers to. This TripDescriptor must resolve to a single trip instance in the GTFS data (e.g., a producer cannot provide only a trip_id for exact_times=0 trips). If the ScheduleRelationship field is populated within this TripDescriptor it will be ignored by consumers when attempting to identify the GTFS trip. | |
| alert.informed_entity.trip.trip_id | Alert Informed Entity Trip ID | STRING() | The trip_id from the GTFS feed that this selector refers to. Whether trip_id is required depends on the type of trip: - Non-frequency-based trips: The trip_id field alone is enough to uniquely identify these trips. Note that non-frequency-based trips aren't defined in GTFS frequencies.txt. - Frequency-based trips: The trip_id, start_time, and start_date fields are all required. Frequency-based trips are defined in GTFS frequencies.txt. - Schedule-based trips: The trip_id field can be omitted only if the trip can be uniquely identified by a combination of the provided route_id, direction_id, start_time, and start_date fields. Note that scheduled-based trips aren't defined in GTFS frequencies.txt. |
|
| alert.header_text.translation | Alert Description Text Translation | Translation() | A localized string mapped to a language. This field can be repeated as many times as needed. | |
| alert.header_text.translation.text | Alert Description Text Translation Text | STRING() | A UTF-8 string containing the message. | |
| alert.header_text.translation.language | Alert Description Text Translation Language | STRING() | BCP-47 language code. Can be omitted if the language is unknown or if no internationalization is done at all for the feed. At most one translation is allowed to have an unspecified language tag - if there is more than one translation, the language must be provided. | |
| alert.active_period | Alert Active Period | TIMERANGE() | Time when the alert should be shown to the user. If missing, the alert will be shown as long as it appears in the feed. If multiple ranges are given, the alert will be shown during all of them. This field can be repeated as many times as needed. |
Additional Information
| Field | Value |
|---|---|
| Data last updated | 16 November 2024 |
| Metadata last updated | 21 November 2024 |
| Created | 16 November 2024 |
| Format | API |
| License | Creative Commons Attribution 4.0 International |
| Api url | https://data-exchange-api.vicroads.vic.gov.au/opendata/gtfsr/v1/tram/servicealert |
| Attributes | [{"attribute_display_order_id": 1, "db_format": "FeedHeader()", "db_name": "header", "definition": "Metadata about a feed, included in feed messages.", "fixed_values": "", "id": "1378", "name": "Feed Header", "ref_number": "AT-1378"}, {"attribute_display_order_id": 2, "db_format": "FeedEntity()", "db_name": "entity", "definition": "A definition (or update) of an entity in the transit feed. If the entity is not being deleted, exactly one of trip_update, vehicle, and alert fields should be populated. This field can be repeated as many times as needed.", "fixed_values": "", "id": "1379", "name": "Feed Entity", "ref_number": "AT-1379"}, {"attribute_display_order_id": 3, "db_format": "STRING()", "db_name": "header.gtfs_realtime_version", "definition": "Version of the feed specification. The current version is 2.0.", "fixed_values": "", "id": "1380", "name": "GTFS Realtime Version", "ref_number": "AT-1380"}, {"attribute_display_order_id": 4, "db_format": "ENUM()", "db_name": "header.incrementality", "definition": "<p>Determines whether the current fetch is incremental. Options include:</p>\n<p>-FULL_DATASET: this feed update will overwrite all preceding realtime information for the feed. Thus this update is expected to provide a full snapshot of all known realtime information.</p>\n<p>-DIFFERENTIAL: currently, this mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized.</p>", "fixed_values": "FULL_DATASET, DIFFERENTIAL", "id": "1381", "name": "Incrementality", "ref_number": "AT-1381"}, {"attribute_display_order_id": 5, "db_format": "int64()", "db_name": "header.timestamp", "definition": "This timestamp identifies the moment when the content of this feed has been created (in server time). In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). To avoid time skew between systems producing and consuming realtime information it is strongly advised to derive timestamp from a time server. It is completely acceptable to use Stratum 3 or even lower strata servers since time differences up to a couple of seconds are tolerable.", "fixed_values": "", "id": "1382", "name": "Feed Header Timestamp", "ref_number": "AT-1382"}, {"attribute_display_order_id": 6, "db_format": "STRING()", "db_name": "entity.id", "definition": "Feed-unique identifier for this entity. The ids are used only to provide incrementality support. The actual entities referenced by the feed must be specified by explicit selectors (see EntitySelector below for more info).", "fixed_values": "", "id": "1383", "name": "Feed Entity ID", "ref_number": "AT-1383"}, {"attribute_display_order_id": 7, "db_format": "BOOLEAN()", "db_name": "entity.is_deleted", "definition": "Whether this entity is to be deleted. Should be provided only for feeds with Incrementality of DIFFERENTIAL - this field should NOT be provided for feeds with Incrementality of FULL_DATASET.", "fixed_values": "", "id": "1384", "name": "Feed Entity Is Deleted", "ref_number": "AT-1384"}, {"attribute_display_order_id": 8, "db_format": "Alert()", "db_name": "entity.alert", "definition": "An alert, indicating some sort of incident in the public transit network.", "fixed_values": "", "id": "1385", "name": "Feed Entity Alert", "ref_number": "AT-1385"}, {"attribute_display_order_id": 9, "db_format": "int64()", "db_name": "alert.active_period.start", "definition": "Start time, in POSIX time (i.e., number of seconds since January 1st, 1970 00:00:00 UTC). If missing, the interval starts at minus infinity. If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.", "fixed_values": "", "id": "1387", "name": "Alert Active Period Start", "ref_number": "AT-1387"}, {"attribute_display_order_id": 10, "db_format": "EntitySelector()", "db_name": "alert.informed_entity", "definition": "Entities whose users we should notify of this alert. At least one informed_entity must be provided. This field can be repeated as many times as needed.", "fixed_values": "", "id": "1389", "name": "Alert Informed Entity", "ref_number": "AT-1389"}, {"attribute_display_order_id": 11, "db_format": "ENUM()", "db_name": "alert.cause", "definition": "<p>Cause of this alert. Options include:</p>\n<p>-UNKNOWN_CAUSE</p>\n<p>-OTHER_CAUSE</p>\n<p>-TECHNICAL_PROBLEM</p>\n<p>-STRIKE</p>\n<p>-DEMONSTRATION</p>\n<p>-ACCIDENT</p>\n<p>-HOLIDAY</p>\n<p>-WEATHER</p>\n<p>-MAINTENANCE</p>\n<p>-CONSTRUCTION</p>\n<p>-POLICE_ACTIVITY</p>\n<p>-MEDICAL_EMERGENCY</p>", "fixed_values": "UNKNOWN_CAUSE, OTHER_CAUSE, TECHNICAL_PROBLEM, STRIKE, DEMONSTRATION, ACCIDENT, HOLIDAY, WEATHER, MAINTENANCE, CONSTRUCTION, POLICE_ACTIVITY, MEDICAL_EMERGENCY", "id": "1402", "name": "Alert Cause", "ref_number": "AT-1402"}, {"attribute_display_order_id": 12, "db_format": "ENUM()", "db_name": "alert.effect", "definition": "<p>The effect of this problem on the affected entity. Options include:</p>\n<p>-NO_SERVICE</p>\n<p>-REDUCED_SERVICE</p>\n<p>-SIGNIFICANT_DELAYS</p>\n<p>-DETOUR</p>\n<p>-ADDITIONAL_SERVICE</p>\n<p>-MODIFIED_SERVICE</p>\n<p>-OTHER_EFFECT</p>\n<p>-UNKNOWN_EFFECT</p>\n<p>-STOP_MOVED</p>", "fixed_values": "NO_SERVICE, REDUCED_SERVICE, SIGNIFICANT_DELAYS, DETOUR, ADDITIONAL_SERVICE, MODIFIED_SERVICE, OTHER_EFFECT, UNKNOWN_EFFECT, STOP_MOVED, NO_EFFECT, ACCESSIBILITY_ISSUE", "id": "1403", "name": "Alert Effect", "ref_number": "AT-1403"}, {"attribute_display_order_id": 13, "db_format": "TranslatedString()", "db_name": "alert.url", "definition": "The URL which provides additional information about the alert.", "fixed_values": "", "id": "1404", "name": "Alert URL", "ref_number": "AT-1404"}, {"attribute_display_order_id": 14, "db_format": "TranslatedString()", "db_name": "alert.header_text", "definition": "Header for the alert. This plain-text string will be highlighted, for example in boldface.", "fixed_values": "", "id": "1408", "name": "Alert Header Text", "ref_number": "AT-1408"}, {"attribute_display_order_id": 16, "db_format": "()", "db_name": "alert.severity", "definition": "The severity of the alert", "fixed_values": "UNKNOWN_SEVERITY, INFO, WARNING, SEVERE", "id": "7558", "name": "Alert Severity", "ref_number": "AT-7558"}, {"attribute_display_order_id": 17, "db_format": "STRING()", "db_name": "alert.informed_entity.route_id", "definition": "The route_id from the GTFS that this selector refers to. If direction_id is provided, route_id must also be provided.", "fixed_values": "", "id": "1391", "name": "Alert Informed Entity Route ID", "ref_number": "AT-1391"}, {"attribute_display_order_id": 18, "db_format": "TripDescriptor()", "db_name": "alert.informed_entity.trip", "definition": "The trip instance from the GTFS that this selector refers to. This TripDescriptor must resolve to a single trip instance in the GTFS data (e.g., a producer cannot provide only a trip_id for exact_times=0 trips). If the ScheduleRelationship field is populated within this TripDescriptor it will be ignored by consumers when attempting to identify the GTFS trip.", "fixed_values": "", "id": "1394", "name": "Alert Informed Entity Trip", "ref_number": "AT-1394"}, {"attribute_display_order_id": 19, "db_format": "STRING()", "db_name": "alert.informed_entity.trip.trip_id", "definition": "<p>The trip_id from the GTFS feed that this selector refers to. Whether trip_id is required depends on the type of trip:</p>\n<p>- Non-frequency-based trips: The trip_id field alone is enough to uniquely identify these trips. Note that non-frequency-based trips aren't defined in GTFS frequencies.txt.</p>\n<p>- Frequency-based trips: The trip_id, start_time, and start_date fields are all required. Frequency-based trips are defined in GTFS frequencies.txt.</p>\n<p>- Schedule-based trips: The trip_id field can be omitted only if the trip can be uniquely identified by a combination of the provided route_id, direction_id, start_time, and start_date fields. Note that scheduled-based trips aren't defined in GTFS frequencies.txt.</p>", "fixed_values": "", "id": "1395", "name": "Alert Informed Entity Trip ID", "ref_number": "AT-1395"}, {"attribute_display_order_id": 20, "db_format": "Translation()", "db_name": "alert.header_text.translation", "definition": "A localized string mapped to a language. This field can be repeated as many times as needed.", "fixed_values": "", "id": "1413", "name": "Alert Description Text Translation", "ref_number": "AT-1413"}, {"attribute_display_order_id": 21, "db_format": "STRING()", "db_name": "alert.header_text.translation.text", "definition": "A UTF-8 string containing the message.", "fixed_values": "", "id": "1414", "name": "Alert Description Text Translation Text", "ref_number": "AT-1414"}, {"attribute_display_order_id": 22, "db_format": "STRING()", "db_name": "alert.header_text.translation.language", "definition": "BCP-47 language code. Can be omitted if the language is unknown or if no internationalization is done at all for the feed. At most one translation is allowed to have an unspecified language tag - if there is more than one translation, the language must be provided.", "fixed_values": "", "id": "1415", "name": "Alert Description Text Translation Language", "ref_number": "AT-1415"}, {"attribute_display_order_id": 23, "db_format": "TIMERANGE()", "db_name": "alert.active_period", "definition": "Time when the alert should be shown to the user. If missing, the alert will be shown as long as it appears in the feed. If multiple ranges are given, the alert will be shown during all of them. This field can be repeated as many times as needed.", "fixed_values": "", "id": "1386", "name": "Alert Active Period", "ref_number": "AT-1386"}] |
| Datastore active | False |
| Datastore contains all records of source file | False |
| Filesize | 2,365 |
| Has views | False |
| Historical | False |
| Id | 269e2a55-914c-432f-8781-31dc4a86a2ce |
| Last updated date | 1 day ago |
| Mimetype | application/json |
| Open dataset title | GTFS Realtime - Service Alerts - Yarra Trams |
| Package id | 5516be75-c5ea-4b9b-a82c-f7c1f1eec4bc |
| Position | 1 |
| Publication date | 1 year ago |
| State | active |
| Filesize | 2.3 KB |
| Release Date | |
| Temporal Coverage Start | |
| Temporal Coverage End | |
| Data Quality Statement | |
| Attribution Statement |