Service Messages
The service messages call returns the current service messages for stops.
Each service message record includes the message description and the IDs of the affected routes.
Call format
| Part | Description | Optional | Example |
| URL | TransiCast web server instance URL | http://transicast.appspot.com/ws/V1 | |
| Servlet descriptor | detours | detours | |
| Parameter: agency=<agency name> | Agency name, as provided by the agencies call | agency=WMATA | |
| Parameter: locid=<stop id, ... > | Comma separated list of stop IDs, as provided by the stops call | locid=5017 | |
| Parameter: routes=<route id, ... > | Comma separated list of Route IDs, as provided by the route list call | route=28 |
http://transicast.appspot.com/ws/V1/detours?agency=WMATA&locId=5017&routes=Yellow&appid=sample5
Response format
Individual messages are returned through the <detour> tag. It contains the following attributes:
| Attribute | Description | Key | Used in | Example |
| desc | Message description | desc="Due to a street closure, Stop ID 7751 on SW 6th at Burnside will not be served. A temporary stop is located on NW Broadway between Couch and Davis." | ||
| begin | Message begin time | desc="1309856400000" | ||
| end | Message end time | desc="1341568800000" | ||
| id | Message ID | desc="23184" | ||
| phonetic | Text-to-speech friendly message description | phonetic="Due to a street closure, Stop ID 7751 on SW 6th at Burnside will not be served. A temporary stop is located on NW Broadway between Kooch and Davis." |
Each message contains <route> tags which identify the affected routes by route ID. It contains the following attributes:
| Attribute | Description | Key | Used in | Example |
| desc | Route description | desc="35-Macadam/Greeley" | ||
| route | Route ID | Route list, as key value | desc="35" | |
| type | Message type: B=Bus, R=Rail | type="B" |
<?xml version="1.0" encoding="UTF-8"?>
<resultSet queryTime="1319389595177" ct="4">
<detour desc="Blue Line: Trains are single tracking btwn Stadium-Armory & Addison Rd due to scheduled track maintenance. Expect delays in both directions.">
<route desc="Blue" route="Blue"/></detour>
<detour desc="Red Line: Thru closing Sun. Oct. 23rd, buses replace trains btwn Ft. Totten and N.Y. Ave. stations. Shuttle svc is provided.">
<route desc="Red" route="Red"/></detour>
<detour desc="Red Line: Thru closing Sun. Oct. 23rd, Rhode Island Ave & Brookland stations are closed for track maintenance. Shuttle svc is provided.">
<route desc="Red" route="Red"/></detour>
<detour desc="Green Line: Trains are single tracking btwn Fort Totten & PG Plaza due to scheduled track maintenance. Expect delays in both directions.">
<route desc="Green" route="Green"/></detour>
</resultSet>
Notes
- • At this time, content for begin, end, id, phonetic, route and type are provided by TriMet (Portland) only
- • Not all original feeds support routes as a query parameter for service messages. In the aggregate, TransiCast / Rasa does not require the routes parameter. As original feeds may not need this parameter, and return service messages for all routes, TransiCast / Rasa directly returns the content of the original feed, including service messages for routes that may not have been requested in the call. It is recommended to include the routes parameter, as some original feeds return error messages when routes are not provided as part of their calls
- • Original feeds that support calls by route do not require the locIDs parameter
Contact
By email  
| © 2011, 2012 Joachim Pfeiffer |
|
