ftuapplicationservice _03_27

Transkript

1 ftuapplicationservice _03_27 URL Tjenesten på Optagelse.dk kan findes via følgende webservice beskrivelse (kræver også login): Test: Præprod: Produktion: Formål Tjeneste til udlæsning og afhentning af ansøgninger fra Optagelse.dk. Tjenesten er forsøgt opbygget efter samme mønster som den oprindelige tjeneste i det gamle optagelse.dk, hvor svaret er en tekststreng indeholdende XML. Sikkerhed Tjenesten er beskyttet af UNI-Login og kræver rollen opt_receiver_applications. I webservice sammenhæng betyder det, at brugernavn og kodeord skal udfyldes som basic authentication i forespørgslens http-header. Derudover kræver adgang til metoderne, at brugeren har ret til at afhente ansøgninger for den angivne institution. En ret som tildeles af institutionens lokale administrator. Test Webservicen kan testes ved at importere nedenstående projekt i SoapUI: ftuapplicationservice wsdl-soapui-project.xml Vælg File -> Import project -> og vælg ovenstående fil som er gemt et lokalt sted: Ændring af endpoint

2 Det er vigtig at være opmærksom på at endpoint skal ændres til at pege mod den testserver som man ønsker at udføre tests på: Testdata Der kan findes eksempler på flere requests i projekterne, her bør testdata ændres til at indeholde data som er valid på testtidspunktet. Operationer Tjenesten består af følgende operationer 1. echo 2. findftuapplicationids 3. findftuapplicationbyid 4. findftuapplicationpdfbyid 5. findftuapplicationenclosureziplinkbyid echo() echo operationen er en simpel operation til at afprøve en klient. Den er opsat med samme restriktioner som find* operationerne, men returnerer blot et simpelt svar på en hello parameter. Paramter: Navn Type Beskrivelse hello String* Simpel parameter til test formål * = Krævet felt findftuapplicationids(...) Denne metode fremsøger en liste af FTU-ansøgnings-ID'er. Listen indeholder ID er for ansøgninger med:

3 prioritet 1 for ansøgere der går i 9. eller 10. klasse (IS Ansøgere) prioritet 1-5 for ansøgere der ikke går i skole lige nu (OOS Ansøgere) Fremsøgningen foregår primært via institutionsnummer. De returnerede ID'er kan derefter benyttes til at kalde metoden findftuapplicationbyid(...) 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 todate educationtype Date Date Enum Hvis sat hentes kun ansøgninger fra og med denne dato og fremad. Hvis fromdate ikke er givet, hentes applikationer oprettet eller opdateret indtil todate hentes. Hvis sat hentes kun ansøgninger frem til og med denne dato. Hvis todate ikke er givet, hentes applikationer oprettet eller opdateret indtil den aktuelle dato hentes. Beskriver den type af uddannelser man kan forespørge efter. Hvis værdien udelades spørges der efter alle typer. Læg mærke til at kun TENTH_GRADE, UPPER_SECONDARY, VOCATIONAL og OTHER_ACTIVITIES værdierne understøttes. onlynew boolean alsosubinstitutions boolean Hvis true så hentes kun ikke allerede afhentede ansøgninger. Standardværdi er false. Hvis true så hentes også ansøgninger for underinstitutioner. Standardværdi er false. * = Krævet felt SOAP UI request and Response for findftuapplicationids(...)

4 findftuapplicationbyid(...) Denne metode fremsøger en FTU-ansøgning på baggrund af et ansøgnings-id og et institutionsnummer. Dette institutionsnummer repræsenterer den institution, der er ved at afhente ansøgninger. Listen af FTU-ansøgnings-ID'er hentes ved at kalde metoden findftuapplicationids(...). Navn Type Beskrivelse institutionnumber String* ftuapplicationid * = Krævet felt Modtagende institution for ansøgningerne. Integer* Det unikke ID for en FTU-ansøgning SOAP UI request and Response for findftuapplicationbyid (...)

