Public
Documentation Settings
Public
Double Column
cURL - cURL
Ara Broadcast API
Introduction
General principle
Referential
Authentification
SIRI
SIRI Lite
GTFS-RT

Ara Broadcast API

General principle

This API show the SIRI, SIRI-Lite, and GTFS-RT requests supported by Ara SaaS.

Subscriptions are not described here.

Referential

All data is contained in Referentials. It is necessary to specify a referential in all requests.

Authentification

All requests need a partner_token, either in the request body for SIRI requests, or in an Authentification header for SIRI-Lite and GTFS-RT requests.

This token is provided by the data provider.

SIRI

Authentication

The user must specify a credential in the SIRI request in the RequestorRef tag.

Errors

When ARA can't parse a request, it sends SiriErrors with this structure:

xml
<S:Fault>
  <faultcode>Code</faultcode>
  <faultstring>Error text</faultstring>
</S:Fault>

Can't find Referential

Plain Text
faultcode : NotFound
faultstring : Referential not found

Can't unzip a request

Plain Text
faultcode : Client
faultstring : Can't unzip request

SOAP error

It can happen if we can't find the SOAP tags or if the SOAP body is empty

Plain Text
faultcode : Client
faultstring:    Invalid Request: Unable to find body when parsing SOAP request
                Invalid Request: Empty body

Request not supported by ARA

Plain Text
faultcode : NotSupported
faultstring : SIRIRequest [first tag of the SOAP body] not supported

RequestorRef unknown

Plain Text
faultcode : UnknownCredential
faultstring : RequestorRef Unknown

Can't fine a connector for the request

Connectors are defined by the data provider and define what requests are supported.

Plain Text
faultcode : NotFound
faultstring : No Connectors for [SIRI request type]

POSTCheckStatus

https://ara-api.enroute.mobi/test/siri

Check the server status

HEADERS
Content-Type

application/xml

Bodyraw (xml)
xml
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <sw:CheckStatus xmlns:sw="http://wsdl.siri.org.uk" xmlns:siri="http://www.siri.org.uk/siri">
            <Request>
                <siri:RequestTimestamp></siri:RequestTimestamp>
                <siri:RequestorRef>secret</siri:RequestorRef>
                <siri:MessageIdentifier>Test:Message::a0c5cdad-3ddd-459b-95a7-5558b86b0bff:LOC</siri:MessageIdentifier>
            </Request>
            <RequestExtension/>
        </sw:CheckStatus>
    </S:Body>
</S:Envelope>

POSTStopPointsDiscovery

https://ara-api.enroute.mobi/test/siri

Retrieve all Stop Points currently managed

HEADERS
Content-Type

application/xml

Bodyraw (xml)
xml
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    	<sw:StopPointsDiscovery xmlns:sw="http://wsdl.siri.org.uk" xmlns:siri="http://www.siri.org.uk/siri">
			<Request>
				<siri:RequestTimestamp></siri:RequestTimestamp>
				<siri:RequestorRef>secret</siri:RequestorRef>
				<siri:MessageIdentifier>Test:Message::89134adf-c9f6-47a7-8f47-930a3e24a56c:LOC</siri:MessageIdentifier>
			</Request>
			<RequestExtension />
		</sw:StopPointsDiscovery>
    </S:Body>
</S:Envelope>
Loading