20140210: Oppdatering av spørretjenesten tirsdag 11. februar

Fra GrepWiki

Gå til: navigasjon, søk

Som annonsert oppdaterer vi spørretjenesten i morgen, tirsdag 11. februar.

Basert på erfaring fra testserver regner vi med minimalt med nedetid, men tjenesten vil kunne ha noe høyere responstid frem til onsdag.

Nytt versjonsnavn

Dette er en "kontraktsbrytende" endring av spørretjenesten. Den nye versjonen har fått navnet http://psi.udir.no/kl06/2013/11

Da vi kun støtter to samtidige versjoner av spørretjenesten, vil den nye versjonen skyve ut den eldste av de nåværende versjonene.

Før produksjonsetting kjører følgende versjoner:

Etter i morgen kjører følgende versjoner:

For brukere av 2013/04 som benytter soap, vil spørretjenesten fortsette å oppføre seg som før og levere forventede svar.

For brukere av 2013/04 som benytter REST/Odata, vil spørretjenesten fra i morgen som standard levere svar ihht 2013/11. 2013/11 avviker noe i struktur og innhold fra tidligere, og kan skape problemer. Vi har lagt til et nytt parameter i disse tjenestene som lar dere angi versjonen dere vil ha - ved å legge til "versjon=http://psi.udir.no/kl06/2013/04" vil dere fortsatt få tilgang til 2013/04.

Uansett metode/endpoint som benyttes, anbefaler vi våre brukere til å oppdatere egne løsninger til å benytte 2013/11-versjonen så snart som mulig.

Klienter som fortsatt benytter kontraktsversjon 2013/02 vil ikke lenger støttes etter 11. februar.

Liste over endringer

- Enklere referanser. De største endringene er på referanser. Vi har etter innspill fra dere gått gjennom dokumentene med det for øyet å lage "slankere" responser, der data fra refererte elementer reduseres til et minimum. Det betyr mindre støy i hvert element, men at man må gjøre flere spørringer for å få all relatert informasjon når man henter ut enkeltelementer. De fleste av dere henter ned store deler av læreplanverket eller kodeverket samtidig, og vil forhåpentligvis få et utbytte av denne endringen. Merk at den nye "referanse"-klassen har et nytt navn.

- Mulighet til å hente informasjon på kun ett språk/målform. Soap-kallene har fått et eget parameter for språk og REST-grensesnittet tar et valgfritt "?lang=<iso-kode>"-parameter. For de som ikke trenger alle oversettelser vil dette kutte ned på datamengden ved overføring. Husk at læreplanene er forskrift og finnes kun på en målform (men kan være oversatt til andre språk). For fagkoder og programområder skal det alltid finnes verdier på bokmål, nynorsk, nordsamisk og engelsk. Hvis man ikke oppgir ønsket språk får man fortsatt alle oversettelser som i dag.

- Direkte oppslag på "opplæringsfag". Dette er en egen entitet i Grep som forsøker knytte sammen kompetansemålsett i læreplanen med fagkodene som benyttes til vurdering/eksamen og dokumentasjon. Disse speiler ofte opplæringen i et fag for en målgruppe (derav navnet). Dette er den siste av de "selvstendige" datatypene som har blitt distribuert i den gamle RSS-løsningen, og vi tilbyr nå direkte oppslag i spørretjenesten på alle datatypene som tidligere ble distribuert i den kanalen.

- "Fag" omdøpes til "fagkode". Dette elementet burde blitt kalt fagkoder fra begynnelsen av. "Fag" er et trøblete ord for oss i Grep-teamet, da ulike miljøer har ulike forestillinger om hva det skal representere. For å lette vår egen hverdag, endrer vi nå navn på elementet til "fagkode", som også er termen vi oftest benytter når vi snakker med de som primært henter dette elementet fra Grep.

- Endret funksjonsnavn/soapkall slik at ingen benytter norske bokstaver. Vi har selv hatt trøbbel med noen 3djeparts-komponenter som ikke liker æøå.

- Endring av statusfeltet (publisert, utgått). På grunn av endringer i måten vi håndterer en del stam-verdier på internt i Grep, er statusfeltet nå en referanseverdi og ikke bare en tekststreng.

- Versjonering av REST/Odata. Vi har fått inn et ønske om å kunne versjonere også REST-grensesnittet, og har lagt til funksjonalitet for dette. Både REST og Odata vil nå ta "versjon" som url-parameter, der man oppgir samme versjonsnummer som benyttes for kontrakter i SOAP. Det vil si at dagens versjon er http://psi.udir.no/kl06/2013/04 og neste versjon blir http://psi.udir.no/kl06/2013/11. Om man ikke oppgir parameteret vil man få den nyeste versjonen. Om man angir en versjon som ikke finnes/støttes vil man få en feilmelding med informasjon om de versjonene som støttes.
Eksempler på kall:
http://data.udir.no/kl06/laereplaner?versjon=http://psi.udir.no/kl06/2013/04
http://data.udir.no/kl06/odata/?versjon=http://psi.udir.no/kl06/2013/04

Oppdatert dokumentasjon

Personlige verktøy
Navnerom
Varianter
Handlinger
Navigasjon
Verktøy