Siirry sisältöön

Ero sivun ”ITSFactory siriaccess developerguide” versioiden välillä

ITSFactory siriaccess developerguide (näytä wikiteksti)

Versio 31. lokakuuta 2022 kello 14.38

2 999 merkkiä lisätty ,  31. lokakuuta 2022 kello 14.38
p
POISTETTU http://data.itsfactory.fi/siriaccess/gm/siri - ei toimi
Ei muokkausyhteenvetoa
p (POISTETTU http://data.itsfactory.fi/siriaccess/gm/siri - ei toimi)
 
(23 välissä olevaa versiota 2 käyttäjän tekeminä ei näytetä)
Rivi 1: Rivi 1:
<div style="border: solid 1px; padding: 5px">The url of JSON API has changed to better reflect the nature of the interface (JSON instead of REST). <br>
ITS Factory supports following SIRI modules:
The new url is: http://data.itsfactory.fi/siriaccess/vm/json <br>
* Vehicle Monitoring, VM (Currently available)
The old url http://data.itsfactory.fi/siriaccess/vm/rest will continue to work but new clients are encouraged to use the new url.
* General Messages, GM (Currently available)
</div>


ITS Factory SIRI Access responds to requests in urls:
== SIRI Vehicle Monitoring ==
* http://data.itsfactory.fi/siriaccess/vm/siri (SIRI XML documents over HTTP POST)
SIRI vehicle monitoring, or VM, offers real-time location related information on monitored vehicles (buses). 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.
 
URLs:
* http://data.itsfactory.fi/siriaccess/vm/json (SIRI JSON documents over HTTP GET)
* http://data.itsfactory.fi/siriaccess/vm/json (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


==== Requests ====
==== Requests ====
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:
To communicate with Vehicle Monitoring 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:


<pre>
<pre>
Rivi 59: Rivi 50:


==== Responses ====
==== Responses ====
Following response is an example of data collected from vehicle (bus) TKL_248 operating on line 30.  
Following response is an example of vehicle monitoring data collected from vehicle (bus) TKL_248 operating on line 30.  
<pre>
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
Rivi 112: Rivi 103:


=== SIRI JSON documents over HTTP GET ===
=== SIRI JSON documents over HTTP GET ===
Rest access responds to HTTP GET requests and returns JSON formatted textual data. The data itself is structured and named like standard SIRI XML responses (it is just converted from SIRI XML to JSON notation). This allows the client avoid XML request parsing which is typically cumbersome for example to JavaScript clients.


==== Requests ====
<b><font color=red>NEW!</font></b>
 
* '''Please note!''' This SIRI VM JSON interface is superceeded by http://wiki.itsfactory.fi/index.php/Journeys_API#Vehicle_Activity . This interface will remain in use until it is eventually removed in the future. SIRI GM interface continues its operation.
 
JSON access responds to HTTP GET requests and returns JSON formatted textual data. The data itself is structured and named like standard SIRI XML responses (it is just converted from SIRI XML to JSON notation). This allows the client avoid XML request parsing which is typically cumbersome for example to JavaScript clients.
 
==== Requests ====  
To access the SIRI vehicle monitoring client must send HTTP GET requests to http://data.itsfactory.fi/siriaccess/vm/json
To access the SIRI vehicle monitoring client must send HTTP GET requests to http://data.itsfactory.fi/siriaccess/vm/json


Rivi 190: Rivi 186:
</pre>
</pre>


The fields and the response structure is similar than the earlier presented XML response. Please check the XML response for few field descriptions.
== SIRI General Messages ==
SIRI general messages, or GM, offers periodic message-style updates on events occurring in the public transport network, such as information about service disruptions or route changes. 
URLs:
* http://data.itsfactory.fi/siriaccess/gm/json (SIRI JSON documents over HTTP GET)
=== SIRI XML documents over HTTP POST ===
==== Requests ====
<pre>
<?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>
                        <RequestTimestamp>2012-06-11T09:30:50-03:00</RequestTimestamp>
                        <GeneralMessageRequest version="1.3">
                                    <RequestTimestamp>2012-06-11T09:30:50-03:00</RequestTimestamp>
                        </GeneralMessageRequest>         
            </ServiceRequest>
</Siri>
</pre>
==== Responses ====
Following is a response for general message request:
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Siri version="1.3" xmlns="http://www.siri.org.uk/siri" xmlns:ns2="http://www.ifopt.org.uk/acsb" xmlns:ns3="http://www.ifopt.org.uk/ifopt" xmlns:ns4="http://datex2.eu/schema/1_0/1_0">
  <ServiceDelivery>
      <ResponseTimestamp>2013-04-24T10:20:19.195+03:00</ResponseTimestamp>
      <ProducerRef>IJ2010</ProducerRef>
      <Status>true</Status>
      <MoreData>false</MoreData>
      <GeneralMessageDelivery version="1.3">
        <ResponseTimestamp>2013-04-24T10:20:19.195+03:00</ResponseTimestamp>
        <Status>true</Status>
        <GeneralMessage formatRef="string">
            <RecordedAtTime>2011-09-20T00:00:00+03:00</RecordedAtTime>
            <InfoMessageIdentifier>307</InfoMessageIdentifier>
            <InfoMessageVersion>1</InfoMessageVersion>
            <InfoChannelRef>errors</InfoChannelRef>
            <ValidUntilTime>2011-09-20T23:59:00+03:00</ValidUntilTime>
            <Content xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Hämeensilta poikki</Content>
        </GeneralMessage>
        <GeneralMessage formatRef="string">
            <RecordedAtTime>2011-09-20T00:00:00+03:00</RecordedAtTime>
            <InfoMessageIdentifier>308</InfoMessageIdentifier>
            <InfoMessageVersion>3</InfoMessageVersion>
            <InfoChannelRef>warnings</InfoChannelRef>
            <ValidUntilTime>2011-09-20T23:59:00+03:00</ValidUntilTime>
            <Content xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Vappukulkue hidastaa linjojen 13 23 etenemistä</Content>
        </GeneralMessage>
      </GeneralMessageDelivery>
  </ServiceDelivery>
</Siri>
</pre>
The response is quite straightforward:
* InfoChannelRef tells if this message is either error, warning or message
* Content contains the actual message data
=== SIRI JSON documents over HTTP GET ===
==== Requests ====
To access the SIRI general messages client would send following request to http://data.itsfactory.fi/siriaccess/gm/json
The URL supports following parameters
* indent=<yes|no>
==== Responses ====
The fields and the response structure is similar than the earlier presented XML response. Please check the XML response for few field descriptions.
The fields and the response structure is similar than the earlier presented XML response. Please check the XML response for few field descriptions.
Noudettu kohteesta ”https://wiki.itsfactory.fi/index.php/Toiminnot:MobileDiff/1210...1960”