SIDRA API
Introduction
The SIDRA INTERSECTION Application Programming Interface (API) provides a programming interface that enables external applications to communicate with SIDRA INTERSECTION.
This API provides the following capabilities:
- Extensive programmatic access to the Site / Network input and output data contained in the SIDRA INTERSECTION Project file (extension
.sip) - Ability to create a Project file, add a Site / Network / Common Control Group (CCG) / Route, specify geometry data (e.g. add and remove intersection legs and lanes, specify lane configuration and lane disciplines), specify phasing and timing data, and more
- Provision for processing a Site or Network (running the program)
In addition to the API, full access is provided to input and output data that resides in the Project File database (extension .sip). This data can be accessed directly via SQL queries. Input and output data structures in the SIDRA INTERSECTION project file were developed for this purpose.
Supported Languages
The API assembly can be accessed natively from any .NET Framework (4.7 minimum) programming language, or it can be accessed via classes exposed by COM. The API defines a number of classes and objects which define a simple hierarchy for a SIDRA INTERSECTION Project.
Licence Required
A licensed version of SIDRA INTERSECTION must be installed on a computer before the API can be used.
-
Request a quote for a SIDRA INTERSECTION licence.
-
Have questions about the API or licensing?
Downloads
Files are available for programmers who want to develop API applications for SIDRA INTERSECTION:
| File | Description |
|---|---|
| Help | Detailed information about all parameters and the structure accessible in the SIDRA INTERSECTION API. |
| Late Binding DLL | A .NET Framework assembly. If your application uses SIDRA INTERSECTION API through .NET Framework, your application needs to reference this DLL file to ensure compatibility with future updates. If your application uses SIDRA INTERSECTION API through COM (e.g. Excel VBA, C++, Python), this file is not required. |
| Sample API programs | Example programs to help you get started with SIDRA INTERSECTION API. |
Important: Unblock the Help file
Before using the Help file for the first time, right-click the file name or icon, select Properties, then select the General tab. If an Unblock checkbox or button is shown, click it to unblock the file. Otherwise, various errors may occur.
All Versions
API applications must match your installed SIDRA INTERSECTION version.
| Version | Help | Late Binding DLL | Samples |
|---|---|---|---|
| SIDRA INTERSECTION 11 | Download | Download | Download |
| SIDRA INTERSECTION 10 | Download | Download | Download |
| SIDRA INTERSECTION 9.1 | Download | Download | Download |
Note
SIDRA INTERSECTION 10 samples require version 10.0.6.236 or later.
Terms
We provide the SIDRA INTERSECTION API to allow development of programs that link to our software for use under the SIDRA SOLUTIONS software licence agreement.
Our provision of access to the SIDRA INTERSECTION API is a non-exclusive, limited right to access and use the API, and it does not create or imply any partnership, agency, or joint venture. The API is provided as is without any warranties, expressed or implied. In using the SIDRA INTERSECTION API, you agree to indemnify and hold us harmless from any losses that may result from third-party claims that relate to your use of the API.
The full terms of use are set out in the SIDRA SOLUTIONS Terms of Use.
Version Compatibility
The SIDRA INTERSECTION API is updated for each major version of the software. Accordingly, you will need to update your API program to provide a link to the latest version of SIDRA INTERSECTION.
API Workshop 2018
A half-day workshop held in Melbourne on 26 November 2018 to support practical use of the SIDRA API, with integrations demonstrated for Aimsun, EMME, DYNAMEQ, and TRACKS. The recordings, slides, and sample programs remain available below.
Workshop materials and presenters (2018 archive)
Downloads
- Transcript of Presentations — edited version of the audio recording of workshop presentations and discussions.
- Presentation Files — slide presentation files in PDF format.
- SIDRA BATCH Python Samples — complete set of SIDRA BATCH Python sample programs using SIDRA API.
We recommend opening the corresponding presentation files when reading each section of the transcript.
Topics and presenters
- Welcome and Introduction to SIDRA API Workshop — Dr Rahmi Akçelik (SIDRA SOLUTIONS)
- An Introduction to Using API for SIDRA INTERSECTION 8 and VOLUMES Utility — Mark Besley (SIDRA SOLUTIONS)
- SIDRA BATCH Python Sample Program Using SIDRA API — Harry Cai (SIDRA SOLUTIONS)
- Aimsun – SIDRA Interface — Mohammad Saifuzzaman (Aimsun Pty Ltd, A Siemens Company)
- TRACKS – SIDRA Link — Grant Smith (Transportation and Traffic Systems Ltd)
- Using SIDRA API for EMME and DYNAMEQ — Paul van den Bos (Freelance Transport Modeller)
- GTASIDRA – A Process Integrator — Luca Rosati and Rebecca Strachan (GTA Consultants)
- Discussions on User Needs and API Development — group discussion on future directions and user requirements.