5 findftuapplicationpdfbyid(...) Denne metode fremsøger en FTU-ansøgnings-PDF på baggrund af et ansøgnings-id og et institutionsnummer. Dette institutionsnummer repræsenterer den institution, der er ved at afhente ansøgninger. Listen af FTU-ansøgnings-ID'er hentes ved at kalde metoden findftuapplicationids(...). Navn Type Beskrivelse institutionnumber String* ftuapplicationid * = Krævet felt Modtagende institution/postkasse for ansøgningerne. Integer* Det unikke ID for en FTU-ansøgning SOAP UI request and Response for findftuapplicationpdfbyid(...) findftuapplicationenclosurezipurlbyid(...) Denne metode returnerer en url til afhentning af en zip fil med bilagene til en uddannelses plan. Zip filen vil også indeholde selve ansøgning i pdf og xml format. Samtidig vil ansøgningen også blive markeret som afhentet, hvis brugeren (kalderen af denne web service metode) er berettiget til det. Navn Type Beskrivelse

6 institutionnumber String* ftuapplicationis Modtagende institution/postkasse for ansøgningerne. Integer* Det unikke ID for en FTU-ansøgning Responset indeholder en URL, der kan benyttes til at downloade zip-filen. Filnavnet vil være <cpr> - <appid>.zip. Zip-filen indeholder bilag og ansøgning. Ansøgning findes i en xml og pdf version. Filnavnene vil være <cpr> - <appid>.pdf og <cpr> - <appid>.xml. Bilagene følger fil formatet <cpr> - <applicantid> - <bid>.pdf I forhold til tidligere version af af ftuapplicationservice er tegnet * for at indikere valgfag fjernet i pdf-filen, fordi denne oplysning (FTUTESTSUBJECT.TYPE) ikke længere vedligeholdes i Optagelse.dk efter integration til Karakterdatabasen. Kun fag, der er aktuelle i indeværende ansøgningsrunde (dvs. hvor FTUTESTSUBJECT.ACTUAL = 1/true) vil blive vist i pdf-en, sådan som det er registreret i Karakterdatabasen. Desuden vil både pdf-filen og xml-filen kun indeholde relevante karakterer uanset om der måtte være registreret andre karakterer i Karakterdatabase. Der vil således: For en elev i 9. klasse kun blive medsendt 9. klasses standpunktskarakter For en elev i 10. klasse kun blive medsendt 9. klasses eksamenskarakterer og 10. klasses standpunktskarakter For en ansøger udenfor skolen vil der være et særligt bilag, der indeholder prioritering af alle ansøgerens uddannelsesønsker. Dette bilag findes både i en xml og en pdf version. Filnavnet for pdf-versionen følger samme format som andre pdf bilag. Filnavnet for xml-version følger formatet <cpr> - <applicantid> - <bid>.xml. En ansøger udenfor skolen kan via Optagelse.dk hente sine karakterer i Dansk og Matematik fra folkeskolens afgangseksamen fra Statistikdatabasen og vedhæfte dem som bilag til sin ansøgning. Disse karakterer vil tilgængelige i både pdf- og xml. format. Filnavnet for pdfversionen følger samme format som andre pdf bilag. Filnavnet for xml-version følger formatet <cpr> - <applicantid> - <bid>.xml. Forklaring på elementer i filnavnene: cpr: ansøgerens cpr nummer applicantid: ansøgerens id appid: uddanelses plan unikke id (se under 'Eksempel på et udsnit af en XML ftu uddannelses plan med digitale bilag')

