Qodex.ai

Railigent X - Asset Feature API

Number of APIs: 4

Introduction

The Railigent X - Asset Feature API allows to retrieve real-time information about assets of eligible fleets. Railigent X uses cloud technology to normalize asset information across multiple fleets of assets to provide a unified access interface.

The API provides two categories of endpoints: * Fleets endpoints for discovering available assets of eligible fleets * Assets endpoints for retrieving information for specific assets or all assets of a specific fleet

Service Usage Guide

For typical use cases, the usage of the Railigent X - Asset Feature API can be characterized as three-step workflow:

Intended API usage flow.
  1. Initially, you can use the Fleets endpoints to discover which fleets are available and which assets are eligible for each fleet.
  2. Based on the API response, you can determine which eligible assets are relevant for your individual use cases.
  3. For these assets, you can continuously retrieve live information using the Assets endpoints.

Service Access Control

Only authenticated and authorized access to the API is allowed. You can use your Railigent X credentials you have received from the Railigent X Support Desk.

Service Usage Limits

Depending on your individual API subscription, service usage limits (maximum number of requests per minute and maximum number of requests per hour) may apply. When reaching a service usage limit, all subsequent requests will yield a HTTP status code of 429 until the service usage limit is automatically reset.

Service Changelog

API versioning is based on the Semantic Versioning 2.0.0.

Version 1.0.0:

  • Initial Release
  • Compliance with Xcelerator REST API Guidelines V2

Contact Support: Name: Railigent X Support Desk Email: secure-operations.mobility@siemens.com

  1. v1/fleets-{fleetId}-assets - Retrieve information for all assets of a specific fleet. GET {{baseUrl}}/v1/fleets/:fleetId/assets?fields=

  2. v1/fleets-{fleetId}-assets - Retrieve information for a specific asset of a specific fleet. GET {{baseUrl}}/v1/fleets/:fleetId/assets/:assetId?fields=

  3. v1/fleets - Retrieve information about all eligible fleets of assets. GET {{baseUrl}}/v1/fleets

  4. v1/fleets-{fleetId} - Retrieve information about a specific eligible fleet of assets. GET {{baseUrl}}/v1/fleets/:fleetId