[onebusaway] r5509 committed - Edited wiki page SiriApi through web user interface.

7 views
Skip to first unread message

onebu...@googlecode.com

unread,
Feb 19, 2012, 12:44:27 PM2/19/12
to onebusawa...@googlegroups.com
Revision: 5509
Author: bdfe...@onebusaway.org
Date: Sun Feb 19 09:23:20 2012
Log: Edited wiki page SiriApi through web user interface.
http://code.google.com/p/onebusaway/source/detail?r=5509

Modified:
/wiki/SiriApi.wiki

=======================================
--- /wiki/SiriApi.wiki Thu Oct 7 21:08:11 2010
+++ /wiki/SiriApi.wiki Sun Feb 19 09:23:20 2012
@@ -1,184 +1,2 @@
-#summary OneBusAway's new SIRI-inspired RESTful API
-
-= Introduction =
-
-This is OneBusAway's version of the SIRI `VehicleMonitoring` and
`StopMonitoring` calls
-
-= Details =
-
-GTFS refers to the
[https://code.google.com/transit/spec/transit_feed_specification.html
General Transit Feed Specification]. GTFS files for New York City Transit
may be downloaded from [http://httqa.mta.info/developers/ the MTA].
-
-In general, all request and response fields come from the relevant GTFS
fields, if any.
-
-==`StopMonitoring`==
-
-Get all the vehicles which we believe will stop at this stop.
-
-URL: /onebusaway-api-webapp/siri/stop-monitoring.xml?...
-
-Parameters:
-
- * *`key`* a onebusaway api key (required)
- * *`OperatorRef`* the GTFS agency id of the stop to be monitored
(required)
- * *`MonitoringRef`* the GTFS stop id of the stop to be monitored
(required)
- * *`LineRef`* the GTFS route id of the stop to be monitored (optional)
- * *`DirectionRef`* the GTFS direction id (optional)
- * *`StopMonitoringDetailLevel`* Determines whether the response will
include calls (calls) or not (normal) (optional, defaults to normal)
-
-Response:
-{{{
-<Siri version="1.3" xmlns="http://www.siri.org.uk/siri">
- <ServiceDelivery>
- <ResponseTimestamp>2010-09-29T17:01:34-04:00</ResponseTimestamp>
- <StopMonitoringDelivery version="1.3">
- <ResponseTimestamp>2010-09-29T17:01:34-04:00</ResponseTimestamp>
- <ValidUntil>2010-09-29T17:02:34-04:00</ValidUntil>
- <MonitoredStopVisit>
- <RecordedAtTime>1969-12-31T19:00:00-05:00</RecordedAtTime>
- <MonitoringRef>305446</MonitoringRef>
- <MonitoredVehicleJourney>
- <VehicleRef>1243</VehicleRef>
- <LineRef>B63</LineRef>
- <DirectionRef>1</DirectionRef>
- <FramedVehicleJourneyRef>
- <DataFrameRef>2010-09-29</DataFrameRef>
- <DatedVehicleJourneyRef>MTA
NYCT_20100627CC_097600_B63_0002_B63_22</DatedVehicleJourneyRef>
- </FramedVehicleJourneyRef>
- <PublishedLineName>B63 BAY RIDGE SHORE RD via 5
AV</PublishedLineName>
- <OriginRef>306399</OriginRef>
- <DestinationRef>801042</DestinationRef>
- <Monitored>true</Monitored>
- <VehicleLocation>
- <Longitude>-74.00268244792939</Longitude>
- <Latitude>40.65244856462222</Latitude>
- </VehicleLocation>
- <ProgressRate>normalProgress</ProgressRate>
-
<CourseOfJourneyRef>20100627CC_097600_B63_0002_B63_22</CourseOfJourneyRef>
- <MonitoredCall>
- <StopPointRef>305446</StopPointRef>
- <VisitNumber>1</VisitNumber>
- <VehicleAtStop>false</VehicleAtStop>
- <Extensions>
- <Distances>
-
<CallDistanceAlongRoute>11950.636615671945</CallDistanceAlongRoute>
- <DistanceFromCall>1548.281471054488</DistanceFromCall>
- <StopsFromCall>6</StopsFromCall>
- </Distances>
- </Extensions>
- </MonitoredCall>
- <-- only if requested by detail level -->
- <OnwardCalls>
- <OnwardCall>
- <StopPointRef>305447</StopPointRef>
- <VisitNumber>1</VisitNumber>
- <StopPointName>5 AV - 58 ST</StopPointName>
- <Extensions>
- <Distances>
-
<CallDistanceAlongRoute>11230.03234</CallDistanceAlongRoute>
- <DistanceFromCall>1678.661846257255</DistanceFromCall>
- <StopsFromCall>7</StopsFromCall>
- </Distances>
- </Extensions>
- </OnwardCall>
- <OnwardCall>
- <StopPointRef>305448</StopPointRef>
- <VisitNumber>1</VisitNumber>
- <StopPointName>5 AV - 60 ST</StopPointName>
- <Extensions>
- <Distances>
-
<CallDistanceAlongRoute>11538.856</CallDistanceAlongRoute>
- <DistanceFromCall>1844.3512461558557</DistanceFromCall>
- <StopsFromCall>8</StopsFromCall>
- </Distances>
- </Extensions>
- </OnwardCall>
- <!-- more OnwardCall elements -->
- </OnwardCalls>
- </MonitoredVehicleJourney>
- </MonitoredStopVisit>
- <!-- more MonitoredStopVisit elements -->
- </StopMonitoringDelivery>
- </ServiceDelivery>
-</Siri>
-}}}
-
-
-==`VehicleMonitoring`==
-
-Get all (or all up to some server-side limit) the vehicles which match
certain characteristics.
-
-URL: /onebusaway-api-webapp/siri/vehicle-monitoring.xml?...
-
-Parameters:
-
- * *`key`* a onebusaway api key (required)
- * *`OperatorRef`* the GTFS agency id to be monitored (required)
- * *`VehicleRef`* the id of the vehicle to be monitored (optional)
- * *`VehicleJourneyRef`* the GTFS trip id of the trip to be monitored
(optional)
- * *`LineRef`* the GTFS route id of the stop to be monitored (optional)
- * *`DirectionRef`* the GTFS direction id (optional)
- * *`VehicleMonitoringDetailLevel`* Determines whether the response will
include calls (calls) or not (normal) (optional, defaults to normal)
-
-Response:
-{{{
-<Siri version="1.3" xmlns="http://www.siri.org.uk/siri">
- <ServiceDelivery>
- <ResponseTimestamp>2010-09-30T11:01:24-04:00</ResponseTimestamp>
- <VehicleMonitoringDelivery version="1.3">
- <ResponseTimestamp>2010-09-30T11:01:24-04:00</ResponseTimestamp>
- <ValidUntil>2010-09-30T11:02:24-04:00</ValidUntil>
- <VehicleActivity>
- <RecordedAtTime>1969-12-31T19:00:00-05:00</RecordedAtTime>
- <MonitoredVehicleJourney>
- <VehicleRef>1243</VehicleRef>
- <LineRef>B63</LineRef>
- <DirectionRef>0</DirectionRef>
- <FramedVehicleJourneyRef>
- <DataFrameRef>2010-09-30</DataFrameRef>
- <DatedVehicleJourneyRef>MTA
NYCT_20100627CC_059000_B63_0012_B63_9</DatedVehicleJourneyRef>
- </FramedVehicleJourneyRef>
- <PublishedLineName>B63 COBBLE HILL COLUMBIA ST via 5
AV</PublishedLineName>
- <OriginRef>306619</OriginRef>
- <DestinationRef>801041</DestinationRef>
- <Monitored>true</Monitored>
- <VehicleLocation>
- <Longitude>-73.98368008040494</Longitude>
- <Latitude>40.686482662348034</Latitude>
- </VehicleLocation>
- <ProgressRate>normalProgress</ProgressRate>
-
<CourseOfJourneyRef>20100627CC_059000_B63_0012_B63_9</CourseOfJourneyRef>
- <-- only if requested by detail level -->
- <OnwardCalls>
- <OnwardCall>
- <StopPointRef>305394</StopPointRef>
- <VisitNumber>1</VisitNumber>
- <StopPointName>ATLANTIC AV - HOYT ST</StopPointName>
- <Extensions>
- <Distances>
-
<CallDistanceAlongRoute>2231.41243</CallDistanceAlongRoute>
- <DistanceFromCall>354.83895038545234</DistanceFromCall>
- <StopsFromCall>1</StopsFromCall>
- </Distances>
- </Extensions>
- </OnwardCall>
- <OnwardCall>
- <StopPointRef>305395</StopPointRef>
- <VisitNumber>1</VisitNumber>
- <StopPointName>ATLANTIC AV - SMITH ST</StopPointName>
- <Extensions>
- <Distances>
-
<CallDistanceAlongRoute>3354.83895038545234</CallDistanceAlongRoute>
- <DistanceFromCall>553.1214320019662</DistanceFromCall>
- <StopsFromCall>2</StopsFromCall>
- </Distances>
- </Extensions>
- </OnwardCall>
- <!-- more OnwardCall elements -->
- </OnwardCalls>
- </MonitoredVehicleJourney>
- </VehicleActivity>
- <!-- more VehicleActivity elements -->
- </VehicleMonitoringDelivery>
- </ServiceDelivery>
-</Siri>
-}}}
+#labels Deprecated
+Moved to http://bustime.mta.info/wiki/Developers/Index

Reply all
Reply to author
Forward
0 new messages