7 bid: bilagens unikke id (også benyttet som fil id). Applicantid og appid vil være det samme. SOAP UI request and Response for findftuapplicationenclosurezipurlbyid(...) Svaret har URL'en. Ved at trykke på URL i browseren, vil du få en ZIP-fil. Filnavnet ville være som zip Den indeholder følgende liste over vedhæftede filer. 1. Karakter data pdf file 2. Karakter data xml file 3. Prioritet liste pdf file 4. Prioritet liste xml file 5. Uddannelse plan pdf file 6. Uddannelse plan xml file Eksempler Hent FTU-ansøgninger For at hente FTU-ansøgninger skal man først hente en liste af FTU-ansøgnings ID'er( findftuapplicationids(...) ) og herefter hentes hver ansøgning på baggrund af et FTUansøgnings-ID ( findftuapplicationbyid(...) ). Eksempel på søgning ved hjælp af operationen findftuapplicationids(...): <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:findftuapplicationidsrequest> <ns:institutionnumber>999903</ns:institutionnumber> <ns:fromdate> </ns:fromdate> <ns:todate> </ns:todate> <ns:educationtype>upper_secondary</ns:educationtype> <ns:onlynew>false</ns:onlynew> <ns:alsosubinstitutions>true</ns:alsosubinstitutions> </ns:findftuapplicationidsrequest> </soapenv:body> </soapenv:envelope>

8 Resultatet: <soap:envelope xmlns:soap=" <soap:body> <findftuapplicationidsresponse xmlns=" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" xmlns:ns5=" xmlns:ns6=" <ApplicationIdAndStateList> <ApplicationIdAndState> <Id> </Id> <State>Original ansøgning</state> </ApplicationIdAndState> <ApplicationIdAndState> <Id> </Id> <State>Original ansøgning</state> </ApplicationIdAndState> <ApplicationIdAndState> <Id> </Id> <State>Original ansøgning</state> </ApplicationIdAndState> <ApplicationIdAndState> <Id> </Id> <State>Original ansøgning</state> </ApplicationIdAndState> </ApplicationIdAndStateList> </findftuapplicationidsresponse> </soap:body> </soap:envelope> Eksempel på søgning ved hjælp af operationen findftuapplicationbyid(...): <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:findftuapplicationbyidrequest> <!--Optional:--> <ns:ftuapplicationid>13xxxxx51</ns:ftuapplicationid> <!--Optional:--> <ns:institutionnumber>999903</ns:institutionnumber> </ns:findftuapplicationbyidrequest> </soapenv:body> </soapenv:envelope>

9 Format på resultatet: Et svar som enten er en fejlmarkering eller en FTU-ansøgning opbygget efter følgende skema: <xs:complextype name="ftuapplicationservicefindresult"> <xs:sequence> <xs:element minoccurs="0" name="error" type="tns:error"/> <xs:element minoccurs="0" name="ftuapplicantforms" type="xs:string"/> </xs:sequence> </xs:complextype> Operationen returnerer en FTU-ansøgning som tekst indeholdende XML specificeret i XMLskemaet FtuEducationPlanList.xsd. Eksempel på svar fra tjenesten (hvor indmaden er fjernet og erstattet med...) <soap:envelope xmlns:soap=" <soap:body> <findftuapplicationbyidresponse xmlns=" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" xmlns:ns5=" xmlns:ns6=" <ftueducationplanresponse> <FtuOutOfSchoolEducationPlan> <ApplicationType>FULLY_DIGITAL</ApplicationType> <ModifiedDate> T11:46: :00</ModifiedDate> <SchoolYear>2017/2018</SchoolYear> <WishList> <WishListCount>1</WishListCount> <EducationWish> <ApplicationStartDate> :00</ApplicationStartDate> <ApplicationEndDate> :00</ApplicationEndDate> <StudyStartDate> :00</StudyStartDate> <WishUpperSecondaryPreIB> <PriorityNumber>1</PriorityNumber> <Institution> <ns2:institutionnumber>999903</ns2:institutionnumber> <ns2:institutionname>test SCHOOL</ns2:InstitutionName> </Institution> <Coesa>30XX</Coesa> <FtuAdmissionCriterias> <CriteriaNotMet>false</CriteriaNotMet> </FtuAdmissionCriterias> <FtuSupportArrangement> <ApplicantRequiresSupport>false</ApplicantRequiresSupport> </FtuSupportArrangement>

