Skip to content

Informazione dati dei Treni

Jump to bottom
Giorgio edited this page Jan 17, 2019 · 3 revisions

Servizio Supervisione Stazione

Informazione dati dei Treni

Attenzione sostituire {Base_URL} {Base_URL} --> https://stingray.isti.cnr.it:8443/serviziosupervisionestazione/rfi/FrontEnd

Le API sono accessibili all'URL {Base_URL}/NOMEFUNZIONE/PARAMETRI... (metodo HTTPS GET)

Il servizio RESTful fornisce informazioni relative alla circolazione dei treni sulla rete ferroviaria italiana. Le informazioni pubblicate dal servizio possono essere codificate sia in formato JSON che in formato XML, impostando l'header Accept HTTP come "json", "application/json" oppure "xml", "text/xml"

Il servizio espone i seguenti metodi: • Train/GetPlaces • Train/GetNodes • Train/GetDepartures • Train/GetArrivals • Train/GetTrainDetails

TRAIN.GETPLACES

{Base_URL}/Train/GetPlaces (esempio: {Base_URL}/Train/GetPlaces)

Questo metodo restituisce l'anagrafica delle stazioni gestite.

**Output: **

  • string ServerTime Data e ora della risposta dal servizio, in formato YYYY-MM-DDTHH:MM:SS.mmm
  • list Places Lista delle stazioni. Ogni elemento della lista è costituito da:
    • int Id Codice località, come definito nel modello infrastrutturale RFI
    • string Name Nome della località, lunghezza massima 12 caratteri
    • string Description Nome esteso della località, lunghezza massima 40 caratteri
    • string Latitude Latitudine
    • string Longitude Longitudine
    • int Category Intero da 1 a 4 indicante la categoria della stazione:
      • 1 = Platinum
      • 2 = Gold
      • 3 = Silver
      • 4 = Bronze

TRAIN.GETARRIVALS

{Base_URL}/Train/GetArrivals (esempio: {Base_URL}/Train/GetArrivals?PlaceId=501)

Questo metodo restituisce la lista dei treni in arrivo in una stazione a partire da una data e ora. Il numero massimo di treni restituiti è impostato tramite un parametro in input.

Input

  • int PlaceId codice della stazione per la quale restituire la lista treni. Il codice deve corrispondere al codice PIC della località, come definito nel modello infrastrutturale RFI.
  • string Time (opzionale) Data e ora per le quali si deve restituire la lista arrivi, in formato "YYYY-MM-DDTHH:MM:SS.mmmZ". Se non impostato sono considerate data e ora corrente.
  • int Limit (opzionale) Numero massimo di treni da restituire. Se non impostato viene utilizzato il valore di default 100.

Output

  • string ServerTime Data e ora della risposta dal servizio, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”.
  • list Arrivals Lista dei treni in arrivo nella stazione per cui è stata fatta la richiesta. Ogni treno in arrivo è rappresentato da:
  • item TrainHeader Informazioni generali relative al treno:
    • string Id Codice treno, costituito da una stringa di lunghezza pari a 14 caratteri, ottenuta dalla concatenazione di , nel formato “YYYYMMGG” e associato al treno (p.e. “20150425109435”)
    • string BrandCustomer Testo che identifica l’impresa ferroviaria o il brand commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
    • string BrandCategory Testo che identifica la categoria commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
    • list Path Elenco delle fermate precedenti a quella corrente, sotto forma di lista codici località separati da virgole
  • string TrainNumber Numero treno nella località corrente
  • int Place Stazione di origine del treno, sotto forma di codice località
  • string Time Ora di arrivo programmata del treno nella località corrente, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”
  • string Platform Binario previsto di arrivo del treno (lunghezza massima 3 caratteri).
  • bool Cancelled Indica se il treno, originariamente previsto in arrivo, è stato cancellato.
  • string Delay Eventuale ritardo in minuti previsto in arrivo per il treno: il ritardo esposto è arrotondato in base alle regole previste per la pubblicazione dei ritardi nei sistemi di informazioni al pubblico.
  • bool PlatformChanged Indica se per il treno il binario (valore di Platform) è effettivo, cioè confermato.
  • bool Arriving Indica se lo stato del treno è “in arrivo”.
  • list Messages Elenco degli eventuali messaggi relativi al treno nella località passata in input; ogni elemento della lista contiene:
    • string type Tipo messaggio
    • string content Testo del messaggio

TRAIN.GETDEPARTURES

{Base_URL}/Train/GetDepartures (esempio: {Base_URL}/Train/GetArrivals?PlaceId=501)

Input

  • int PlaceId codice della stazione per la quale restituire la lista treni. Il codice deve corrispondere al codice PIC della località, come definito nel modello infrastrutturale RFI.
  • string Time (opzionale) Data e ora per le quali si deve restituire la lista arrivi, in formato "YYYY-MM-DDTHH:MM:SS.mmmZ". Se non impostato sono considerate data e ora corrente.
  • int Limit (opzionale) Numero massimo di treni da restituire. Se non impostato viene utilizzato il valore di default 100.

