Versjonsendringer FS-API

Generelt

Gjeldende versjon

Finnes ved å sjekke disse:

https://api.fellesstudentsystem.no/version
https://fsapi-test.uio.no/version

Versjonering

Prinsipper for versjonering er beskrevet her:

https://semver.org/spec/v2.0.0.html

Versjon 1.6.0

NB! Viktig!

Bak en av bugfixene (FSWS-2936, merket med ********** under) skjuler det seg et større antall rettelser av navn på lister/elementer for XML (der disse typisk har vært like i stedet for flertall/entall).

Slike "breaking changes" skal normalt kun slippes ved såkalt "major release" (nivå 1, der neste er 2.0.0) - hvis det ikke er snakk om rene feilrettinger, og da skal de annonseres tydelig på denne siden. Vi beklager at dette ikke er blitt gjort denne gang, og ber XML-brukerne gå nøye igjennom listen av ressurser/felt under og sikre at klientene deres tar høyde for endringene.

Kjente feil

[FSWS-3030] - Vurderingskombinasjoner feiler for noen felt i noen baser
Det kan forekomme at Example Value ikke stemmer overens med faktiske navn på elementer

Feature Request

[FSWS-2415] - Person: Filtrere på liste av IDer (personløpenumre)
[FSWS-2798] - Vurderingskombinasjon: Overliggende/underliggende kombinasjoner
[FSWS-2830] - Vurderingsenhet: Filter på ÅrTermin-Gjelder-I
[FSWS-2900] - Person: Blanking av epostadresse og brukernavn via PATCH

Improvement

[FSWS-2092] - Person: Komplettere mhp. dekning av BAS SOAP
[FSWS-2113] - Person: Komplettere POST (Fagperson)
[FSWS-2150] - Undervisningsaktivitet: Legge til uketimer
[FSWS-2754] - Studierett: Utvidet Nullable-funksjonalitet
[FSWS-2810] - Emne: Terminer for undervisning og vurdering
[FSWS-2836] - Studentund.aktivitet: Feilretting + Ytelsesforbedring
- Feilen kunne gi for mange treff ved bruk av ugyldig kombinasjon av filtre
- Større gevinst ved å ikke velge å returnere "tunge" felt
[FSWS-2917] - Utrulling: Droppe pakker som ikke lenger brukes
[FSWS-2921] - Utrulling: Rekompilering gir unødvendig behov for flush av datakilder
[FSWS-2938] - MQ: URL-encoding av referanser sendt til MQ
[FSWS-2940] - Oppslag på alternative nøkler bør behandles som individkall
- Person: Brukernavn, Studentnr
- Deltaker: Personløpenr
[FSWS-2954] - Studierett: Filter på fra/tilDato med kombinert Nullable/Interval, default, grace-periode
- Begge har Interval-funksjonalitet og sammenligner default med dagens dato
- tilDato kan teste på kombinert Nullable/Interval (før/etter dato hvis satt)
[FSWS-3022] - MQ: Bedre feilhåndtering

Technical debt

[FSWS-2995] - Person: Ytelsesforbedringer når man ikke velger "tunge" felt

Bug

[FSWS-2842] - Studieprogram: Leverer ikke liste av Emner
[FSWS-2892] - Emnekombinasjon: To filtre som ikke funker
- emnekategori.kode
- studieretning.kode
[FSWS-2929] - Person: POST feiler på PersonAkseptanse
[FSWS-2930] - Collection-kall tar ikke hensyn til query-parameter dbId
[FSWS-2935] - Akseptansetype: Lange beskrivelsesfelt sprekker
- Rettet til lang variant (som foreløbig har en litt annen struktur, vil harmoniseres etterhvert)
[FSWS-2936] - Rette XML-visning og -schemaer (navn i JSON-schema) **********
- Følgende ressurser har nå fått korrekte liste- og elementnavn (NB! se nytt avsnitt + kjent feil over):
  - /emne
    - organisasjonsenheter / organisasjonsenhet
    - semesterperioder / semesterperiode
  - /rom
    - organisasjonsenheter / organisasjonsenhet
    - urler / url
  - /semestre
    - perioder / periode
  - /deltakere
    - adresser / adresse
    - eposter / epost
    - telefoner / telefon
  - /semesterregistreringer
    - organisasjonsenheter / organisasjonsenhet
  - /veiledningsforhold
    - eposter / epost
    - telefoner / telefon
    - adresser / adresse
    - veiledningsmoterPrSemester / veiledningsmotePrSemester
  - /undervisningsenheter
    - perioder / periode
  - /karakterregler
    - karakterer / karakter
  - /kommisjoner
    - organisasjonsenheter / organisasjonsenhet
  - /studentvurderinger
    - semestre / semester
    - organisasjonsenheter / organisasjonsenhet
    - emner / emne
    - vektinger / vekting
    - karakterer / karakter
    - studieprogrammer / studieprogram
