ITSFactory siriaccess developerguide

During its beta phase, the ITS Factory SIRI Access responds to requests in urls:

http://178.217.134.37:8080/siriaccess/vm/siri (SIRI XML documents over HTTP POST)
http://178.217.134.37:8080/siriaccess/vm/rest (SIRI JSON documents over HTTP GET)

Both URLs will support following SIRI modules:

Vehicle Monitoring, VM (Currently available in beta phase)
General Messaging, GM (Currently not available, planned)

Vehicle Monitoring

SIRI vehicle monitoring, or VM, offers real-time location related information on monitored vehicles (busses). A client can request information on all active vehicles or limit its request to certain bus line or vehicle. The data contains the current state of vehicle transit, history data is not currently available.

SIRI XML documents over HTTP POST

The URL supports standard SIRI XML document exchange as defined in http://www.kizoom.com/standards/siri/, the SIRI version is 1.3 as defined in http://www.kizoom.com/standards/siri/schema/1.3/siri.xsd

To communicate with this URL, the client must send XML formatted SIRI requests via HTTP POST. The server will response with proper SIRI XML response. SIRI Subscriptions are not supported by this URL. A minimalist request to access all vehicle monitoring data is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.3" 
  xsi:schemaLocation="http://www.kizoom.com/standards/siri/schema/1.3/siri.xsd">
	<ServiceRequest>
			<VehicleMonitoringRequest version="1.3">
				<VehicleMonitoringRef>VEHICLES_ALL</VehicleMonitoringRef>
			</VehicleMonitoringRequest>
	</ServiceRequest>
</Siri>

To access vehicle monitoring data for certain line, a minimalist request would be:

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.3" 
	xsi:schemaLocation="http://www.kizoom.com/standards/siri/schema/1.3/siri.xsd">
	<ServiceRequest>
			<VehicleMonitoringRequest version="1.3">
				<LineRef>23</LineRef>
			</VehicleMonitoringRequest>
	</ServiceRequest>
</Siri>

To access vehicle monitoring data for certain vehicle, a minimalist request would be:

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.3" 
	xsi:schemaLocation="http://www.kizoom.com/standards/siri/schema/1.3/siri.xsd">
	<ServiceRequest>
			<VehicleMonitoringRequest version="1.3">
				<VehicleRef>TKL_123</VehicleRef>
			</VehicleMonitoringRequest>
	</ServiceRequest>
</Siri>

SIRI JSON documents over HTTP GET

Rest access responds to HTTP GET requests and returns JSON formatted textual data. This allows the client avoid XML request parsing which is typically cumbersome for example to JavaScript clients.

To access the SIRI vehicle monitoring client must send HTTP GET requests to http://178.217.134.37:8080/siriaccess/vm/rest

The URL supports following parameters

lineRef=<string>
vehicleRef=<string>
indent=<yes|no>

Url examples

http://178.217.134.37:8080/siriaccess/vm/rest returns data for all vehicles
http://178.217.134.37:8080/siriaccess/vm/rest?lineRef=22 returns data for all vehicles currently operating on specified line
http://178.217.134.37:8080/siriaccess/vm/rest?vehicleRef=paunu_155 returns data for specified vehicle
http://178.217.134.37:8080/siriaccess/vm/rest?indent=yes returns data in human readable format, indent parameter works also in conjunction with lineRef and vehicleRef parameters