Grænseflade til afhentning af grundskoleprøvekarakterer fra Optagelse.dk

Transkript

1 Grænseflade til afhentning af grundskoleprøvekarakterer fra Optagelse.dk Dato Version Status 1.0 Gældende fra og med den 1. juli 2016 Ansvarlig Tobias Thisted

2 Side 2 af 8 Indhold 1 Introduktion 3 2 Adgang og sikkerhed 3 3 Operationer/metoder getmarks(string cpr) Eksempel på indberetning Resultat setfs10marks(setfs10marksrequest requesttype) Eksempel på indberetning setfs10marks() Resultat setfs10marks(): setfsamarks(setfsamarksrequest requesttype) Eksempel på indberetning setfsamarks() Resultat setfsamarks() 8

3 Side 3 af 8 1 Introduktion I forbindelse med krav til kommende studerendes gennemsnit i dansk og matematik for 9. og 10. klasse skal uddannelsesinstitutioner have mulighed for at indberette prøvekarakterer for deres elever. Endvidere skal modtagende uddannelsesinstitutioner have mulighed for at afhente prøvekarakterer for ansøgende elever. Derfor introduceres i Optagelse.dk tjenesten MarksService. Formålet med Marks- Service er at fungere som et opsamlingspunkt, hvor institutioner kan indberette og hente prøvekarakterer for elever i 9.klasse (FSA) og 10. klasse(fs10). Webservicen til afhentning af karakterer anvendes aktuelt kun på EUD-området. MarksService er ikke knyttet til anden logik i Optagelse.dk og er ikke underlagt eller afhængig af andre forretningsgange i applikationen. Målet har været at lave en selvstændig og simpel service, som er fleksibel i forhold til ændringer af typer af prøveeksaminer. Her findes to metoder til at sætte prøvekarakterer, én til FSA- og én til FS10- prøvekarakterer. Det kræves, at brugeren har brugerrollen opt_set_marks for at kalde metoderne. Alle prøvekarakterer overskrives ved hver indlæsning, hvorfor alle elevens prøvekarakterer skal sendes hver gang. Ved afhentning kræves brugerrollen opt_get_marks. Ved afhentning returneres prøvekarakterer samt gennemsnittet for prøvekarakterer, hvis alle prøvekaraktererne inden for et område, FSA Dansk/Matematik og FS10 Dansk/Matematik, er indberettet. 2 Adgang og sikkerhed MarksService på Optagelse.dk kan findes via følgende links: Test: Produktion: Servicen er beskyttet af login. Brugernavn og kodeord kan tildeles ved henvendelse til Styrelsen for It og Læring (STIL) på mailadressen optagelse@stil.dk, hvor der også kan fås nærmere vejledning. Anvendelse af MarksService kræver som ovenfor nævnt rollen opt_get_marks og/eller opt_set_marks. Ved forespørgsel via denne web service skal brugernavn og kodeord udfyldes som basic authentication i forespørgslens http-header. 3 Operationer/metoder Tjenesten består af følgende operationer/metoder: 1. getmarks(string cpr) 2. setfs10marks(setfs10marksrequesttype requesttype)

4 Side 4 af 8 3. setfsamarks(setfsamarksrequesttype requesttype) 3.1 getmarks(string cpr) getmarks anvendes til at hente indmeldte prøvekarakterer på en elev ud fra et cprnummer som parameter i søgningen: Navn Type Beskrivelse cpr Number* CPR nr. på 10 cifre * = Krævet felt Følgende resultater er mulige: StudentMarks hvis der findes studerende med det givne cpr-nummer, returneres liste af karakterer samt udregnede gennemsnit for FSA/FS10 Dansk og FSA/FS10 Matematik. "tom" hvis der ikke findes en person med det givne cpr-nummer, returneres tom body. Fault (throws AuthorizationFailedException) webservice-bruger har ikke rollen opt_get_marks. Fault - hvis xml ikke overholder xsd'er, da der er skemavalidering på requestet Eksempel på indberetning getmarks() <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:getmarksrequest> </ns:getmarksrequest> </soapenv:body> </soapenv:envelope> Resultat getmarks() <soap:envelope xmlns:soap=" <soap:body> <getmarksresponse xmlns=" <cpr> <cpr> </cpr> </cpr> <institutionnumber>183407</institutionnumber> <createddate> t11:31: :00</createddate> <FSADanishMarkAvgNotComputable>true</FSADanishMarkAvgNotComputable> <FS10DanishMarkAvgNotComputable>true</FS10DanishMarkAvgNotComputable> <FSAMathematicsMarkAvgNotComputable>true</FSAMathematicsMarkAvgNotComputable> <FS10MathematicsMarkAvgNotComputable>true</FS10MathematicsMarkAvgNotComputable> <fs10marks> <testsubjectid>110_002</testsubjectid> <value>02</value>