10 <CommentList/> </WishUpperSecondaryPreIB> </EducationWish> </WishList> <FtuApplicantGuardian/> <FtuApplicantGuardian/> <UUCenter> <ns2:institutionnumber>999903</ns2:institutionnumber> <ns2:institutionname>test SCHOOL</ns2:InstitutionName> <ns2:principal>xxxx XXXX HaXX</ns2:Principal> <ns2:address>xxxxx Xxxx 6</ns2:Address> <ns2:cityname>xxxxxx</ns2:cityname> <ns2:postalcode>9xxx</ns2:postalcode> <ns2:postaldistrict>xxxxx Xxxxxxxx</ns2:PostalDistrict> <ns2:phonenumber>99xxxxxx</ns2:phonenumber> </UUCenter> <OutOfSchoolApplicant> <CivilRegistrationNumber>XXXXXXXXXX</CivilRegistrationNumber> <ns3:persongivenname>xxxxx Xxxxxx</ns3:PersonGivenName> <ns3:personsurnamename>xxxx</ns3:personsurnamename> <Address> <ns2:streetaddress>xxxxx 7</ns2:StreetAddress> <ns2:postalcode>9xxx</ns2:postalcode> <ns2:postaldistrict>xxxxxxx</ns2:postaldistrict> <ns2:countrycode>dk</ns2:countrycode> <ns2:country>denmark</ns2:country> <ns2:municipalitycode>08xx</ns2:municipalitycode> <ns2:municipalityname>xxxx</ns2:municipalityname> </Address> <PhoneNumber>255XXXXX</PhoneNumber> <MobilePhone>2553XXXX</MobilePhone> <CompletedBasicSchool> <CompletedBasicSchoolClass>10. klasse</completedbasicschoolclass> <Year> :00</Year> </CompletedBasicSchool> </OutOfSchoolApplicant> <EducationBackgroundList> <FtuEducationBackground> <SchoolName>XX (Xxxxxxxx)</SchoolName> <Description>Xxxxxxx TEST SCHOOL</Description> <StartDate> :00</StartDate> <EndDate> :00</EndDate> <Finished>true</Finished> </FtuEducationBackground> </EducationBackgroundList> <OutOfSchoolSignatureList> <ApplicantSignature> <SignatureDate> T11:46: :00</SignatureDate> <SignatureName>TESTLOGIN-ENABLED</SignatureName> </ApplicantSignature> </OutOfSchoolSignatureList> <WizardState>3</WizardState>

11 <EducationAgreement>false</EducationAgreement> <State>Original ansøgning</state> </FtuOutOfSchoolEducationPlan> </ftueducationplanresponse> </findftuapplicationbyidresponse> </soap:body> </soap:envelope> Eksempel på søgning ved hjælp af operationen findftuapplicationpdfbyid(...): <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:findftuapplicationpdfbyidrequest> <!--Optional:--> <ns:ftuapplicationid> </ns:ftuapplicationid> <!--Optional:--> <ns:institutionnumber>999903</ns:institutionnumber> </ns:findftuapplicationpdfbyidrequest> </soapenv:body> </soapenv:envelope> Format på resultatet: <soap:envelope xmlns:soap=" <soap:body> <findftuapplicationpdfbyidresponse xmlns=" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" xmlns:ns5=" xmlns:ns6=" <return>jvberi0xljqkjcfl9oxwcjegmcbvymokpdwkl0zpbhrlciavrmxhdgvezwnvzgukl0xlb md0acaxmtuwcj4+cnn0cmvhbqp42u1y3vpiohr/pn/febkz68ylmzrjw3i6krqji1cxco8lm061as tp6rafxf77ewokrk7sisvllge0pulofucj56pfjl/goshpmjcscrjeug7miug8bxyek6hpm+skc6s ft+fkzqchp4czrklzlxotmtyuyh7kgfndta9sjuupayvb6pvid3s/dped46ql5esmh1e0cgqdttth 7fbJ+b8nDaTfSs+XcR2yYf+2DjzDkgzuEYOBo14Upb+ezga3KajsEKvGs8U3nlLwPUhv4bLVxOf7O HrEbggCtgBhEXCEBbGE/0DjkhBh9saHnTODmC61BBD8VB/GuMelDtyE2UIv0JCksfRCw4JTg5oEvu MmXP/wa3366THuF1r3zajQ6eHZP4tnp1YOOkbFxceOb1Q+Hkc67QShTKoHkfIpUBs6PaPyYV8nXTR hx6o+yegng1iozaq92ipz+9trs5vi0x/sqefoqbx1jc8tti8/rlp4ighen31dkp+lcnyzfluxpabt KS5939M6wzqR...</return> </findftuapplicationpdfbyidresponse> </soap:body> </soap:envelope>

