Skip to content

Transmodel API

Jump to bottom
lukmay edited this page Oct 17, 2024 · 4 revisions

Document 2: SIRI-Lite Endpoints - Transmodel API

Transmodel API - SIRI-Lite Endpoints Documentation

Overview

The Transmodel API provides access to real-time mobility data using the SIRI-Lite (Service Interface for Real-Time Information) protocol. SIRI-Lite focuses on real-time monitoring of facilities, such as parking lots and shared mobility services, offering a streamlined version of the SIRI standard.

The API is part of the MaaS4Italy initiative, which is designed to make real-time data available to third-party applications through the Open Data Hub.

SIRI-Lite Endpoints

1. /siri-lite/facility-monitoring

  • Method: GET
  • Description: General endpoint for real-time updates on both parking and sharing services. Users can retrieve real-time information on facility status, occupancy, and availability.
  • Use Case: Suitable for applications needing to monitor real-time status for multiple mobility services, including parking spaces and shared vehicles.

2. /siri-lite/facility-monitoring/parking

  • Method: GET
  • Description: Provides real-time updates for parking facilities, such as available parking spaces, facility status, and other key metrics.
  • Use Case: Ideal for developers building applications that provide real-time parking availability information or monitoring systems.

3. /siri-lite/facility-monitoring/sharing

  • Method: GET
  • Description: Retrieves real-time updates for shared mobility services, such as bike or car-sharing. Information includes available vehicles, operator details, and station status.
  • Use Case: Useful for real-time integration of shared mobility services into mobility apps or transport platforms.

Filtering Options

The SIRI-Lite endpoints support flexible filtering to enable refined queries for specific data. Users can filter results by facility reference, geographic location, operator, and other criteria to narrow down real-time information.

Common filtering options include:

  • Facility reference: Filter by a specific parking or sharing facility.
  • Location: Retrieve results based on proximity to a specific geographic point (latitude and longitude).
  • Operator: Narrow results by the operator of the parking or sharing service.

Additional Resources

Swagger Documentation

The Swagger interface provides a complete specification for the SIRI-Lite endpoints, including the available filters, request parameters, and response structures. It enables developers to test queries and explore available features.

GitHub Repository

The GitHub repository for the API contains the source code, additional documentation, and validation scripts. Developers can contribute to the project or use the examples provided to implement the API in their own systems.

SIRI-Lite Overview

SIRI-Lite is a simplified version of the SIRI protocol designed to provide real-time data for facilities like parking and sharing services. The Transmodel API offers an easy-to-use, lightweight interface that allows applications to query real-time data without the complexity of full SIRI subscription models.

The API provides essential information for monitoring real-time facility status, such as the number of available parking spaces or shared vehicles, and is integrated with the Open Data Hub to ensure seamless access to up-to-date data.

Support & Contact Information

For further information or support regarding the SIRI-Lite endpoints, contact the Open Data Hub team:

This document provides an overview of the SIRI-Lite endpoints available in the Transmodel API. These endpoints enable real-time data integration for parking and shared mobility services, ensuring developers can easily access and incorporate up-to-the-minute facility data into their applications.

This wiki contains additional information about the Open Data Hub alongside the Open Data Hub - Official Documentation 🔗 .

Home

Projects

Official Documentation

Open Data Hub - Official Documentation 🔗

Clone this wiki locally