5 Side 5 af 8 <testsubjectid>110_003</testsubjectid> <value>86</value> <testsubjectid>110_005</testsubjectid> <value>86</value> <testsubjectid>310_007</testsubjectid> <value>87</value> <testsubjectid>310_008</testsubjectid> <value>87</value> <testsubjectid>310_003</testsubjectid> <value>4</value> </fs10marks> <fsamarks> <testsubjectid>110_002</testsubjectid> <value>02</value> <testsubjectid>110_005</testsubjectid> <value>86</value> <testsubjectid>110_003</testsubjectid> <value>7</value> <testsubjectid>310_008</testsubjectid> <value>87</value> <testsubjectid>310_003</testsubjectid> <value>4</value> <testsubjectid>310_007</testsubjectid> <value>87</value> </fsamarks> </getmarksresponse> </soap:body> </soap:envelope> 3.2 setfs10marks(setfs10marksrequest requesttype) Metoden indberetter for en given elev FS10-prøvekarakterer inden for dansk og/eller matematik. Hvis eleven med det angivne cpr-nummer allerede har indberettede FS10-prøvekarakterer, vil disse blive overskrevet med de nye. Dvs. at alle elevens prøvekarakterer skal indberettes hver gang.

6 Side 6 af 8 Dette giver også mulighed for at fjerne en prøvekarakter i forbindelse med en fejlindberetning, ved blot at undlade at tilføje prøvekarakteren ved næste kald. Parametre i indberetningen er: Navn Type Beskrivelse cpr Number* CPR nr. på 10 tal institutionnumber String* Institutionsnummer på 6 tal marks:danishmark:testsubjectid String Id for prøvekarakter (testsubjectid) marks:danishmark:value Number En valid prøvekarakter marks:mathematicsmark:testsubjectid String Id for prøvekarakter (testsubjectid) marks:mathematicsmark:value Number En valid prøvekarakter * = Krævet felt Følgende resultater er mulige: True ved succesfuld overførsel og registrering af prøvekarakterer. Fault (throws AuthorizationFailedException) webservice-bruger har ikke rollen opt_set_marks. Fault (throws InvalidMarks) karakterer er ikke valide, eksempelvis hvis det samme testsubjectid optræder flere gange i requestet. Fault hvis xml ikke overholder xsd'er, da der er skemavalidering på requestet Eksempel på indberetning setfs10marks() <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:setfs10marksrequest> <ns:cpr> </ns:cpr> <ns:institutionnumber>123</ns:institutionnumber> <ns:marks> <!--Zero or more repetitions:--> <ns:testsubjectid>110_001</ns:testsubjectid> <ns:value>10</ns:value> <ns:testsubjectid>110_002</ns:testsubjectid> <ns:value>10</ns:value> <ns:testsubjectid>110_003</ns:testsubjectid> <ns:value>12</ns:value> <ns:testsubjectid>110_005</ns:testsubjectid> <ns:value>12</ns:value>

7 Side 7 af 8 <!--Zero or more repetitions:--> </ns:marks> </ns:setfs10marksrequest> </soapenv:body> </soapenv:envelope> Resultat setfs10marks(): <soap:envelope xmlns:soap=" <soap:body> <parameter xsi:type="xs:boolean" xmlns:xs=" xmlns:xsi=" xmlns:ns3=" xmlns:ns2=" </soap:body> </soap:envelope> 3.3 setfsamarks(setfsamarksrequest requesttype) Metoden indberetter for en given elev FSA-prøvekarakterer inden for dansk og/eller matematik. Hvis eleven med det angivne cpr-nummer allerede har indberettede FSA-prøvekarakterer, vil disse overskrives med de nye. Dvs. at alle elevens prøvekarakterer skal indberettes hver gang. Dette giver også mulighed for at fjerne en prøvekarakter i forbindelse med en fejlindberetning ved blot at undlade at tilføje prøvekarakteren ved næste kald. Parametre i indberetningen er: Navn Type Beskrivelse Cpr Number* CPR nr. på 10 tal institutionnumber String* Institutionsnummer på 6 tal marks:danishmark:testsubjectid String Id for prøvekarakter (testsubjectid) marks:danishmark:value Number En valid prøvekarakter marks:mathematicsmark:testsubjectid String Id for prøvekarakter (testsubjectid) marks:mathematicsmark:value Number En valid prøvekarakter * = Krævet felt Følgende resultater er mulige: true ved succesfuld overførsel og registrering af prøvekarakterer. Fault (throws AuthorizationFailedException) webservice-bruger har ikke rollen opt_set_marks. Fault (throws InvalidMarks) karakterer er ikke valide, eksempelvis hvis det samme testsubjectid optræder flere gange i requestet. Fault hvis xml ikke overholder xsd'er, da der er skemavalidering på requestet.

8 Side 8 af Eksempel på indberetning setfsamarks() <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:setfsamarksrequest> <ns:cpr> </ns:cpr> <ns:institutionnumber>123</ns:institutionnumber> <ns:marks> <!--Zero or more repetitions:--> <ns:testsubjectid>110_001</ns:testsubjectid> <ns:value>10</ns:value> <ns:testsubjectid>110_002</ns:testsubjectid> <ns:value>10</ns:value> <ns:testsubjectid>110_003</ns:testsubjectid> <ns:value>12</ns:value> <ns:testsubjectid>110_005</ns:testsubjectid> <ns:value>12</ns:value> <!--Zero or more repetitions:--> </ns:marks> </ns:setfsamarksrequest> </soapenv:body> </soapenv:envelope> Resultat setfsamarks() <soap:envelope xmlns:soap=" <soap:body> <parameter xsi:type="xs:boolean" xmlns:xs=" xmlns:xsi=" xmlns:ns3=" xmlns:ns2=" </soap:body> </soap:envelope>