12 Operationen returnerer en FTU-ansøgning som Base64 encodede bytes. Et svar som enten er en fejlmarkering eller FTU-ansøgning som PDF opbygget efter følgende skema: <xs:complextype name="applicationservicefindresult"> <xs:sequence> <xs:element minoccurs="0" name="error" type="tns:error"/> <xs:element minoccurs="0" name="ftuapplicantpdf" type="xs:base64binary"/> </xs:sequence> </xs:complextype> Eksempel på et udsnit af en XML ftu uddannelses plan med digitale bilag <EnclosureList> <Enclosure> <EnclosureType>DIGITAL_FILE</EnclosureType> <EnclosureName>03XXXXXX pdf</EnclosureName> <ApplicantsEnclosureName>bilag1</ApplicantsEnclosureName> <UploadDate> </UploadDate> </Enclosure> <Enclosure> <EnclosureType>DIGITAL_FILE</EnclosureType> <EnclosureName>03XXXXXX pdf</EnclosureName> <ApplicantsEnclosureName>bilag2</ApplicantsEnclosureName> <UploadDate> </UploadDate> </Enclosure> </EnclosureList> Eksempel på søgning ved hjælp af operationen findftuapplicationenclosurezipurlbyid(...): <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:findftuapplicationenclosurezipurlbyidrequest> <!--Optional:--> <ns:ftuapplicationid>13xxxxx51</ns:ftuapplicationid> <!--Optional:--> <ns:institutionnumber>xxxxxx</ns:institutionnumber> </ns:findftuapplicationenclosurezipurlbyidrequest> </soapenv:body> </soapenv:envelope> Resultat: <soap:envelope xmlns:soap=" <soap:body> <findftuapplicationenclosurezipurlbyidresponse xmlns=" xmlns:ns2="

13 xmlns:ns3=" xmlns:ns4=" xmlns:ns5=" xmlns:ns6=" <return> <fileurl> AGRJ5njhlEJ5</fileURL> </return> </findftuapplicationenclosurezipurlbyidresponse> </soap:body> </soap:envelope> Fejlrapportering Ved fejlsituationer returneres fejlelement efter følgende skema: <xs:complextype final="extension restriction" name="error"> <xs:sequence> <xs:element minoccurs="0" name="code" type="xs:string"/> <xs:element minoccurs="0" name="text" type="xs:string"/> </xs:sequence> </xs:complextype> NO_DATA Code INVALID_INPUT ILLEGAL_ACCESS INSTITUTION_NOT_FOUND SYSTEM_ERR Hvis søgningen intet finder Hvis input data ikke er gyldigt Beskrivelse Hvis authentifikation eller autorisationen ikke lykkes. Dette er 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. Det angivne institutionsnummer matcher ikke institution i Optagelse.dk Fejl i tjenesten