Webservicen anvendes til afhentning af FTU ansøgninger (Fælles Tilmelding til Ungdomsuddannelserne) til ungdomsuddannelser og 10. klasse. Ansøgningerne oprettes af 9. og 10. klasses elever i grundskolen eller uden for skole (UFS) ansøgere, som ikke går i grundskolen.
Leverandører med en aftale om udveksling af data med STIL, kan hente data fra Optagelse.dk. Læs mere om, hvordan du får en aftale om adgang.
Den enkelte institution skal give systembrugeren adgang til at hente data fra institutionen. Læs mere tildeling af systembrugeradgang i Optagelse.dk.
Webservicen er lukket for afhentning af ansøgninger. |
STIL arbejder på at flytte afhentning af ansøgninger til STILs integrationsplatform, i stedet for den nuværende direkte integration til Optagelse.dk.
Fra 22. marts 2022 vil nye ansøgninger til skoleår 2021/22 skulle afhentes fra den nye webservice. Fra tidligst november 2022 skal alle ansøgninger hentes fra den nye webservice. Den gamle webservice lukkes. |
Download zip med webservice beskrivelse (WSDL and XSD), for denne webservice. Vær opmærksom på, at STIL ikke vil fortsætte med at levere en zip med WSDL og XSD for fremtidige versioner fra denne webservice. Oplysningerne kan i stedet udtrækkes fra endpoint. Old schema Download zip med webservice beskrivelse (WSDL and XSD), for denne webservice. Vær opmærksom på, at STIL ikke vil fortsætte med at levere en zip med WSDL og XSD for fremtidige versioner fra denne webservice. Oplysningerne kan i stedet udtrækkes fra endpoint. |
Basic Authentication med webservice brugernavn og adgangskode.
Kan ses i zip-filen med webservice beskrivelsen. Se Endpoints afsnittet ovenfor. |
Webservice beskrivelsen (WSDL og XSD) kan trækkes ud fra endpoint. Beskrivelsen indeholde beskrivelse af felter, datatyper, felt længder, angivelser af om felter er obligatoriske eller ej, felt beskrivelse, osv.
Tjenesten består af følgende operationer/metoder, som gennemgås nedenfor:
Metoden echo er en simpel operation til afprøvning af en klient. Operationen er opsat med samme restriktioner som find-operationerne nedenfor, men returnerer blot et simpelt svar på en hello-parameter.
| Navn | Type | Beskrivelse |
|---|---|---|
| hello | String* | Simpel parameter til testformål. |
For at hente FTU-ansøgninger skal man først hente en liste af ID'er. Søgningen foregår ved hjælp af institutionsnummer via metoden findFtuApplicationIds(…).
De returnerede ID'er kan derefter benyttes til at kalde metoden findFtuApplication-ById(...) for at få returneret hver enkelt ansøgning.
| Navn | Type | Beskrivelse |
|---|---|---|
| institutionNumber | String* | Modtagende institution/postkasse for ansøgningerne. Hvis der også ønskes ansøgninger for underinstitutioner, markeres det med flaget alsoSubInstitutions, som beskrevet nedenfor. |
| fromDate | Date | Hvis datoen angives, hentes kun ansøgninger fra og med denne dato. |
| toDate | Date | Hvis datoen angives, hentes kun ansøgninger frem til og med denne dato. |
| educationType | Enum | Beskriver den type af uddannelser, man kan forespørge efter. Hvis værdien udelades, spørges efter alle typer. Kun værdierne TENTH_GRADE, UPPER_SECONDARY, VOCATIONAL og OTHER_ACTIVITIES understøttes. |
| onlyNew | boolean | Hvis værdien er TRUE, hentes kun ikke allerede afhentede ansøgninger. Standardværdien er FALSE. |
| alsoSubInstitutions | boolean | Hvis værdien er TRUE, hentes også ansøgninger for underinstitutioner. Standardværdien er FALSE. |
Metoden fremsøger en FTU-ansøgning på baggrund af et ansøgnings-ID (ftuApplicationId) og et institutionsnummer. Institutionsnummeret angiver den institution, der ønsker at hente ansøgningen. Listen af FTU-ansøgnings-ID'er hentes først ved at kalde metoden findFtuApplicationIds(...).
Operationen returnerer en FTU-ansøgning, indeholdende XML specificeret i XML-skemaet FtuEducationPlanList.xsd.
| Navn | Type | Beskrivelse |
|---|---|---|
| institutionNumber | String* | Modtagende institution for ansøgningerne. |
| ftuApplicationId | Integer* | Det unikke ID for en FTU-ansøgning. |
Metoden fremsøger en FTU-ansøgnings-PDF på baggrund af et ansøgnings-ID (ftuApplicationId ) og et institutionsnummer. Institutionsnummeret angiver den institution, der ønsker at hente ansøgningen. Listen af FTU-ansøgnings-ID'er hentes ved at kalde metoden findFtuApplicationIds(...).
Hvis der ikke er fejl, returnerer operationen en FTU-ansøgning som PDF i Base64-encodede bytes
| Navn | Type | Beskrivelse |
|---|---|---|
| institutionNumber | String* | Modtagende institution/postkasse for ansøgningerne. |
| ftuApplicationId | Integer* | Det unikke ID for en FTU-ansøgning. |
Metoden returnerer en temporær URL, der skal anvendes til afhentning af en zip-fil med bilagene til en ansøgning. Zip-filen indeholder også selve ansøgningen i hhv. pdf-format og xml-format. Samtidig vil ansøgningen blive markeret som afhentet, hvis brugeren (kalderen af denne webservice-metode) er berettiget til det.
Filnavne genereres ud fra følgende oplysninger, som er alle er tilknyttet ansøgningens ID (ftuApplicationId):
Bilagene har filformatet <cpr>-<applicantid>-<bid>.pdf. Ansøgningerne har filformatet <cpr>-<appid>.pdf og <cpr>-<appid>.xml. Endeligt har zip-filen filformatet <cpr>-<appid>.zip.
| Navn | Type | Beskrivelse |
|---|---|---|
| institutionNumber | String* | Modtagende institution/postkasse for ansøgningerne. |
| ftuApplicationId | Integer* | Det unikke ID for en FTU-ansøgning. |
Metoden findApplicationsWithNoLegalClaimRequest returnerer en liste af ID'er med de ansøgere, der enten ikke lever op til retskravet ift. optagelse på en ungdomsuddannelse eller for hvem Optagelse.dk ikke har oplysninger nok til at afgøre, om de lever op til retskravet.
ID'erne kan efterfølgende anvendes i findFtuApplicationById til at hente den opdaterede ansøgning.
| Navn | Type | Beskrivelse |
|---|---|---|
| institutionNumber | String* | Modtagende institution/postkasse for ansøgningerne. Hvis der også ønskes ansøgninger for underinstitutioner, markeres det med flaget alsoSubInstitutions, som beskrevet nedenfor. |
| fromDate | Date | Hvis datoen angives, hentes kun ansøgninger fra og med denne dato og fremad. |
| toDate | Date | Hvis datoen angives, hentes kun ansøgninger frem til og med denne dato. |
| alsoSubInstitutions | boolean | Hvis værdien er TRUE, hentes også ansøgninger for underinstitutioner. Standardværdien er FALSE. |
Ved fejlsituationer returneres generelt en af følgende fejlmelding:
| Kode | Beskrivelse |
|---|---|
| NO_DATA | Hvis søgningen intet finder. |
| INVALID_INPUT | Hvis inputdata ikke er gyldige. |
| ILLEGAL_ACCESS | Hvis autentifikation eller autorisation ikke lykkes. Dette er en ekstra kontrol, som foretages efter UNI-Login. Denne fejl angiver, at brugeren enten ikke har den korrekte rolle eller ikke har adgang til at afhente den angivne institutions ansøgninger. |
| INSTITUTION_NOT_FOUND | Det angivne institutionsnummer matcher ikke institutionsnummer i Optagelse.dk. |