Webservicen IndberetUPV erstatter den udgåede webservice CompetenciesService, som anvendes af grundskoler til at indberette Uddannelsesparathedsvurderinger (UPV) for deres elever til Optagelse.dk. Uddannelsesparathedsvurderingerne indberettes til alle elever i 8., 9. og 10. klasses elever i grundskolen to gange per skoleår.
NYT I DENNE VERSION af dette dokument: Se gul markering i Felter i svar fra webservicen.
Plan for overgang til ny webservice
Den nye webservice IndberetUPV skal anvendes fra 1. november 2022.
Den udgåede CompetenciesService er lukket per 1. august 2022.
De væsentligste ændringer ift. den udgåede webservice
Den nye webservice IndberetUPV er udarbejdet så den mest muligt er lig den udgåede webservice CompetenciesService.
De væsentligste ændringer er:
- at den udstilles på STILs Integrationsplatform.
- at der ved indberetning, skal angives hvilken afdeling (institution) eleven går på.
- at webservicen er lukket for indberetning i perioder i løbet af skoleåret. Se mere under Brug af webservicen.
- at oplysningerne der skal indberettes simplificeres pba. reglerne om at alle skal vurderes til hhv. erhvervsuddannelse, gymnasiet og hf.
Endpoints
Gå til Services
Adgang
Den nye webservice er tilgængelig på STILs Integrationsplatform (IPL) og adgangsstyringen til data sker gennem STILs Tilslutningsystem.
Har dit system ikke tidligere anvendt Integrationsplatformen? Så læs her, hvordan du kommer i gang. Når der anmodes om adgang, skal det kort beskrives, hvad formålet med adgangen er, hvilken opgave systemet, der skal integrere, løser, og hvad det bruges til.
Brug af webservicen
Webservicen består af en metode, der gør det muligt at indberette en elevs uddannelsesparathedsvurderinger for en afdeling med en dataaftale eller en afdeling under en hovedinstitution med en dataaftale.
For at kunne anvende webservicen korrekt, er det vigtigt at kalde med det rigtige institutionsnummer. Læs mere om de forskellige institutionstyper her: Beskrivelse af institutioner
Metoder på webservicen
Indberet uddannelsesparathedsvurderinger
- IndsendUpv(IndsendUpvDto upvDto, int hovedinstitution)
- Tager imod en IndsendUpvDto, som beskriver UPV data for den enkelte elev og en int for hovedinstitution
- Hovedinstitution er institutionsnummeret for den institution, som der er indgået aftale med IPL om
- Metoden returnerer en http status 200, hvis UPV data er gemt korrekt
- Hvis data ikke gemmes returneres en fejlkode og beskrivelse. Det kan f.eks. være ved:
- UPV-perioden er lukket
- Elev i IndsendUpvDto matcher ikke afdelingsnummer
- Der mangler data i IndsendUpvDto
Se yderligere i skemaet 'Felter i svar fra webservicen' nedenfor
Sekvensdiagrammer
Ved første UPV-periodes start, kan skolemedarbejderen via skolens elevadministrative system indberette uddannelsesparathedsvurderinger. Første UPV-periode vil typisk løbe fra 1. november til fristen 1. december.
Ved første UPV-periodes slut, lukkes der for, at webservice kan indsende data til Optagelse.dk. Hvis skolen fx på grund af fejl/mangler har behov for at foretage ændringer efter periode-slut, kan skolemedarbejderen logge ind i Optagelse.dk og manuelt redigere i ønskede uddannelsesparathedsvurderinger.
Tilsvarende er gældende i forhold til afsluttende UPV-periodes start og slut. Afsluttende UPV-periode vil typisk løbe fra medio maj til medio juni. Der kan IKKE redigeres manuelt efter afsluttende periodes slutdato.
Diagrammet nedenfor illustrerer et overblik over skoleåret og de perioder, hvor der er åbnet for at indberette uddannelsesparathedsvurdering via IndberetUPV webservice.
Felter i svar fra webservicen
Herunder kan du se hvilke HTTP statuskoder og svar I kan få tilbage. Eksempler på hvad data der kan forsage de forskellige beskeder er listet herunder i sektionen "Testvejledning og testdata til ny webservice".
| HTTP statuskode | Succeeded | ErrorCode | ErrorMessage | Beskrivelse/ hvad skal man gøre? |
|---|---|---|---|---|
| 200 | true | (null) | (null) | Alt gik godt |
| 500 | false | OPT000 | Der skete en ukendt fejl i optagelse.dk | Indrapporter venligst fejlen hvis den forekommer over flere dage. |
| 1XX Valideringsfejl | ||||
| 400 | false | OPT100 | Dataen du har sendt overholder ikke kontrakten. Verificer venligst at du indsender det korrekte data i den specificerede struktur og med de rigtige datatyper. | Tjek at du indsender korrekt data i den beskrevne format |
| 400 | false | OPT101 | Invalid CPR-value | Tjek at CPR-nummeret kun er tal og uden bindestreg, mellemrum e.l. |
| 400 | false | OPT102 | Invalid Gym-value | Tjek at strukturen og værdierne under gym-feltet er korrekte |
| 400 | false | OPT103 | Invalid Hf-value | Tjek at strukturen og værdierne under hf-feltet er korrekte |
| 400 | false | OPT104 | Invalid Eud-value | Tjek at strukturen og værdierne under eud-feltet er korrekte |
| 400 | false | OPT105 | Invalid Afdelings-value | Tjek at afdelingsnummeret er en tal-værdi |
| 2XX Adgangsfejl | ||||
| 401 | false | OPT200 | Afdeling ligger ikke under din institution | Sikre at I har en dataaftale for skolen eller hovedinstitutionen for skolen |
| 3XX Opsætningsfejl | ||||
| 500 | false | OPT300 | Ingen aktiv UPV-periode | Vent til en ny UPV-periode bliver aktiv (Se yderligre i QA) |
| 500 | false | OPT301 | Eleven er ikke registreret på din skole | Sikre at eleven er registreret på jeres skole (Se yderligre i QA) |
| 500 | false | OPT302 | Eleven er fritaget fra UPV | Når eleven er fritaget fra UPV af KUI i hjemkommunen, kan der ikke indberettes forudsætninger på eleven. Data bør fjernes fra det lokale elevadministrative system eller blot ikke overføres til Optagelse.dk. |
Testvejledning og testdata til ny webservice
Herunder kan du se nogle eksempler på requests/forespørgelser og de svar i kan forvente at få i test-miljøet. Det er de samme svar I vil få i produktion-miljøet hvis lignende fejl opstår i det miljø.
| Forespørgsel | Svar | |||||||||||
CPR | Afdeling | PraksisFaglig | Gym:Personlig | Gym:Social | Hf:Personlig | Hf:Social | Eud:Personlig | Eud:Social | HTTP Statuskode | Succeeded | ErrorCode | ErrorMessage |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1511980070 | 999904 | Høj | true | false | true | true | true | true | 200 | true | (null) | (null) |
| 1511980070 | 999904 | Mellem | false | true | false | true | true | true | 200 | true | (null) | (null) |
| 151198-0070 | 999904 | Høj | true | true | true | true | true | true | 400 | false | OPT101 | Invalid CPR-value |
| 1511980078 | 999904 | Høj | true | true | true | true | true | true | 500 | false | OPT301 | Eleven er ikke registreret på din skole |
| 1511980070 | 999456789 | Høj | true | true | true | true | true | true | 400 | false | OPT105 | Invalid Afdelings-value |
| 1511980070 | 991236 | Høj | true | true | true | true | true | true | 401 | false | OPT200 | Afdeling ligger ikke under din insitution |
| 1511980070 | 999904 | Lav | true | true | true | true | true | true | 400 | false | OPT100 | Dataen du har sendt overholder ikke kontrakten. Verificer venligst at du indsender det korrekte data i den specificerede struktur og med de rigtige datatyper. |
| 1511980070 | 999904 | Mellem | (null) | true | true | true | true | true | 400 | false | OPT100 | Dataen du har sendt overholder ikke kontrakten. Verificer venligst at du indsender det korrekte data i den specificerede struktur og med de rigtige datatyper. |
Mapning af felter mellem den udgåede webservice og den nye webservice
I nedenstående tabel er properties fra den udgåede webservice CompetenciesService beskrevet i venstre side under de grå felter og properties fra den nye webservice i højre side under de grønne felter.
Nogle properties fra den udgåede CompetenciesService udgår. Properties, der udgår, noteres med 'Udgår'.
Den nye IndberetUPV webservice indeholder nye properties, som ikke findes i den udgåede CompetenciesService webservice. Nye properties noteres med '-' i de tre første kolonner i venstre side.
| Property i eksisterende webservice: setCompetencies(CompetenciesRequestType competencies) | Type | Beskrivelse | Property i ny webservice: | Type | Påkrævet | Beskrivelse |
|---|---|---|---|---|---|---|
cpr | String* | A valid CPR number with 10 uppercase alphanumeric digits. First 6 digits are number and rest 4 are uppercase alphanumeric. | Cpr | String | X | CPR-nummer for elev |
| - | - | - | Afdeling | Int | X | Afdelingsinstitutionsnummer for den skole, som eleven går på. |
| - | - | - | PraksisFaglig | Enum | X | Mulige værdier jf. lovgivning:
Bemærk: Denne værdi indberettes fremover for eleven UDEN sammenhæng til en uddannelsestype. |
eud:isPersonalCompetenciesOK | boolean | true= has the competencies, false= doesn't has the competencies. Default value is false ("nej"). If interest is given for eud, then personal competencies is mandatory. | eud:Personlig | boolean | X | true = har personlige forudsætninger for at kunne vurderes parat til EUD false = har IKKE personlige forudsætninger for at kunne vurderes parat til EUD |
| eud:isSocialCompetenciesOK | boolean | true= has the competencies, false= doesn't has the competencies. Default value is false ("nej"). If interest is given for eud, then social competencies is mandatory. | eud:Social | boolean | X | true = har sociale forudsætninger for at kunne vurderes parat til EUD false = har IKKE sociale forudsætninger for at kunne vurderes parat til EUD |
eud:isPracticalCompetenciesOK | boolean | true=has the competencies, false= doesn't has the competencies. Default value is false ("middel"). If interest is given for eud, then practical competencies is mandatory. | Udgår | Udgår | Udgår og erstattes af det nye PraksisFaglig felt. | |
gym:isPersonalCompetenciesOK | boolean | true= has the competencies, false= doesn't has the competencies. Default value is false ("nej"). If interest is given for eud, then personal competencies is mandatory. | gym:Personlig | boolean | X | true = har personlige forudsætninger for at kunne vurderes parat til GYM false = har IKKE personlige forudsætninger for at kunne vurderes parat til GYM |
gym:isSocialCompetenciesOK | boolean | true= has the competencies, false= doesn't has the competencies. Default value is false ("nej"). If interest is given for eud, then social competencies is mandatory. | gym:Social | boolean | X | true = har sociale forudsætninger for at kunne vurderes parat til GYM false = har IKKE sociale forudsætninger for at kunne vurderes parat til GYM |
| gym:isPracticalCompetenciesOK | boolean | true= has the competencies, false= doesn't has the competencies. Default value is false ("middel"). If interest is given for eud, then practical competencies is mandatory. | Udgår | Udgår | Udgår og erstattes af det nye PraksisFaglig felt. | |
hf:isPersonalCompetenciesOK | boolean | true= has the competencies, false= doesn't have the competencies. Default value is false ("nej"). If interest is given for eud, then personal competencies is mandatory. | hf:Personal | boolean | X | true = har personlige forudsætninger for at kunne vurderes parat til HF false = har IKKE personlige forudsætninger for at kunne vurderes parat til HF |
| hf:isSocialCompetenciesOK | boolean | true= has the competencies, false= doesn't have the competencies. Default value is false ("nej"). If interest is given for eud, then social competencies is mandatory. | hf:Social | boolean | X | true = har sociale forudsætninger for at kunne vurderes parat til HF false = har IKKE sociale forudsætninger for at kunne vurderes parat til HF |
| hf:isPracticalCompetenciesOK | boolean | true= has the competencies, false= doesn't have the competencies. Default value is false ("middel"). If interest is given for eud, then practical competencies is mandatory. | Udgår | Udgår | Udgår og erstattes af det nye PraksisFaglig felt. | |
| isInterested | boolean* | true for choosing other activities | Udgår | Udgår | Denne er ikke en del af den nye webservice | |
| other | Udgår | Udgår | Denne er ikke en del af den nye webservice. Fremover indberettes dette af en vejleder og ikke af skolen. |
(QA) Spørgsmål og svar
Q: Hvorfor får jeg svaret "Eleven er ikke registreret på din skole" når jeg indberetter en UPV for en elev?
A: Vi henter elever hver nat fra Elev Databasen. Hvis eleven ikke står registeret på jeres skole/afdeling vil I få ovenstående fejlbesked. For at løse det skal I sikre jer at eleven er registreret på jeres skole i Elev Databasen, og prøve igen dagen efter.
Q: Hvorfor får jeg "Ingen aktiv UPV-periode"?
A: Fordi at der ikke er åbent for indberetning af UPV. Hvis vi er mellem første og afsluttende UPV-periode kan skolemedarbejderen rette UPV'erne via vores brugerflade, men ikke ved brug af webservicen.
Q: Overføres data fra det gamle optagelse.dk?
A: Nej der overføres ikke historiske UPV-data mellem de 2 systemer.
Q: Hvad hvis jeg sender en indberetning ind på et CPR-nummer, som ikke er registreret i CPR-registeret, men er i korrekt format?
A: Optagelse.dk validere ikke CPR-numre i CPR-registeret ved indberetning, så vi tager imod alle CPR-numre der er i korrekt format. Det betyder at vi afviser kun indberetninger på CPR-numre hvis vi ikke kan finde eleven i skolens registeret CPR-numre over elever.