Endringer i eksterne tjenester for versjon «2013/11»

Transkript

1 Endringer i eksterne tjenester for versjon «2013/11» Innholdsfortegnelse Innledning... 3 Utfyllende oppsummering av endringer som medfører nytt versjonsnummer (breaking changes)... 4 Metoder som har blitt fjernet... 4 Parametere som har blitt fjernet... 4 Parametere som har endret type... 4 Parameter fagtype har endret type fra kodeverkverdi til hjelpedataverdi... 4 Parameter erstatter har endret type fra kjerneelementreferanse[] til referanse[]... 4 Parameter erstattetav har endret type fra kjerneelementreferanse[] til referanse[]... 4 Parameter tilgjengeligespraak har endret type fra kodeverkverdi[] til hjelpedataverdi[]... 5 Parameter merkelapper har endret type fra kjerneelementreferanse[] til referanse[]... 5 Parameter opplaeringsnivaa har endret type fra kodeverkverdi[] til hjelpedataverdi[]... 5 Parameter status har endret type fra String til hjelpedataverdi... 5 Parameter fastsattspraak har endret type fra kodeverkverdi til hjelpedataverdi... 6 Parameter etterfag har endret type fra opplaeringsfag[] til referanse[]... 6 Parameter etteraarstrinn har endret type fra kodeverkverdi[] til hjelpedataverdi[]... 6 Parameter kompetansemaal har endret type fra kompetansemaal[] til kompetansemaalreferanse[]... 6 Parameter typeutdanningsprogram har endret type fra kodeverkverdi til hjelpedataverdi.. 6 Parameter erstatterutdanningsprogram har endret type fra kjerneelementreferanse[] til referanse[]... 7 Parameter foerstesemester har endret type fra kodeverkverdi til hjelpedataverdi... 7 Parameter sistesemester har endret type fra kodeverkverdi til hjelpedataverdi... 7 Parameter aarstrinn har endret type fra kodeverkverdi til hjelpedataverdi... 7 Parameter byggerpaaprogramomraade har endret type fra kjerneelementreferanse[] til referanse[]... 7 Parameter erstatterprogramomraade har endret type fra kjerneelementreferanse[] til referanse[]... 8 Parameter tilknyttedeutdanningsprogram har endret type fra kjerneelementreferanse[] til referanse[]... 8 Parameter tilknyttedelaereplaner har endret type fra kjerneelementreferanse[] til referanse[]... 8

2 Parameter merknadstype har endret type fra kodeverkverdi til hjelpedataverdi... 8 Parameter dokumenttype har endret type fra kodeverkverdi[] til hjelpedataverdi[]... 8 Parameter relatertefag har endret type fra kjerneelementreferanse[] til referanse[]... 9 Parameter relaterteaarstrinn har endret type fra kodeverkverdi[] til hjelpedataverdi[]... 9 Parameter tilknyttedefag har endret type fra kjerneelementreferanse[] til referanse[]... 9 Parameter tilknyttedeprogramomraader har endret type fra kjerneelementreferanse[] til referanse[]... 9 Parameter fagkategori har endret type fra fagkategorireferanse til referanse... 9 Oppsummering av endringer som ikke bryter kontrakten Metoder som har blitt lagt til Parametere som har blitt lagt til... 10

