SIRI StopMonitoring Call

The SIRI StopMonitoring ("SIRI SM") call allows the developer to request information about the vehicles serving a particular stop.

SIRI StopMonitoring Request

http://api.rideuta.com/SIRI/SIRI.svc/StopMonitor?stopid={StopID}&minutesout={MinutesOut}&onwardcalls={OnwardCalls}&filterroute={FilterRoute}&usertoken={UserToken}

• StopID – The Stop to query. This number can be found on any UTA stop sign (e.g. 133054)
• MinutesOut – The number of minutes away from the stop you want to query. Any vehicle that is this many minutes or less from the stop will be returned. (e.g 30 for 30 minutes or less away)
• OnwardCalls – Determines whether or not the response will include the stops (known as "calls" in SIRI) each vehicle is going to make. To get calls data, use value true, otherwise use value false.
• FilterRoute – Filters the vehicles by a a desired route. This is an optional value if the parameter is left blank all vehicles headed to the queried stop will be included. (e.g. 2 to filter for vehicles servicing route 2)
• Usertoken – your UTA developer API key. Go here to get one.

For Example

Request URI:
http://api.rideuta.com/SIRI/SIRI.svc/StopMonitor?stopid=133054&minutesout=30&onwardcalls=true&filterroute=&usertoken=XXXXXXXXXXX

This request URI is asking for all of the vehicles on route 2 with all of their onward calls. This request results in the following response:

<Siri version="1.3" xmlns="http://www.siri.org.uk/siri">
   <ResponseTimestamp>2011-05-25T14:42:28.413137-06:00</ResponseTimestamp>
   <StopMonitoringDelivery version="1.3">
      <ResponseTimestamp>2011-05-25T14:42:28.413137-06:00</ResponseTimestamp>
      <ValidUntil>2011-05-25T14:42:38.413137-06:00</ValidUntil>
      <MonitoredStopVisit>
         <RecordedAtTime>2011-05-25T14:42:28.413137-06:00</RecordedAtTime>
         <MonitoredVehicleJourney>
            <LineRef>35M</LineRef>
            <DirectionRef>333300</DirectionRef>
            <FramedVehicleJourneyRef>
               <DataFrameRef>2011-05-25T00:00:00-06:00</DataFrameRef>
               <DatedVehicleJourneyRef>1183433</DatedVehicleJourneyRef>
            </FramedVehicleJourneyRef>
            <PublishedLineName>Route 35M (MAX - 3500 SOUTH)</PublishedLineName>
            <OriginRef>1183433|7|3500</OriginRef>
            <DestinationRef>1183433|7|3500</DestinationRef>
            <Monitored>True</Monitored>
            <VehicleLocation>
               <Longitude>-111.98111</Longitude>
               <Latitude>40.69673</Latitude>
            </VehicleLocation>
            <ProgressRate>1</ProgressRate>
            <CourseOfJourneyRef>4537</CourseOfJourneyRef>
            <VehicleRef>08109</VehicleRef>
            <MonitoredCall>
              <StopPointRef>17284</StopPointRef>
              <VisitNumber>1</VisitNumber>
              <VehicleAtStop>false</VehicleAtStop>
              <Extenstions>
                <EstimatedDepartureTime>593</EstimatedDepartureTime>
                <Direction>TO MAGNA</Direction>
                <Distance<6368.0072452773975</Distance>
              </Extenstions>
            </MonitoredCall>
            <Extensions>
               <LastGPSFix>2012-03-13T09:11:42.383</LastGPSFix>
            </Extensions>
         </MonitoredVehicleJourney>
      </MonitoredStopVisit>
   </StopMonitoringDelivery>
</Siri>