iRail Belgium Connector - Ismena website

info@ismena.com

iRail Belgium Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The iRail Belgium Connector facilitates seamless integration with the iRail Belgium API, providing access to Belgian railway data including stations, liveboards, connections, vehicle information, train compositions, disturbances, and logs. This connector acts as a proxy to streamline data retrieval, supporting actions for querying train schedules, real-time updates, and feedback submission. This supports JSON and XML response formats.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the iRail Belgium Connector.
Supported Integration Action Points

getStations: Retrieve a list of stations.
getLiveboard: Retrieve liveboard information for a station.
getConnections: Retrieve routes between two stations.
getVehicle: Retrieve vehicle (train) information.
getComposition: Retrieve train composition details.
getDisturbances: Retrieve current rail network disturbances.
postFeedback: Submit occupancy feedback for a train.
getLogs: Retrieve recent log entries.

Detailed Integration Documentation

2.1 Get Stations Retrieval

Action	getStations
Purpose	Retrieves a list of Belgian railway stations with details like IDs, names, and locations. This serves as the primary entry point for accessing station data, useful for building route planning interfaces.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: None Optional: format: Response format (string, enum: [xml, json, jsonp], default: xml). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: version: API version (string). timestamp: Response timestamp (number). station: Array of station objects (id, locationX, locationY, standardname, name). Failure: Returns error details (e.g., 500: Internal server error).
Workflow Example	Configure the connector with the appropriate base URL. Execute the `getStations` action with optional `format=json`. Process the response to populate a station selection list.

2.2 Get Liveboard Retrieval

Action	getLiveboard
Purpose	Retrieves liveboard data for a station, including departures or arrivals with delays, platforms, and occupancy. This helps users monitor real-time train information.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: station: Station name (string, e.g., Gent-Sint-Pieters). Optional: id: Station ID (string, e.g., BE.NMBS.008892007). arrdep: Arrivals or departures (string, enum: [departure, arrival], default: departure). date: Date in ddmmyy (string, e.g., 300917). time: Time in hhmm (string, e.g., 1230). alerts: Include alerts (boolean, default: false). format: Response format (string, enum: [xml, json, jsonp], default: xml). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: version: API version (string). timestamp: Response timestamp (number). station: Station name (string). stationinfo: Station details (object). departures: Departures object with number and departure array (id, delay, station, time, etc.). Failure: Returns error details (e.g., 500: Internal server error).
Workflow Example	Execute the `getLiveboard` action with `station=Gent-Sint-Pieters` and `arrdep=departure`. Review the response to display real-time departures. Use the data for travel monitoring applications.

2.3 Get Connections Retrieval

Action	getConnections
Purpose	Retrieves route connections between two stations, including durations, vias, and real-time delays. This enables route planning with transport options.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: from: Departure station name or ID (string, e.g., Gent-Sint-Pieters). to: Arrival station name or ID (string, e.g., Mechelen). Optional: timesel: Time selection (string, enum: [departure, arrival], default: departure). typeOfTransport: Transport types (string, enum: [automatic, trains, nointernationaltrains, all], default: automatic). date: Date in ddmmyy (string, e.g., 300917). time: Time in hhmm (string, e.g., 1230). alerts: Include alerts (boolean, default: false). results: Number of results (integer, default: 6). format: Response format (string, enum: [xml, json, jsonp], default: xml). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: version: API version (string). timestamp: Response timestamp (number). connection: Array of connection objects (id, departure, arrival, duration, vias, alerts). Failure: Returns error details (e.g., 400: Bad request).
Workflow Example	Execute the `getConnections` action with `from=Gent-Sint-Pieters` and `to=Mechelen`. Save the route details for planning. Use the data for travel apps or logistics.

2.4 Get Vehicle Retrieval

