Webservice W017 Registrer karakter

Transkript

1 ADM TEK Webservice W017 Registrer karakter Formål At registrere og opdatere en karakter i SIS, dvs. svarende til vinduet Registrering af karakter/merit pr. studerende (A471), dog kun for karakterdelen af dette vindue. Webservicen kan oprette eller ændre oplysninger vedrørende en karakter for en studerende (fx fra eksternt karaktersystem, eks. Uniwise). Data som overføres, sendes som et XML-dokument, med oplysninger om karakter på studerende der har fået en bedømmelse. Indhold Formål... 1 Betingelser for adgang til web-servicen... 2 Kald af webservicen... 2 Kontekst... 3 Afgrænsninger / Mapning imellem XML-input og SIS tabeller... 4 Mapning imellem XML output og SIS tabeller... 8 XSD links... 9 Fejlkoder Side 1 af 12

2 Betingelser for adgang til web-servicen Der kan ansøges om adgang til anvendelse af webservicen via ansøgningsskema / kontrakt på SIS-supporten, hvis der allerede foreligger en kontrakt om adgang. Ved tildeling af adgang leverer UMIT en adgangskode, som i kombination med den kaldende applikations ip-adresse giver adgang til webservice modulet. Bemærk, at adgangen til institutionens SIS data via denne webservice også kan begrænses ved, at institutionen kan lukke for webservicen på den enkelte institutionsafdeling lokalt (via SIS-vinduet B936 WebServiceautorisation), uanset om der er tildelt adgang via UMIT. Det logges centralt, hvilke eksterne parter som tilgår webservicen. Kald af webservicen WSDL: Metode: WSCallSis Forespørgselsparametrene til WSCallSis gennemgås i den generelle konceptbeskrivelse af webservices for SIS. Side 2 af 12

3 Kontekst En studerende er tilmeldt eksamen, og disse tilmeldinger kan hentes via webservicen W015 Hent eksamener af et eksterne karaktersystem. år den studerende har været til eksamen og har fået en karakter, skal denne sendes tilbage til SIS. Der skal ikke benyttes karakterlister til denne angivelse af karakterer, da tjekket om juridisk korrekt karakter behandles i det eksterne system. Dvs. der kan blot registreres en karakter på en studerende på gruppe, fagindhold, niveau mm. Man kan rette en eksisterende karakter, hvis KaraId er udfyldt. Det er også muligt at opdatere institutionsafdeling på karakteren, hvis både KaraId og Institution er udfyldt. Kun området Karakterer i A471 behandles i denne webservice. Områderne Merit/fritagelse/realkompetence, samt Meritkarakterer skal IKKE behandles af webservicen. Side 3 af 12

4 Afgrænsninger / Mapning imellem XML-input og SIS tabeller XML-element Database felt Type Beskrivelse Tvu nge n EksId AKTIVITETER.AKTI_ID ELEVER.ELEV_ID SKOLEFAG_PA_HOLD.V FM_EKSAMESTERMI SKOLEFAG.SKFA_ID RESULTATFORMER. REFO_ID KARAKTER LISTER.LISTER String max længde 58 Findes vha. W015 Hent eksamener Værdien i VFM_EKSAMESTERMI er f.eks. jun 2014 PersId PERSOER.PERS_ID umber - max længde 10 Cprr PERSOER.CPR_R String max længde 10 AlternativtId PERSOER. ALTERATIVT_ID String max længde 50 Studier ELEVER.STUDIEUMME String max længde 10 R ElevId ELEVER.ELEV_ID umber - max længde 10 InstitutionsAktivitet COSA_FORMAL.COSA_F String max længde 4 ORMAL UddannelsesOrdning UDDAELSER.VERSIO String max længde 4 Gruppe AKTIVITETER.AKTIVITET String max længde 12 AktiId AKTIVITETER.AKTI_ID umber - max længde 10 FagIndhold SKOLEFAG.SKOLEFAG String max længde 5 iveau SKOLEFAG.IVEAU String max længde 1 EvalueringsForm EVALUERIGSFORMER. String max længde 3 EVALUERIGSFORM KarakterSkala KARAKTERSKALA.KARA String max længde 5 KTERSKALA KarakterType KARAKTERTYPE. KARAKTERTYPE String max længde 3 RefoId RESULTATFORMER.REF umber - max længde O_ID 10 KarakterOplBevisDk KARAKTERER.KARAKTE String max længde 100 ROPLYSIGER_TIL_BE VIS KarakterOplBevisEng KARAKTERER. KARAKTEROPL_TIL_BEV IS_EGELSK String max længde 100 Termin KARAKTERER.TERMI String max længde 8 Indtastes i formatet MMYY eller MO-YYYY Karakter KARAKTERVARDI. String max længde 2 KARAKTERVARDI BedommelsesDato KARAKTERER.BEDOMM ELSESDATO Date Indtastes i formatet YYYY- MM-DD årstallet YYYY skal være mellem 1950 og 2049 Bemerkning KARAKTERER.BEMERK String max længde IG 2000 Titel KARAKTERER.TITEL String max længde 2000 EngelskTitel KARAKTERER.TITEL_E String max længde Side 4 af 12

5 GELSK 2000 Frigivet - String max længde 1 / Hvis indsættes en række i tabellen FRIGIVELSESMARKERIG ER Institution KaraId ISTITUTIOER.ISTITU String max længde 8 TIOSKODE KARAKTERER.KARA_ID umber - max længde 10 Serviceavn KARAKTERER.OPDIIT String max længde 30 dvs. Servicenavn må være max 19 Der kan ikke anvendes wildcards i nogle af input felterne. Hvis udfyldt, benyttes denne institution, ellers benyttes aktivitetens institutionsafdeling. Er ingen af delene udfyldt benyttes den studerendes institutionsafdeling. Benyttes kun ved overskrivning af eksisterende karakter. Webservice - Serviceavn Slutvalideringer Ved størstedelen af slutvalideringerne skelnes der mellem, om der er tale om indsættelse af data eller opdatering. Hvis parameteren KaraId ikke er udfyldt, er der tale om indsætning. Er parameteren KaraId udfyldt er der tale om opdatering. Ved indsættelse(karaid er ikke udfyldt) Hvis EksId er udfyldt Feltet akti_id i EksId skal eksistere i SIS (WEB-WA064) Feltet elev_id i EksI skal eksistere i SIS (WEB-WA038) Feltet skfa_id i EksId skal eksistere i SIS (WEB-WA053) Feltet refo_id i EksId skal eksistere i SIS (WEB-WA060) Hvis akti_id i EksId er udfyldt, skal den studerende være tilknyttet fagindholdet på gruppen/aktiviteten (i tabellen skolefag_pa_holdplacering) (WEB-WA051) Refo_id i EksId skal være oprettet på fagindholdet (skfa_id i EksId) i SIS (WEB-WA049) Hvis EksId ikke er udfyldt Præcis ét af felterne Cprr, Studieummer, AlternativtId, ElevId eller PersId skal udfyldes (WEB-WA043) At studerende med studienummer eksisterer i SIS (WEB-WA007) At person med alternativt id eksisterer i SIS (WEB-WA008) At person med CPR-nr. eksisterer i SIS (WEB-WA008) At elevid eksisterer i SIS (WEB-WA038) At persid eksisterer i SIS (WEB-WA039) Hvis PersId, Cprr eller AlternativtId er udfyldt, skal InstitutionsAktivitet og UddannelsesOrdning også udfyldes (WEB-WA059) Side 5 af 12

6 InstitutionsAktivitet og UddannelsesOrdning må kun være udfyldt, hvis PersId, Cprr eller AlternativtId er udfyldt (WEB-WA062) Hvis InstitutionsAktivitet og UddannelsesOrdning er udfyldt, skal denne kombination findes i SIS (WEB-WA063) Hvis PersId, Cprr eller AlternativtId og InstitutionsAktivitet og UddannelsesOrdning er udfyldt, tjekkes det, at personen er oprettet som studerende på uddannelsen (WEB-WA045) Termin skal være udfyldt (lovlig termin eks eller jan 2015, men der skal ikke tjekkes på om denne termin findes på gruppen) (WEB-WA042) FagIndhold og iveau skal udfyldes (WEB-WA052) Kombinationen af FagIndhold og iveau skal findes i SIS (WEB-WA053) Hvis AktiId er udfyldt, skal aktiviteten findes i SIS (WEB-WA064) Hvis Gruppe er udfyldt, skal aktiviteten findes i SIS (WEB-WA064) Hvis AktiId er udfyldt, skal den studerende være tilknyttet fagindholdet på gruppen/aktiviteten (i tabellen skolefag_pa_holdplacering) (WEB-WA051) Hvis Gruppe er udfyldt, skal den studerende være tilknyttet fagindholdet på gruppen/aktiviteten (i tabellen skolefag_pa_holdplacering) (WEB-WA051) Enten skal RefoId eller EvalueringsForm, KarakterSkala og KarakterType være udfyldt. Hvis RefoId er udfyldt, må ingen af EvalueringsForm, KarakterSkala og KarakterType være udfyldt (WEB-WA050) Hvis RefoId er udfyldt, skal den eksistere i SIS (WEB-WA060) Hvis EvalueringsForm er udfyldt, skal den eksistere i SIS (WEB-WA065) Hvis KarakterSkala er udfyldt, skal den eksistere i SIS (WEB-WA066) Hvis KarakterType er udfyldt, skal den eksistere i SIS (WEB-WA067) Hvis EvalueringsForm, KarakterSkala og KarakterType er udfyldt, skal kombinationen være oprettet på fagindholdet i SIS (WEB-WA049) Hvis RefoId er udfyldt, skal denne være oprettet på fagindholdet i SIS (WEB-WA049) Uanset om EksId er udfyldt eller ej Karakteren skal findes på karakterskalaen (fra RefoId eller fra KarakterSkala) (WEB-WA055) Bedømmelsesdato skal være udfyldt (WEB-WA047) Karakter skal være udfyldt (WEB-WA054) Der må ikke allerede findes en karakter for den studerende på det aktuelle fagindhold og resultatform og termin (WEB-WA044) Ved opdatering(karaid er udfyldt) KaraId skal findes i SIS (WEB-WA056) Det er kun tilladt at udfylde KarakterOplBevisDk, KarakterOplBevisEng, Termin, Karakter, Bedommelsesdato, Bemerkning, Titel, EngelskTitel, Frigivet, Institution og Serviceavn (WEB-WA058) Der må ikke allerede findes en karakter for den studerende på det aktuelle fagindhold og resultatform og termin (Dette kan forekomme, da Termin kan ændres) (WEB-WA044) Karakteren skal findes på karakterskalaen på karakteren (WEB-WA055) Det er ikke tilladt at opdatere en karakter hvor KARAKTER.FRIT_ID IS OT ULL. I såfald returneres en fejlmeddelelse (WEB-WA046) Ved både indsættelse og opdatering At kun gyldige værdier indtastes (WEB-WA005) At det maksimale antal tegn i parameterlistens elementer ikke overskrides (WEB-WA001) Indholdet i feltet Institution, skal være en institution der findes som Central med institutionstype U i SIS (WEB- WA030) Side 6 af 12

7 Hvis Bedømmelsesdato er udfyldt skal det være en gyldig dato indtastet i formatet YYYY-MM-DD årstallet YYYY skal være mellem 1950 og 2049 (WEB-WA048) Serviceavn skal være udfyldt (WEB-WA057) Side 7 af 12

8 Mapning imellem XML output og SIS tabeller XML-element Database felt Vindue/Felt KaraId KARAKTERER.KARA_ID - Processering af parameterliste Indsættelse (KaraId er ikke udfyldt) Der indsættes en række i tabellen KARAKTERER samt i tabellen FRIGIVELSESMARKERIGER, hvis værdien i afgrænsningen Frigivet er. Der ses bort fra frigivelsesregler i SIS og indsættes en række i tabellen FRIGIVELSESMARKERIGER med nedenstående værdier. Database felt Værdier FRIG_ID FRIG_SEQ.EXTVAL KARA_ID KaraId OPDTID SYSDATE OPDMOD W017 OPDIIT Webservice Serviceavn Hvis EksId er udfyldt, overskriver informationer der kan udledes herfra alle de øvrige parameter felter Hvis både AktiId og Gruppe er udfyldt, overskriver AktiId indholdet i feltet Gruppe På tabellen KARAKTERER findes der en forretningsregel, som aktiveres efter indsætning (Triggeren KARA_A_I_S_KAR_B1018, som kalder kar_pack.arv_fra_skhp). Hvis fagindhold på gruppeplacering udfyldes på karakteren, kopieres felterne Bemærkning, Titel, Engelsk Titel og relateret fagindhold fra Fagindhold på gruppeplacering til samme felt på tabellen karakterer. Der foretages ingen kopiering fra Fagindhold på gruppeplacering til feltet Bemærkning, Titel, Engelsk titel, eller Relateret fagindhold hvis feltet allerede indeholder en værdi. Da det er en trigger, vil det også ske, når der oprettes en karakter via webservicen. Opdatering (KaraId er udfyldt) Der opdateres en række i tabellen KARAKTERER. Hvis afgrænsningen Frigivet er, indsættes en række i FRIGIVELSESMARKERIGER (hvis der ikke allerede er en sådan række). Hvis afgrænsningen Frigivet er, og der er en en række i FRIGIVELSESMARKERIGER, slettes denne række i FRIGIVELSESMARKERIGER Både indsættelse og opdatering KARAKTERER.OPDMOD sættes til W017 og KARAKTERER.OPDIIT skal sættes til Webservice Serviceavn Vedrørende fejl som fanges i forretningsreglerne i SIS, når der gemmes, returneres hhv. fejlkode og fejlmeddelelse fra trigger/pakker med output XML en. WEB-WA061 Ukendt fejl returneres i tilfælde af at, deferred_pack.do_commit fejler af ukendt årsag. Side 8 af 12

9 XSD links Link til XSD parameterlist: Link til XSD svar: Side 9 af 12

10 Fejlkoder Tjek Fejlkode Fejltekst y fejlkode? At udtrækket er gået godt 0 OK - At det maksimale antal tegn i parameterlistens elementer ikke overskrides. WEB-WA001 Du har søgt på et eller flere felter, hvor antallet af tegn overskrides [XML-element liste] At kun gyldige værdier indtastes WEB-WA005 Du har indtastet en værdi som ikke er tilladt i et eller flere felter [XML-element liste] At studerende med studienummer eksisterer i SIS At person med alternativt id eksisterer i SIS At person med CPR-nr. eksisterer i SIS WEB-WA007 Studerende med studienummer findes ikke WEB-WA008 Person med alternativt id findes ikke WEB-WA014 Studerende med CPR-nr. findes ikke At der findes data der matcher søgekriterierne WEB-WA027 Der ikke blev fundet data der matcher søgekriterierne At indholdet i feltet Institution, skal være en institution der findes som Central med institutionstype U i SIS. WEB-WA030 Der skal eksistere en central institution med denne institutionskode og institutionstype U At elevid eksisterer i SIS WEB-WA038 Studerende med ElevId findes ikke At persid eksisterer i SIS WEB-WA039 Person med PersId findes ikke Medmindre KaraId er udfyldt gælder flg.: Hvis EksId ikke er udfyldt skal Termin være udfyldt (lovlig termin eks eller jan 2015, men der skal ikke tjekkes på om denne termin findes på gruppen) WEB-WA042 Termin skal udfyldes Medmindre KaraId er udfyldt gælder flg.: Hvis EksId ikke er udfyldt skal præcis ét af felterne Cprr, Studieummer, AlternativtId, ElevId eller PersId udfyldes WEB-WA043 Præcis ét af felterne Cprr, Studieummer, AlternativtId, ElevId eller PersId skal udfyldes Det skal tjekkes, om der allerede er registreret en karakter for den studerende på det aktuelle fagindhold, resultatform og termin WEB-WA044 Der er allerede registreret en karakter for den studerende på dette fagindhold, resultatform og termin Hvis EksId ikke er udfyldt og hvis PersId, Cprr eller AlternativtId og InstitutionsAktivitet og UddannelsesOrdning er udfyldt tjekkes det at personen er oprettet som studerende på uddannelsen WEB-WA045 Personen findes ikke som studerende på uddannelsen At karakteren som forsøges opdateret ikke indeholder en værdi i KARAKTERER.FRIT_ID At BedommelsesDato er udfyldt medmindre KaraId er udfyldt WEB-WA046 Karakteren må ikke opdateres WEB-WA047 BedommelsesDato skal udfyldes At hvis BedommelsesDato er udfyldt skal det være en gyldig dato indtastet i formatet YYYY- MM-DD årstallet YYYY skal WEB-WA048 BedommelsesDato skal indtastes i formatet YYYY-MM-DD årstallet YYYY skal være mellem 1950 og 2049 Side 10 af 12