[FSWS-2977] - MQ: IllegalArgumentException i noen tilfeller
[FSWS-2996] - MQ: Feiler for FSBOTTSA
[FSWS-2999] - Avvik mellom Swagger-eksempler og payload
[FSWS-3005] - Vurderingsenhet/Studentvurdering: Feil datoformat
[FSWS-3028] - Person: Filter på Person som ikke finnes ga inaktivt filter
- Personbilde
- Personrolle
- Semesterregistrering
- Studierett
Andre mindre feilrettinger og forbedringer

New Feature

[FSWS-2893] - Studieprogram: Lagt til Vekting og NUS-kode

Task

[FSWS-2871] - Konsolidering av autentisering/autorisering
[FSWS-2933] - Veiledningsforhold: Pakke inn i CASE + Label på veileder-ref
[FSWS-3003] - Deprecate SemReg-filtrene
- De obskure filtrene rundt "registreringsperiode" er ikke lenger nødvendige (de kobler mot informasjon som finnes i Semester-ressursen)

Versjon 1.5.0

Kjente feil

GET /emnekombinasjoner har problemer med flere filtre. (Ressursen er i pilot, og ikke tilgjengelig for alle)

Feature Request

[FSWS-2649] - UndAktivitet - Legg til Status_Ekvivalent
[FSWS-2663] - Studierett - Filter på endringsdato
[FSWS-2748] - Emne - Terminer for undervisning og vurdering
[FSWS-2805] - GET vekting og NUS-kode fra /emner

Improvement

[FSWS-2149] - Legge til Eksport Timeplan (J/N) i Undervisning
[FSWS-2379] - Fjerne Person.Bilde J/N
[FSWS-2746] - Bedre ytelse i Person ved å skille ut Student og Fagperson
[FSWS-2779] - Validering på date og datetime felt
[FSWS-2791] - Inkonsistent bruk av felt i subressurs studierett.semester årstall i veiledningsforhold.

New Feature

[FSWS-2410] - Ny ressurs Kommune

Bug

[FSWS-2624] - Swagger-eksempel for /undervisning/id viser feil i emne-ref i ID
[FSWS-2631] - Oper-filtre i Swagger må fjernes
[FSWS-2813] - Legge til refId i Swagger
[FSWS-2886] - /fnrendringer returnerer tomme verdier hvis person ikke eksisterer
[FSWS-2888] - Fields med flere felt fungerer ikke
[FSWS-2899] - GET /veiledningsforhold leverer tomme felt/ID med 0-komponenter (".../0,0,0", "/null,null,null,null")

Task

[FSWS-1730] - Caching av ressurser som sjelden endres
[FSWS-2405] - Deprecate embedded Kommuner

Versjon 1.4.3

Generelt

Denne versjonen gir en generell forbedring av ytelse (rundt 2-5x) på ID-kall
NB! Alle anbefales å bruke dbId=true i alle spørringer, da false er uryddig og kan gi navnekollisjoner mellom ID og payload (i versjon 2.0.0 vil true være default)
Neste versjon er 1.5.0, som kommer i Test + Prod medio juni

Kjente feil

GET /veiledningsforhold leverer feilaktige ID-forekomster med 0-komponenter (".../0,0,0"). (Ressursen er i pilot, og ikke tilgjengelig for alle)
GET /emnekombinasjoner har problemer med flere filtre. (Ressursen er i pilot, og ikke tilgjengelig for alle)

Feature Request

[FSWS-2764] - GET /evukurs: Legge til opptaksperiode for EVUWeb3

New Feature

[FSWS-2452] - MQ for resten av vurderingsområdet

Improvement

[FSWS-2614] - Ytelsesforbedring for ID-oppslag
[FSWS-2629] - Fjern bruk av typelabel i ID i JSON-eksempler
[FSWS-2674] - Forbedre swagger.json og andre definisjoner
[FSWS-2720] - Rusk rundt DatoIntervall i GET/POST

Bug

[FSWS-2624] - Swagger-eksempel for /undervisning/id viser feil i emne-ref i ID
[FSWS-2651] - Gjennomgang av nye ressurser i Swagger mhp. fields og paginering
[FSWS-2716] - Bruk av filter aktiv=true/false i sprak returnerer status 400.
[FSWS-2721] - Rette beskrivelse av /studentundervisningsaktiviteter/id
[FSWS-2725] - "null" er tillatt og blir konvertert til 0 i numerisk felt
[FSWS-2727] - Sette riktig server tid
[FSWS-2729] - Sjekk alle Timestamp felt
[FSWS-2730] - Spesialtegn i ID gir 404 Not Found
[FSWS-2731] - GET /personer/id/bilde gir 500
[FSWS-2732] - GET /vurderingsenheter: Institusjonsfilter fungerer ikke
[FSWS-2733] - GET /fnrendringer gir "504 Gateway Time-out" i test
[FSWS-2740] - Feil oppdaget gjennom testing av simulert individ kall
[FSWS-2752] - Person.Eposter returneres bare hvis PRIVAT Epost er satt
[FSWS-2727] - Feil tidssone (Europe/London) på server
[FSWS-2789] - POST /personer/ID/personbilde returnerer 5005
[FSWS-2790] - Inkonsistent bruk av semester/termin i /studieretter
[FSWS-2792] - GET /emner leverer ikke "semesterperiode" i "studieprogrammer"
[FSWS-2793] - GET /tilbudsstatuser: Filter på prioritet fungerer ikke
[FSWS-2811] - Feil i JSON-eksempler
[FSWS-2838] - XML example cannot be generated

Task

[FSWS-2468] - Lage tester for å fange opp mismatch m/Swagger mhp. fields/sortering/paginering
[FSWS-2770] - JSON log-layout - sørge for at level blir uendret

Versjon 1.4.2

Kjente feil

GET /veiledningsforhold leverer feilaktige ID-forekomster med 0-komponenter (".../0,0,0"). (Ressursen er uansett i pilot, og ikke tilgjengelig for alle)

Bug

[FSWS-2686] - Bedre sperring (med melding i Swagger) ved utrulling
[FSWS-2702] - Studentundervisning - Filtre med annet enn = fungerer ikke
[FSWS-2704] - POST /personer/id inkrementerer Studentnr
[FSWS-2706] - Feil i eksempelet i Swagger for POST emnekombinasjoner/{id} (beskrivelser inneholder sprakkode)
[FSWS-2707] - Kall på emnekombinasjoner/{id}?fields=emner returnerer status 500 når vektinger har verdier i emner

Versjon 1.4.1

Kjente feil

/veiledningsforhold leverer feilaktige ID-forekomster med 0-komponenter (".../0,0,0"). (Ressursen er uansett i pilot, og ikke tilgjengelig for alle)

Bug

[FSWS-2435] - Person - Oppdatering av LanetakerID fungerer ikke
[FSWS-2486] - Bedre feilmeldinger på integritetsbrudd
[FSWS-2633] - Legge på manglende ID-filtre i /semestre
[FSWS-2643] - /veiledningsforhold med wildcard-filter returnerer 500
[FSWS-2650] - Bygninger og Rom mangler fields og paginering i Swagger
[FSWS-2665] - Collection-kall viser limit=10 selv om paginering ikke er aktiv
[FSWS-2666] - emnekombinasjoner skal være åpent for lesing
[FSWS-2670] - Feilaktige/manglende wildcard-angivelser
[FSWS-2684] - Emnekombinasjon - Beskrivelser må utvides til 4000 tegn

Versjon 1.4.0

New Feature