Output

  • string ServerTime Data e ora della risposta dal servizio, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”.
  • list Departures Lista dei treni in partenza nella stazione per cui è stata fatta la richiesta. Ogni treno in partenza è rappresentato da:
  • item TrainHeader Informazioni generali relative al treno:
    • string Id Codice treno, costituito da una stringa di lunghezza pari a 14 caratteri, ottenuta dalla concatenazione di , nel formato “YYYYMMGG” e associato al treno (p.e. “20150425109435”)
    • string BrandCustomer Testo che identifica l’impresa ferroviaria o il brand commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
    • string BrandCategory Testo che identifica la categoria commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
    • list Path Elenco delle fermate precedenti a quella corrente, sotto forma di lista codici località separati da virgole
  • string TrainNumber Numero treno nella località corrente
  • int Place Stazione di origine del treno, sotto forma di codice località
  • string Time Ora di partenza programmata del treno nella località corrente, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”
  • string Platform Binario previsto di partenza del treno (lunghezza massima 3 caratteri).
  • bool Cancelled Indica se il treno, originariamente previsto in partenza , è stato cancellato.
  • string Delay Eventuale ritardo in minuti previsto in partenza per il treno: il ritardo esposto è arrotondato in base alle regole previste per la pubblicazione dei ritardi nei sistemi di informazioni al pubblico.
  • bool PlatformChanged Indica se per il treno il binario (valore di Platform) è effettivo, cioè confermato.
  • bool Arriving Indica se lo stato del treno è “in partenza”.
  • list Messages Elenco degli eventuali messaggi relativi al treno nella località passata in input; ogni elemento della lista contiene:
    • string type Tipo messaggio
    • string content Testo del messaggio

TRAIN.GETTRAINDETAILS

{Base_URL}/Train/GetTrainDetails (esempio: {Base_URL}/Train/GetTrainDetails?TrainNumber=5001)

Input

  • string TrainId Identificativo del treno per il quale sono richiesti i dettagli. L’identificativo del treno consente di identificare univocamente il treno. L’utilizzo del TrainId nella richiesta è consigliabile nei casi in cui sono richiesti dettagli per un treno ritornato da una precedente chiamata ad una lista partenze o lista arrivi: in questi casi si utilizza il parametro Id presente nell’elemento TrainHeader del treno selezionato. Questo parametro e il parametro TrainNumber sono mutuamente esclusivi (solo uno dei due è ammesso come input per una richiesta al servizio).
  • string TrainNumber Numero del treno per il quale sono richiesti i dettagli. L’utilizzo del TrainNumber nella richiesta è disponibile, ad esempio, per i casi in cui la richiesta sia conseguente ad un input del numero treno da parte di un utente. Questo parametro e il parametro TrainId sono mutuamente esclusivi (solo uno dei due è ammesso come input per una richiesta al servizio).
  • string Time (opzionale) Data e ora per le quali si devono restituire i dettagli treno, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”. Se non impostato sono considerate data e ora corrente. Output
  • string ServerTime Data e ora della risposta dal servizio, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”.
  • list Trains Lista dei singoli trasporti associati al treno. In generale ad un numero treno possono essere associati più istanze (ad esempio nel caso di un treno che in una località cambia numero e riparte con un numero diverso da quello con cui è arrivato). Ogni elemento della lista è costituito da:
    • item TrainHeader Informazioni generali relative al treno:
      • string Id Codice treno, costituito da una stringa di lunghezza pari a 14 caratteri, ottenuta dalla concatenazione di , nel formato “YYYYMMGG” e associato al treno (p.e. “20150425109435”)
      • string BrandCustomer Testo che identifica l’impresa ferroviaria o il brand commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
      • string BrandCategory Testo che identifica la categoria commerciale del treno. Il chiamante può utilizzare questo dato per identificare nel proprio repository l’icona da visualizzare nel proprio sistema.
      • item LastCheck Struttura contenente informazioni relative all’ultimo passaggio reale del treno:
        • string PlaceName Nome della località di ultimo passaggio
        • string Time Data e ora di ultimo passaggio
        • string Delay Stringa contenente il ritardo in minuti relativo all’ultimo passaggio
      • list TrainMessages Lista di stringhe contenenti i messaggi associati al treno.
  • list Path Informazioni specifiche relative al percorso del treno. Ogni elemento è relativo ad una località in cui il treno effettua sosta per servizio viaggiatori, e contiene i seguenti elementi:
    • int Place Codice località, corrispondente al codice PIC della località, come definito nel modello infrastrutturale RFI.
    • bool CoachesChanged Flag che indica se nella località corrente il treno subisce una variazione della composizione commerciale (se flag = true).
    • bool Arrived Flag che indica se nella località corrente il treno ha registrato un arrivo reale, cioè se il treno è arrivato nella località.
    • item Arrival (presente se flag Arrived = true), contenente le seguenti informazioni:
      • bool Cancelled Indica se il treno è stato cancellato in arrivo (se = true)
      • string Time Data e ora relative di arrivo, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”.)
      • string Delay Ritardo in minuti sull’evento di arrivo
      • string Platform Binario di arrivo del treno
      • bool PlatformChanged Indica se il binario di arrivo è effettivo, cioè confermato
      • string TrainNumber Numero del treno sull’evento di arrivo
    • bool Departed Flag che indica se nella località corrente il treno ha registrato una partenza reale, cioè se il treno è partito dalla località località.
    • item Departure (presente se flag Departed = true), contenente le seguenti informazioni:
      • bool Cancelled Indica se il treno è stato cancellato in partenza (se = true)
      • string Time Data e ora relative di partenza, in formato “YYYY-MM-DDTHH:MM:SS.mmmZ”.)
      • string Delay Ritardo in minuti sull’evento di partenza
      • string Platform Binario di partenza del treno
      • bool PlatformChanged Indica se il binario di partenza è effettivo, cioè confermato
      • string TrainNumber Numero del treno sull’evento di partenza
    • list Messages Elenco degli eventuali messaggi relativi al treno nella località; ogni elemento della lista contiene:
      • string type Tipo messaggio
      • string content Testo del messaggio

PORFES2017

Clone this wiki locally