11 være mellem 1950 og 2049 Hvis RefoId er udfyldt, skal denne være oprettet på fagindholdet i SIS WEB-WA049 Resultatformen er ikke oprettet på fagindholdet i SIS Hvis EvalueringsForm, KarakterSkala og KarakterType er udfyldt, skal kombinationen være oprettet på fagindholdet i SIS. Medmindre KaraId er udfyldt gælder hvis EksId ikke er udfyldt at RefoId eller EvalueringsForm, KarakterSkala og KarakterType skal være udfyldt. Hvis RefoId er udfyldt, må ingen af EvalueringsForm, KarakterSkala og KarakterType være udfyldt WEB-WA050 RefoId eller EvalueringsForm, KarakterSkala og KarakterType skal udfyldes. Hvis RefoId er udfyldt, må ingen af EvalueringsForm, KarakterSkala og KarakterType være udfyldt Hvis Gruppe er udfyldt, skal den studerende være tilknyttet fagindholdet på gruppen/aktiviteten (i tabellen skolefag_pa_holdplacering) WEB-WA051 Den studerende er ikke tilknyttet fagindholdet på gruppen Hvis AktiId er udfyldt, skal den studerende være tilknyttet fagindholdet på gruppen/aktiviteten (i tabellen skolefag_pa_holdplacering) Medmindre KaraId er udfyldt gælder hvis EksId ikke er udfyldt at både FagIndhold og iveau skal udfyldes WEB-WA052 FagIndhold og iveau skal udfyldes Kombinationen af FagIndhold og iveau skal findes i SIS WEB-WA053 Kombinationen af FagIndhold og iveau findes ikke i SIS Medmindre KaraId er udfyldt tjekkes det at Karakter er udfyldt At Karakter findes på karakterskalaen WEB-WA054 Karakter skal udfyldes WEB-WA055 Karakter findes ikke på karakterskalaen At KaraId findes i SIS WEB-WA056 KaraId findes ikke i SIS At Serviceavn er udfyldt WEB-WA057 Serviceavn skal udfyldes Hvis KaraId er udfyldt er det kun tilladt at udfylde KarakterOplBevisDk, KarakterOplBevisEng, Termin, Karakter, Bedommelsesdato, Bemerkning, Titel, EngelskTitel, Frigivet, Institution og Serviceavn WEB-WA058 Hvis KaraId er udfyldt er det kun tilladt at udfylde KarakterOplBevisDk, KarakterOplBevisEng, Termin, Karakter, Bedommelsesdato, Bemerkning, Titel, EngelskTitel, Frigivet, Institution og Serviceavn At hvis PersId, Cprr eller AlternativtId er udfyldt, skal InstitutionsAktivitet og UddannelsesOrdning også være udfyldt WEB-WA059 Hvis PersId, Cprr eller AlternativtId er udfyldt, skal InstitutionsAktivitet og UddannelsesOrdning også udfyldes At hvis RefoId er udfyldt, skal den eksistere i SIS WEB-WA060 RefoId findes ikke i SIS Hvis deferred_pack.do_commit WEB-WA061 Ukendt fejl Side 11 af 12

12 returnerer en fejl At InstitutionsAktivitet og UddannelsesOrdning kun er udfyldt, hvis PersId, Cprr eller AlternativtId er udfyldt WEB-WA062 InstitutionsAktivitet og UddannelsesOrdning må kun være udfyldt, hvis PersId, Cprr eller AlternativtId er udfyldt At kombinationen af InstitutionsAktivitet og UddannelsesOrdning findes i SIS WEB-WA063 Kombinationen af InstitutionsAktivitet og UddannelsesOrdning findes ikke i SIS At hvis AktiId eller Gruppe er udfyldt, skal aktiviteten findes i SIS At hvis EvalueringsForm er udfyldt, skal den eksistere i SIS At hvis KarakterSkala er udfyldt, skal den eksistere i SIS WEB-WA064 Gruppen findes ikke i SIS WEB-WA065 EvalueringsForm findes ikke i SIS WEB-WA066 KarakterSkala findes ikke i SIS At hvis KarakterType er udfyldt, skal den eksistere i SIS WEB-WA067 KarakterType findes ikke i SIS Side 12 af 12