Brukerveiledning: SIRI-profilvalidator
- Lasse Tyrihjell
- Andreas Tryti
- Johan Wiklund
Bakgrunn
SIRI sanntidsdata utveksles som XML i et format som er definert av CEN. Dette formatet åpner for stor grad av tolkning rundt hvordan konkrete situasjoner skal beskrives, og derfor er det utarbeidet en Norsk SIRI-profil som beskriver i detalj hvordan standarden skal brukes.
For at det skal være enkelt å verifisere hvorvidt en gitt SIRI-strøm oppfyller kravene i denne profilen, er det derfor laget et verktøy som kan lage enkle rapporter basert på de, til enhver tid, innkommende data.
Dette verktøyet er tilgjengelig på følgende URL: https://api.entur.io/realtime/v1/validation/<CODESPACE> der CODESPACE erstattes med riktig codespace for hver enkelt operatør/fylkeskommune.
En liste over gyldige codespaces som leverer sanntidsdata finnes i vår utviklerportal.
Validator-verktøy
Kolonne | Beskrivelse |
|---|---|
Name | Beskrivende navn på hver enkelt SIRI-strøm. |
Subscription status | Sier hvorvidt SIRI-strømmen er aktivert eller ikke. |
Type | Hvilken datatype den aktuelle SIRI-strømmen inneholder. |
Filter (avansert bruk) | Tekstlig filter som kan brukes til å avgrense hvilke SIRI-meldinger som skal valideres. Her kan man f.eks. skrive inn ID for en spesifikk avgang, og validatoren vil da kun validere innkommende dataleveranser som inneholder denne. Verdien som skal brukes må skrives inn før validering skrus på. MERK: Dette filteret vil ikke være personlig, men gjelde alle som bruker validatoren på samme tid. |
Results | Link til valideringsrapport (åpner i nytt vindu). |
On/Off | Skrur validering av/på for hver enkelt SIRI-strøm (i eksempelet er validering skrudd på for rad 2, mens den er av for rad 1 og 3). NB: Validering blir skrudd av/på for SIRI-strømmen - ikke hver enkelt bruker. Dette innebærer at om bruker A skrur på validering, kan bruker B skru det av igjen - uten at bruker A får noe varsel. |
Valideringsrapport
Utdrag fra valideringsrapport:
Kolonne | Beskrivelse |
|---|---|
Timestamp | Dato/tidspunkt for når data ble mottatt/validert |
Schema validation errors | Oppsummering av antall strukturelle feil som er oppdaget i dataleveransen. |
Profile validation errors | Oppsummering av antall innholdsmessige/logiske feil i dataleveransen som bryter med norsk profil. |
XML | Link til den validerte dataleveransen så man kan se hva som er validert. |
Hver enkelt rad kan ha forskjellige farger avhengig av validerings-status.
Rød: Dataleveransen inneholder valideringsfeil ihht. skjema og/eller profil (f.eks. rad 1 og 2 i eksempelet).
Grønn: Dataleveransen har ingen feil (rad 3 i eksempelet)
Hver enkelt rad er også klikkbar slik at man kan få flere detaljer. Ved å klikke på første rad i eksempelet vil man f.eks. få opp denne:
Her er det delt opp i to seksjoner: skjema- og profil-validering.
Under skjema-validering vil man se
alvorlighetsgrad
antall ganger hver feil inntreffer
en generert beskrivelse av hva som er feil
linjenummer/kolonne for hvor første tilfelle kan finnes i XML-filen
Under profil-validering vil man se
i hvilket SIRI-element feilen ble funnet
antall forskjellige feil
Ved å klikke på raden PtSituationElement, vil det åpne seg flere detaljer om feilene som er funnet
For spørsmål om bruk av verktøyet eller tolking av valideringsresultatene, ta kontakt med Entur. Hvis du ikke har en kontaktperson kan spørsmål sendes til kollektivdata@entur.org.