Action	getVehicle
Purpose	Retrieves information about a specific train vehicle, including stops, delays, and current location. This supports detailed train tracking.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: id: Vehicle ID (string, e.g., BE.NMBS.IC1832). Optional: date: Date in ddmmyy (string, e.g., 300917). alerts: Include alerts (boolean, default: false). format: Response format (string, enum: [xml, json, jsonp], default: xml). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: version: API version (string). timestamp: Response timestamp (number). vehicle: Vehicle name (string). vehicleinfo: Vehicle details (object). stops: Stops object with number and stop array (id, station, time, delay, etc.). Failure: Returns error details (e.g., 404: Not found).
Workflow Example	Execute the `getVehicle` action with `id=BE.NMBS.IC1832`. Process the response to track the train. Integrate the data into monitoring tools.

2.5 Get Composition Retrieval

Action	getComposition
Purpose	Retrieves the composition of a train, including carriages and locomotives with properties like toilets and outlets. This provides detailed train setup information.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: id: Train ID (string, e.g., S51507). Optional: format: Response format (string, enum: [xml, json, jsonp], default: xml). data: Include all raw data (string, enum: ['', all], default: ''). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: segments: Array of segment objects (origin, destination, units with materialType, hasToilets, etc.). Failure: Returns error details (e.g., 404: Not found).
Workflow Example	Execute the `getComposition` action with `id=S51507`. Review the train composition details. Use the data for accessibility or planning applications.

2.6 Get Disturbances Retrieval

Action	getDisturbances
Purpose	Retrieves current disturbances on the rail network, including scheduled works and unscheduled issues. This supports network status monitoring.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: None Optional: lineBreakCharacter: Line break character (string, default: ''). format: Response format (string, enum: [xml, json, jsonp], default: xml). lang: Language for names (string, enum: [nl, fr, en, de], default: en).
Output	Successful: Returns a JSON or XML object with: version: API version (string). timestamp: Response timestamp (number). disturbance: Array of disturbance objects (id, title, description, link, timestamp). Failure: Returns error details (e.g., 500: Internal server error).
Workflow Example	Execute the `getDisturbances` action with optional `format=json`. Process the disturbances for alerts. Integrate into notification systems.

2.7 Post Feedback Retrieval

Action	postFeedback
Purpose	Submits occupancy feedback for a train, contributing to average occupancy data. This enables crowd-sourced train occupancy updates.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: connection: Departure connection URI (string). occupancy: Occupancy URI (string). Optional: None
Output	Successful: Returns confirmation with Location header (e.g., http://irail.be/vehicle/IC4516). Failure: Returns error details (e.g., 400: Bad request).
Workflow Example	Execute the `postFeedback` action with connection and occupancy details. Confirm submission via the response. Use for user feedback integration in apps.

2.8 Get Logs Retrieval

Action	getLogs
Purpose	Retrieves the last 1000 log entries in JSON format. This supports API usage monitoring and debugging.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_IRAILBELGIUM_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON array of log entries. Failure: Returns error details (e.g., 500: Internal server error).
Workflow Example	Execute the `getLogs` action. Review the logs for analysis. Use for operational insights.

Workflow Creation with the Connector

Example Workflow: Train Journey Planning

Retrieve Stations	Use the `getStations` action with optional `format=json` to fetch a list of stations. Identify departure and arrival stations (e.g., Gent-Sint-Pieters, Mechelen).
Query Connections	Execute the `getConnections` action with `from=Gent-Sint-Pieters` and `to=Mechelen` to fetch routes. Select a connection and note vehicle IDs.
Fetch Vehicle and Liveboard Data	Use the `getVehicle` action with a vehicle ID to retrieve train details. Use the `getLiveboard` action with `station=Gent-Sint-Pieters` to check departures. Integrate the data into a journey planner.
Monitor Disturbances and Submit Feedback	Use the `getDisturbances` action to check network status. Submit occupancy via `postFeedback` for selected trains.

This workflow enables applications to provide users with accurate railway information, enhancing travel planning, monitoring, and user engagement.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking