API Overzicht

Dit API endpoint levert data met betrekking tot tellers voor assets op het Railnova platform, zoals kilometers en motoruren. De data wordt gepresenteerd in een afgevlakte structuur, waardoor het gemakkelijker te consumeren is. Het eindpunt maakt filteren en rangschikken mogelijk en de resultaten worden gepagineerd met behulp van LinkHeader-paginatie.

Endpoint URL:

https://{company}.railnova.eu/api/v2/counters/flattened.json

Method: GET

Authenticatie

Basic authenticatie met geldige Railnova platform gebruikersgegevens is vereist.

API Details

Response Voorbeeld:

{
"id": 6947,
"asset_id": 12963,
"asset_name": "Flying Scotsman",
"asset_uic": null,
"asset_class_id": 260,
"asset_class_name": "A1",
"is_immobilised": false,
"telematic_source_message": "gps_km",
"telematic_source_column": "period_km",
"name": "gps_km",
"aggregate": "increment",
"value": "2241.0",
"unit": "km",
"daily_average_30d": "365.0",
"last_update": "2024-09-15T09:00:00+01:00",
"component_type_id": null,
"component_type_name": null,
"component_id": null,
"component_name": null,
"component_serial": null,
"data_freshness_first_threshold": "15",
"data_freshness_second_threshold": "60"
}

Field Omschrijvingen

id: Unieke identifier voor tellers
asset_id: Unieke identifier voor het bijbehorende bedrijfsmiddel (bijv. locomotief, wagon)
asset_name: Naam van de asset (bijv., "Flying Scotsman")
asset_uic: UIC-nummer voor de asset, indien beschikbaar
asset_class_id: Unieke identifier voor het voertuig type (bijv. 260 voor A1)
asset_class_name: Naam van het voertuig type (e.g., "A1")
is_immobilised: Booleaanse waarde die aangeeft of het voertuig momenteel geïmmobiliseerd is of niet
telematic_source_message: Bron van het telematicabericht met betrekking tot de tellergegevens (bijv. “gps_km”)
telematic_source_column: Kolom van de telematicabron die de specifieke tellergegevens bevat (bijv. “periode_km”)
name: Naam van de teller (bijv., "gps_km")
aggregate: Aggregatiemethode die wordt gebruikt voor de tellerwaarde (opties zijn “increment” en “absoluut”)
value: Huidige waarde van de teller (bijv. “2241.0” km)
unit: Meeteenheid voor de tellerwaarde (bijv. “km” voor kilometers)
daily_average_30d: Gemiddelde dagelijkse stijging voor de teller over de laatste 30 dagen
last_update: Datum en tijd waarop de teller voor het laatst is bijgewerkt (ISO 8601 formaat)
component_type_id: Identifier voor het type component met betrekking tot de teller, indien van toepassing
component_type_name: Naam van het type component met betrekking tot de teller, indien van toepassing
component_id: Identifier voor het specifieke component gerelateerd aan de teller, indien van toepassing
component_name: Naam van de specifieke component met betrekking tot de teller, indien van toepassing
component_serial: Serienummer van de component met betrekking tot de teller, indien van toepassing
data_freshness_first_threshold: Eerste grenswaarde voor het bepalen van de versheid van gegevens (bijv. na 15 dagen worden de gegevens als oud beschouwd).
data_freshness_second_threshold: Tweede grenswaarde voor het bepalen van de versheid van gegevens (bijv. na 60 dagen, gegevens vereisen mogelijk interventie).

Query Parameters

De volgende query parameters worden ondersteund om de gegevens te filteren:

asset_id: Filter op asset ID.
asset_uic: Filter op UIC nummer van het voertuig.
asset_class_id: Filter op de ID van het voertuig type.
asset_class_name: Filter op naam van het voertuig type (bijv., "Flying Scotsman").
asset_name: Filter op de naam van het voertuig (bijv., "A1").
telematic_source_message: Filter op telematicabronbericht (bijv., "gps_km").
telematic_source_column: Filter op de kolom van telematicabronbericht (bijv., "period_km").
aggregate: Filter op aggregatie type (bijv., "increment").
name: Filter op de naam van de teller.
last_update__gt: Geef alleen resultaten terug waarbij last_update groter is dan een bepaalde datum (formaat: JJJJ-MM-DD).
last_update__lt: Geef alleen resultaten terug waarbij last_update kleiner is dan een bepaalde datum (indeling: JJJJ-MM-DD).

Voorbeeld voor gefilterde aanvraag:

GET https://{company}.railnova.eu/api/v2/counters/flattened.json?asset_name=SKL429&last_update__gt=2022-01-01

Rangschikken

Resultaten kunnen worden gerangschikt met de query parameter Ordening. De volgende velden worden ondersteund:

name: Rangschikt resultaten op de naam van de teller.
last_update_date: Rangschikt resultaten op de laatste update datum.
daily_avg: Rangschikt de resultaten volgens het dagelijkse gemiddelde over de laatste 30 dagen.
counter_type__name: Rangschikt de resultaten volgens de naam van het tellertype.
asset__name: Rangschikt de resultaten op de naam van het voertuig.

Voorbeeld van een rangschikte aanvraag:

GET https://{company}.railnova.eu/api/v2/counters/flattened.json?ordering=last_update_date

De volgorde kan worden teruggedraaid door “-” toe te voegen voor de waarde van de volgorde.

Voorbeeld van een gerangschikte aanvraag ( teruggedraaid):

GET https://{company}.railnova.eu/api/v2/counters/flattened.json?ordering=-last_update_date

Paginering

De API gebruikt LinkHeader pagination.

Error Codes

401 Unauthorized: Authenticatie mislukt. Controleer de gebruikersnaam en het wachtwoord.
400 Bad Request: De aanvraagparameters zijn ongeldig.
404 Not Found: De gevraagde bron kon niet worden gevonden.

Support

Heb je nog vragen? Ga naar het Railnova-platform en klik op "Contact" voor hulp.