3 Innledning I forbindelse med produksjonssetting av ny versjon av Greps spørretjeneste vil det komme inn endringer i den eksterne tjenesten som bryter med den gamle kontrakten. Det vil si at vi kommer til å gå fra versjon til versjon for eksterne tjenester. Endringer og utvidelser for denne releasen: Tjenesten er utvidet til å kunne utføre spørringer på opplæringsfag. Fag har endret navn til fagkoder fordi det er et mer presist navn på dette elementet, og kontraktnavnet er endret fra vurderingsfag til fagkode Kontraktnavnet for merkelapper er endret fra Merkelapp til merkelapp. Det er rettet opp feil i spørringer på kompetansemålsett i soap. Har fjernet «å» fra operasjonsnavnene. Det vil si at: o FinnKompetansemål er endret til FinnKompetansemaal o HentKompetansemålFraKode er endret til HentKompetansemaalFraKode o HentKompetansemålFraPsi er endret til HentKompetansemaalFraPsi Referansene er også gjort «slankere», ved at vi ikke tar med alle oversettelser på tittel og status. Oversettelsene kommer fortsatt med som standard, men det går nå an å oppgi hvilket språk man ønsker (evt. «default») dersom man ikke trenger alle oversettelsene. KjerneElementReferanse har endret navn til Referanse, og brukes nå for alle koblinger mellom elementer der en ikke trenger tilleggsopplysninger for å finne ønsket informasjon. Koblinger mellom kompetansemål og læreplan, og opplæringsfag og læreplan er definert med referanse til læreplan, samt id til aktuelle kompetansemålsett. Typen kodeverksverdi har endret navn til hjelpedataverdi, da «kodeverksverdi» lett kan forveksles med eller beskrive andre elementer i Grep. Status, oppgave og sensur har endret type til hjelpedataverdi. Dette gir mulighet for oversettelser på disse verdiene. Siden vi nå tilbyr spørringer på alle relevante elementtyper, vil vi benyttet denne anledningen til fjerne all informasjon som ikke er direkte knyttet til den enkelte elementtypen. F.eks. har vi fjernet informasjon om relatert opplæringsfag på læreplan, og erstattet dette med en link til opplæringsfaget Den nye versjonen blir tilgjengelig for testing på en egen testserver ( fra november Ny kontrakt er tilgjengelig på Oppdatert dokumentasjon for denne releasen ligger vedlagt invitasjonen til test.

4 Utfyllende oppsummering av endringer som medfører nytt versjonsnummer (breaking changes) Metoder som har blitt fjernet FinnFag HentFagFraKode HentFagFraPsi FinnKompetansemål HentKompetansemålFraKode HentKompetansemålFraPsi FinnFagkategori Parametere som har blitt fjernet relatertmerkelapp i metoden Respons fra metode HentProgramomraadeFraKode: programomraade.relatertmerkelapp relatertmerkelapp i metoden Respons fra metode HentProgramomraadeFraPsi: programomraade.relatertmerkelapp Parametere som har endret type Parameter fagtype har endret type fra kodeverkverdi til hjelpedataverdi Parameter erstatter har endret type fra kjerneelementreferanse[] til referanse[] Parameter erstattetav har endret type fra kjerneelementreferanse[] til referanse[]

5 Parameter tilgjengeligespraak har endret type fra kodeverkverdi[] til hjelpedataverdi[] Parameter merkelapper har endret type fra kjerneelementreferanse[] til referanse[] Parameter opplaeringsnivaa har endret type fra kodeverkverdi[] til hjelpedataverdi[] Parameter status har endret type fra String til hjelpedataverdi.hovedomraader.kompetansemaalsett Respons fra metode HentPlanFraKode: laereplan.kompetansemaalsett.hovedomraader.hovedomraader.kompetansemaalsett.kompetansemaalsett.hovedomraader Respons fra metode HentUtdanningsprogramFraKode: utdanningsprogram Respons fra metode HentUtdanningsprogramFraPsi: utdanningsprogram Respons fra metode HentMerkelappFraKode: Merkelapp Respons fra metode HentMerkelappFraPsi: Merkelapp Respons fra metode HentFagomraadeFraKode: fagomraade

6 Respons fra metode HentFagomraadeFraPsi: fagomraade Respons fra metode HentFagkategoriFraKode: fagkategori Respons fra metode HentFagkategoriFraPsi: fagkategori Parameter fastsattspraak har endret type fra kodeverkverdi til hjelpedataverdi.fastsettelsesinformasjon.fastsettelsesinformasjon Parameter etterfag har endret type fra opplaeringsfag[] til referanse[].kompetansemaalsett.kompetansemaalsett Parameter etteraarstrinn har endret type fra kodeverkverdi[] til hjelpedataverdi[].kompetansemaalsett.kompetansemaalsett Parameter kompetansemaal har endret type fra kompetansemaal[] til kompetansemaalreferanse[] Respons fra metode HentPlanFraKode: laereplan.kompetansemaalsett.hovedomraader.kompetansemaalsett.hovedomraader Parameter typeutdanningsprogram har endret type fra kodeverkverdi til hjelpedataverdi Respons fra metode HentUtdanningsprogramFraKode: utdanningsprogram Respons fra metode HentUtdanningsprogramFraPsi: utdanningsprogram

7 Parameter erstatterutdanningsprogram har endret type fra kjerneelementreferanse[] til referanse[] Respons fra metode HentUtdanningsprogramFraKode: utdanningsprogram Respons fra metode HentUtdanningsprogramFraPsi: utdanningsprogram Parameter foerstesemester har endret type fra kodeverkverdi til hjelpedataverdi Respons fra metode HentUtdanningsprogramFraKode: utdanningsprogram Respons fra metode HentUtdanningsprogramFraPsi: utdanningsprogram Parameter sistesemester har endret type fra kodeverkverdi til hjelpedataverdi Respons fra metode HentUtdanningsprogramFraKode: utdanningsprogram Respons fra metode HentUtdanningsprogramFraPsi: utdanningsprogram Parameter aarstrinn har endret type fra kodeverkverdi til hjelpedataverdi Parameter byggerpaaprogramomraade har endret type fra kjerneelementreferanse[] til referanse[]

8 Parameter erstatterprogramomraade har endret type fra kjerneelementreferanse[] til referanse[] Parameter tilknyttedeutdanningsprogram har endret type fra kjerneelementreferanse[] til referanse[] Parameter tilknyttedelaereplaner har endret type fra kjerneelementreferanse[] til referanse[] Respons fra metode HentMerkelappFraKode: Merkelapp Respons fra metode HentMerkelappFraPsi: Merkelapp Parameter merknadstype har endret type fra kodeverkverdi til hjelpedataverdi Parameter dokumenttype har endret type fra kodeverkverdi[] til hjelpedataverdi[]

9 Parameter relatertefag har endret type fra kjerneelementreferanse[] til referanse[] Parameter relaterteaarstrinn har endret type fra kodeverkverdi[] til hjelpedataverdi[] Parameter tilknyttedefag har endret type fra kjerneelementreferanse[] til referanse[] Respons fra metode HentMerkelappFraKode: Merkelapp Respons fra metode HentMerkelappFraPsi: Merkelapp Parameter tilknyttedeprogramomraader har endret type fra kjerneelementreferanse[] til referanse[] Respons fra metode HentMerkelappFraKode: Merkelapp Respons fra metode HentMerkelappFraPsi: Merkelapp Parameter fagkategori har endret type fra fagkategorireferanse til referanse Respons fra metode HentFagomraadeFraKode: fagomraade Respons fra metode HentFagomraadeFraPsi: fagomraade

10 Oppsummering av endringer som ikke bryter kontrakten Metoder som har blitt lagt til FinnFagkoder HentFagkodeFraKode HentFagkodeFraPsi FinnOpplaeringsfag HentOpplaeringsfagFraKode HentOpplaeringsfagFraPsi FinnKompetansemaal HentKompetansemaalFraKode HentKompetansemaalFraPsi Parametere som har blitt lagt til valgtspraak av typen String i metoden FinnPlaner input: laereplansoekrequest.valgtspraak valgtspraak av typen String i metoden HentPlanFraKode input: hentlaereplanfrakoderequest.valgtspraak programomraaderefernser av typen referanse[] i metoden Respons fra metode HentPlanFraKode: laereplan.programomraaderefernser valgtspraak av typen String i metoden HentPlanFraPsi input: hentlaereplanfrapsirequest.valgtspraak programomraaderefernser av typen referanse[] i metoden Respons fra metode HentPlanFraPsi: laereplan.programomraaderefernser valgtspraak av typen String i metoden FinnUtdanningsprogram input: utdanningsprogramsoekrequest.valgtspraak valgtspraak av typen String i metoden HentUtdanningsprogramFraKode input: hentutdanningsprogramfrakoderequest.valgtspraak valgtspraak av typen String i metoden HentUtdanningsprogramFraPsi input: hentutdanningsprogramfrapsirequest.valgtspraak valgtspraak av typen String i metoden FinnProgramomraader input: programomraadesoekrequest.valgtspraak valgtspraak av typen String i metoden HentProgramomraadeFraKode input: hentprogramomraadefrakoderequest.valgtspraak merkelapper av typen referanse[] i metoden Respons fra metode HentProgramomraadeFraKode: programomraade.merkelapper valgtspraak av typen String i metoden HentProgramomraadeFraPsi input: hentprogramomraadefrapsirequest.valgtspraak merkelapper av typen referanse[] i metoden Respons fra metode HentProgramomraadeFraPsi: programomraade.merkelapper valgtspraak av typen String i metoden FinnMerknader input: merknadersoekrequest.valgtspraak valgtspraak av typen String i metoden HentMerknadFraKode input: hentmerknadfrakoderequest.valgtspraak

11 valgtspraak av typen String i metoden HentMerknadFraPsi input: hentmerknadfrapsirequest.valgtspraak valgtspraak av typen String i metoden FinnMerkelapper input: merkelappsoekrequest.valgtspraak valgtspraak av typen String i metoden HentMerkelappFraKode input: hentmerkelappfrakoderequest.valgtspraak valgtspraak av typen String i metoden HentMerkelappFraPsi input: hentmerkelappfrapsirequest.valgtspraak valgtspraak av typen String i metoden FinnFagomraader input: fagomraadersoekrequest.valgtspraak valgtspraak av typen String i metoden HentFagomraadeFraKode input: hentfagomraaderfrakoderequest.valgtspraak valgtspraak av typen String i metoden HentFagomraadeFraPsi input: hentfagomraaderfrapsirequest.valgtspraak valgtspraak av typen String i metoden FinnFagkategori input: fagkategorisoekrequest.valgtspraak valgtspraak av typen String i metoden HentFagkategoriFraKode input: hentfagkategorifrakoderequest.valgtspraak valgtspraak av typen String i metoden HentFagkategoriFraPsi input: hentfagkategorifrapsirequest.valgtspraak