[FSWS-2495] - Knytte Bygning og Rom til Fagperson
[FSWS-2451] - MQ for Vurderingsenhet + StudentVurdering
GET/emnekombinasjoner
POST/emnekombinasjoner
GET/emnekombinasjoner/{id}
POST/emnekombinasjoner/{id}
DELETE/emnekombinasjoner/{id}/emner/{emne}
GET /veiledningsforhold
GET /veiledningsforhold({id}
GET /praksistyper
GET /praksistyper/{id}

Improvement

[FSWS-2422] - Standardisere Swagger-dokumentasjon for typeannotasjoner
[FSWS-2492] - Misvisende POST-feilmelding "duplicate id"
[FSWS-2498] - Bør filtrere NULL praksiskoder i emne uttrekk
[FSWS-2539] - Individkall - Ignorere sortering/paginering istf. å gi feilmelding
[FSWS-2569] - POST/DELETE i Koder må autentiseres
[FSWS-2589] - Mulighet for å angi dbId i Swagger
[FSWS-2590] - Dokumentere mulighet for å angi dbId i Swagger

Bug

[FSWS-2423] - Studieretter - Filter på studentstatus.aktivStudent fungerer ikke
[FSWS-2430] - Vurderingsenheter++: Filtre på ID-komponenter er inaktive
[FSWS-2431] - Vurderingsenheter/ID++: Feil i ledetekst
[FSWS-2432] - Vurderingsenheter/ID++: Feil format på klokkeslett
[FSWS-2433] - Vurderingsenheter++: Gale JSON-navn på filtre
[FSWS-2453] - Organisasjonsenheter - Fjerne fields-parameter
[FSWS-2456] - Språk mangler paginering i Swagger
[FSWS-2466] - Rette feil og mangler i Swagger
[FSWS-2475] - Personer/{id}/pinkode fungerer ikke
[FSWS-2486] - Bedre feilmeldinger på integritetsbrudd
[FSWS-2491] - Vurderingsenheter++: Paginering er inaktiv
[FSWS-2500] - Studieretter - Filter studentstatus.aktivStudent fungerer ikke
[FSWS-2543] - Kommisjoner - Legge til manglende sorteringsfunksjonalitet
[FSWS-2549] - Vurderingsenheter - Feil på klokkeslett
[FSWS-2563] - Feil format på fødselsdato
[FSWS-2564] - Collection-spørringer viser ikke alltid "last"
[FSWS-2600] - MQ-feil for /studentundervisningsaktiviteter
[FSWS-2608] - Personer - fields=personnummer har ingen effekt, mens fields=fodselsdato returnerer både fodselsdato og personnummer
[FSWS-2620] - "." er ikke konvertert i filter
[FSWS-2623] - Wildcard i filter på ID-komponenter må konverteres korrekt
[FSWS-2636] - Instrumenttype - Legge på manglende annotasjonsfunksjonalitet

Task

[FSWS-2373] - Fjerne %_Ekvivalent_Med i Vurderingskombinasjon
[FSWS-2455] - Flytte /instrumenttyper til Koder
[FSWS-2538] - Fjerne mulighet for å bruke filter i individkall
[FSWS-2554] - Språk har sorteringsparameter som ikke brukes
[FSWS-2587] - Justere Praksis-området ifht. tabellendringer
[FSWS-2594] - Håndtere navneendring fra Praksistype til Undpraksistype i basen
[FSWS-2610] - Person/Deltaker - Sjekke Swagger vs. funksjonalitet
[FSWS-2618] - Swagger - Rydde i dokumentasjon av NTNU-ressurser
[FSWS-2628] - Synce tagging med Wildcard++ i Swagger med koden
[FSWS-2638] - Merk Språk-referanse i felt som merknad, navn osv. som Deprecated

Versjon 1.3.0

New Feature

[FSWS-2116] - GET Vurderingskombinasjoner og GET Vurderingskombinasjoner {id}
[FSWS-2117] - GET Vurderingsenheter og GET Vurderingsenheter {id}
[FSWS-2118] - GET Kommisjoner og GET Kommisjoner {id}
[FSWS-2119] - GET VurderingsresultatStatuser og VurderingsresultatStatuser {id}
[FSWS-2120] - GET Vektingstyper og GET Vektingstyper {id}
[FSWS-2126] - GET Vurderingsordninger og GET Vurderingsordninger {id}
[FSWS-2153] - GET StudentVurderinger og GET StudentVurderinger {id}
[FSWS-2192] - GET Vurderingstider og GET Vurderingstider {id}
[FSWS-2108] - GET Vektingstyper og GET Vektingstyper {id}
[FSWS-2193] - GET Instrumenttyper og GET Instrumenttyper {id}
[FSWS-2196] - GET Karakterer og GET karakterer {id}
[FSWS-2171] - GET Bygning og GET Bygning {id}
[FSWS-2122] - GET Rom og GET Rom {id}
[FSWS-2334] - Ressurs for å avlevere studentens PIN-kode

Improvement

[FSWS-2331] - Tester og opprydding for Vurdering som helhet
[FSWS-2362] - Justere Studentvurdering etter JSON-møte
[FSWS-2411] - GET Person - Filter på Studentnr og Fnr

Bug

[FSWS-2368] - Fjerne unødvendig join med KvalGrunnlag i Person
[FSWS-2419] - POST Person - Låntaker-ID blir ikke oppdatert

Task

[FSWS-2369] - Deprecate %_Ekvivalent_Med i Vurderingskombinasjon
FSWS-2392] - Deprecate Person.Bilde J/N
[FSWS-2386] - Inline resterende SCRIPT-referanser (i tillegg til Grants

Versjon 1.2.2

En stor del av arbeidet siden forrige release er gått til utbedringer og omstruktureringa av det underliggende i FS-API. Vi legger opp til hyppigere releaser framover.

Noen nye ressurser, datafelt, filtre og fixer er med

[FSWS-1980] - Flere datafelt for person (app)
[FSWS-1997] - epost, adresse, bibsys (app)
[FSWS-1998] - Ny tjeneste GET Person/Bilde (app)
[FSWS-2037] - Nye tjenester POST/DELETE Person/Bilde (app)
[FSWS-2105] - Legge til filter for Studentnr og Fnr på Person (app)
[FSWS-2265] - Bruke meny for Registreringsperiode++ i EVUkurs
[FSWS-2237] - Utvide Rollenr fra 4 til 5 siffer i Personrolle_ID_T
[FSWS-1999] - Paginerte endepunkter og 'limit'
[FSWS-2039] - Komplettere toppnivået i Personer (app)
[FSWS-2258] - NB NB - Fjerning av filterfelt i SemReg som ikke er i bruk (app)
[FSWS-2259] - Diverse bugfix

Versjon 1.1.3.10

	Nye ressurser (flate felt i eksisterende ressurser erstattet med referanser) *
	Ressurs	Tidligere flate felt
FSWS-1912	semestre	ar + termin
FSWS-1888	tilbudsstatuser	tilbudstatus
FSWS-1883	studieretninger	studieretning
	foretak	foretak
	kullklasser	studieprogram + ar + termin + klasse

*	I noen tilfeller er prefiks på navn endret til type-label i referanse (f.eks. kullSemester => semester (KULL))


	Strukturering av flate felt
	Ressurser	Felt	Til
FSWS-1943	campuser	fylke/kommune	Inline infostruktur
FSWS-1943	studieretter, evukurs	(studierett)status	Inline infostruktur
FSWS-1943	studieretter	studentstatus	Inline infostruktur
FSWS-1943	studieretter	begrensetStudierettstatus	Inline infostruktur
FSWS-1705	Diverse	epost	Inline infostruktur
	personer	kvalifikasjonsgrunnlag	Ref. til ressurs

	Standardisering av type-labels
	Ressurs	Felt	Gammel label	Ny label
	personer	adresse	HJEM	PRIVAT
	personer	organisasjonsenhet	GODKJENT_STUDIEKOMP	GODKJENT_GSK
	Diverse	semesterregistreringsPeriode	REG BAS UTDPLAN STUDINFO STUDSEM	REGISTRERING BAS_EKSPORT UTDANNINGSPLAN STUDIEINFO STUDIESEMESTER

I tillegg er det fjernet noen felt som ikke er i bruk i FS.

Det er også ryddet opp i navngiving av felt, for å bli mere konsistent. Dessverre har vi ikke funnet noen farbar vei for å liste opp alle disse endringene, så man må nesten la det feile, felt for felt. Trøsten er at dette er siste store endring av denne typen.

Release 03.07.2018

Fjernet unødvendig nivå "self" i ID'er og referanser
Harmonisert type-labels (f.eks. er "ADMIN" blitt "ADMINISTRATIVT")
Ryddet opp i strukturen til EVU-kursdeltaker
Nye ressurser /land, /fag og /kvalifikasjonsgrunnlag
Div. opprydding og smårettelser

Publisert 4. juni 2018 13:03 - Sist endret 19. okt. 2020 14:38

Versjonsendringer FS-API

Generelt

Gjeldende versjon

Versjonering

Versjon 1.6.0

NB! Viktig!

Kjente feil

Feature Request

Improvement

Technical debt

Bug

New Feature

Task

Versjon 1.5.0

Kjente feil

Feature Request

Improvement

New Feature

Bug

Task

Versjon 1.4.3

Generelt

Kjente feil

Feature Request

New Feature

Improvement

Bug

Task

Versjon 1.4.2

Kjente feil

Bug

Versjon 1.4.1

Kjente feil

Bug

Versjon 1.4.0

New Feature

Improvement

Bug

Task

Versjon 1.3.0

New Feature

Improvement

Bug

Task

Versjon 1.2.2

Versjon 1.1.3.10

Strukturering av flate felt

Standardisering av type-labels

Release 03.07.2018