SVV logo
Informasjonsportal for Autosys Kjøretøy
 

Velkommen

Velkommen til informasjonsportalen for Autosys Kjøretøy. Denne portalen inneholder informasjon om tjenester og miljøer som tilhører Autosys Kjøretøy.

Support

Har du spørsmål om bruk av APIet eller ønsker å melde inn et avvik under utvikling eller test ta kontakt via felles mailboks

For å sikre en effektiv prosess knyttet til behandling av et avvik er det viktig av avviket inneholder informasjon om:

  • Base-url til miljø som avviket har oppstått i
  • Hvilken tjeneste som ble kalt?
  • Hvordan oppstod avviket (hvordan kan det gjenskapes)?
  • Hvordan påvirker feilen konsument?
  • Er feilen til hinder for testing - i så fall hvorfor?

Protokoll og format

Tjenestene er tilgjengelige som REST-tjenester over HTTP, med data på formatene JSON. Relevante endringer i registeret tilgjengeliggjøres som en feed med hendelser med data på XML format.

Endring av tjenestene

Konsumenter må være oppmerksom på at det vil komme endringer av tjenestene. I APIet skilles det på bakoverkompatible og ikke-bakoverkompatible endringer.

Bakoverkompatible endringer

Ved bakoverkompatible endringer kan endringen skje på en eksisternde tjeneste. Endringene skal da være kompatible med forrige versjon.

Følgende prinsipper gjelder for bakoverkompatible endringer:

  • Tjenesten kan legge til nye URL-endepunkt(er) til tjenesten
  • Tjenesten kan legge til nye valgfrie parametere i forspørsel til tjenesten
  • Tjenesten kan legge til nye valgfrie objekter eller elementer i svaret fra tjenesten
  • Tjenesten kan legge til nye kodeverdier tilhørende et kodeverk i svaret fra tjenesten
  • Tjenesten kan legge til nye HTTP-statuskoder
  • Tjenesten kan legge til nye HTTP-operasjoner (eksempelvis POST i tillegg til GET) til tjenesten

Det er derfor viktig at konsumenter av tjenestene bygger robust kode som tåler slike endringer.

Ikke-bakoverkompatible endringer

Følgende endringer vil IKKE bli regnet som bakoverkompatible og derav kunne føre til ny versjon av tjensten:

  • Tjenesten endrer autentisering-metode
  • Tjenesten fjerner URL-endepunkt
  • Tjenesten fjerner valgfrie eller påkrevde parametere i forespørsel
  • Tjenesten legger til nye verdier til en eksisterende enum
  • Tjenesten fjerner eller legger til verdi(er) for en eksisterende enum
  • Tjenesten fjerner HTTP-metode
  • Tjenesten endrer URL-formatet i HTTP-definisjonen
  • Tjenesten endrer URI-formatet til ressurs
  • Tjenesten endrer navn på objekt/element tilhørende en ressurs
  • Tjenesten endrer bruk av HTTP-statuskode
  • Tjenesten endrer type for et element i en ressurs i tjenesten
  • Tjenesten gjøre om valgfrie parametere i forespørsel til påkrevet

Ved ikke-bakoverkompatible endringer vil det bli laget en ny versjon av tjenesten. Det vil da i en overgangsfase eksistere to versjoner av samme tjeneste slik at konsumenter kan ved ulike tidspunkter gå over til ny versjon av tjeneste. Merk at støtte for gamle versjoner etterhvert vil tas vekk. Dette vil bli varslet i forveien.

Mapping av null verdier

Følgende regler gjelder for hvordan elementer, lister og objekter med null verdi mappes ved generering av et JSON-svar fra tjenestene.

  1. Hvis et element har null verdi vil elementet ikke bli representeret.

    I følgende eksempel er element "adresselinje2" og "adresselinje3" ikke representert i "adresse"-objektet da de inneholder null verdi.
"adresse": {
	"adresselinje1": "KONGENS GATE 04",
	"kommunenavn": "OSLO",
	"kommunenummer": "0153",
	"land": "NORGE",
	"landkode": "NOR",
	"postnummer": "0153",
	"poststed": "OSLO"
}
  1. Hvis en liste har 0 elementer vil en tom JSON-liste returneres som vist under.
"registreringsbegrensninger": {
	"registreringsbegrensning": []
}
  1. Hvis alle elementene i et objekt har null verdi (og det ikke finnes en liste i objektet) vil et tomt objekt returneres.

I følgende eksempel er objektet "lyd" som ligger under objektet "miljoOgdrivstoffGruppe" tomt.

 
"lyd": {}

Til forskjell fra følgende eksempel hvor det finner elementer med verdi for objekt "lyd".

 
"lyd": {
	"kjorestoy": 70,
	"standstoy": 73,
	"vedAntallOmdreininger": 3750
}