Dokumentation för tjänsten Tjänstefördelning

Storlek: px

Starta visningen från sidan:

Download "Dokumentation för tjänsten Tjänstefördelning"

Joakim Pettersson
för 5 år sedan
Visningar:

1 Dokumentation för tjänsten Tjänstefördelning Nova Software AB, Storgatan 5A, Falköping

2 Dokumentation för tjänsten Tjänstefördelning Introduktion Denna tjänst syftar till att kunna ta fram tjänstefördelning. Tjänsten levererar valda delar av tjänstefördelningen baserat på angiven indata. Tjänstebeskrivning Indata representeras genom schemafilen activityinput.xsd och utdata representeras genom schemafilen activityoutput.xsd. Utöver dessa kontrakt finns det omslutande kontrakt (activityserviceinput.xsd samt activityserviceoutput.xsd) som främst syftar till att transportera fel på tjänstenivå tillbaka till den anropande parten. Felhanteringen beskrivs mer ingående under stycket Felhantering nedan. TJÄNSTENS INDATA Tjänstens indata hanterar kombinationerna av värden som filter, d.v.s. anger du både lärare och skola fås endast de aktiviteter som gäller angiven lärare på den angivna skolan. Parameterbeskrivning Parameter Beskrivning Exempel interval.start interval.stop activities.activity.id createboundactivity Uttrycker startdatum för det datumintervall som konsumenten är intresserad att hämta aktiviter för. Får utelämnas om även interval.stop utelämnas för att efterfråga all tjänstefördelning. Uttrycker slutdatum för det datumintervall som konsumenten är intresserad att hämta aktiviteter för. Får utelämnas om även interval.start utelämnas för att efterfråga all tjänstefördelning. Uttrycker ett id för en specifik aktivitet (uuid). Anger om endast aktiviteter som är underlag för generering av lektioner, skall hämtas. Om elementet saknas, tas ingen hänsyn till detta värde vid utsökning T00:00: T00:00: /5

3 originalactivity teachers.person.id teachers.person.vid schools.school.id schools.school.vid subjects.subject.id subjects.subject.vid courses.course.id Anger om tjänsten ska returnera ursprungsaktivitet eller en aktivitet som är härledd ifrån ursprungsaktiviteten. Om elementet saknas, tas ingen hänsyn till detta värde vid utsökning. Identifierare för en lärare. Detta bör Identifierare för en lärare i formen av ett personnummer. Identifierare för en skola. Detta bör En naturlig nyckel som representerar skolan. Identifierare för ett ämne. Detta bör En naturlig nyckel som representerar ämnet. Identifierare för en kurs. Detta bör yyyymmddnnnn Skola1 MA courses.course.vid Naturlig nyckel för kursen. MA1202 groups.group.id Identifierare för en grupp. Detta bör groups.group.vid En naturlig nyckel för gruppen. 7A TJÄNSTENS UTDATA Tjänsten levererar en lista med aktiviteter. Varje aktivitet har nedan beskriven information. Parameterbeskrivning Parameter Beskrivning Exempel activitygroup Används för att kunna gruppera aktiviteter som hör ihop, vanligtvis ursprungsaktiviteter tillsammans med dess ersättningsaktiviteter support@novasoftware.se 2/5

4 activityid originalactivity createboundactivity timeplanned interval.start interval.stop school.id Unik aktivitetsidentifierare. Detta är en systemgenererad unik nyckel (uuid). Detta ska uttrycka huruvida aktiviteten avser ursprungsaktivitet eller en aktivitet som är härledd ifrån ursprungsaktiviteten. Anger om aktiviteten är underlag för generering av lektion. Den totala tiden för det efterfrågade intervallet. Anges i antal timmar (med eventuell decimal) Beskriver när första förekommande tillfället inom det efterfrågade intervallet startar. Beskriver när sista förekommande tillfället inom det efterfrågade intervallet slutar. Identifierare för en skola. Detta bör vara en systemgenererad unik nyckel AB3E T00:00: T00:00: AB3E- school.vid En naturlig nyckel som representerar skolan. Skola1 teachers.person.id teachers.person.vid groups.group.id Identifierare för en lärare. Detta bör vara en systemgenererad unik nyckel Identifierare för en person i formen av ett personnummer. Identifierare för en grupp. Detta bör vara en systemgenererad unik nyckel AB3E- yyyymmddnnnn AB3E- groups.group.vid En naturlig nyckel för gruppen. 7A subject.id Identifierare för ett ämne. Detta bör vara en systemgenererad unik nyckel AB3E- subject.vid En naturlig nyckel som representerar ämnet. MA course.id Identifierare för en kurs. Detta bör vara en systemgenererad unik nyckel AB3E- course.vid En naturlig nyckel för kursen. MA support@novasoftware.se 3/5

5 FELHANTERING Det omslutande kontraktet activityserviceoutput.xsd innehåller förutom tidigare beskrivna utdata även möjlighet att transportera eventuella fel från tjänsten. Om ett eller fler fel returneras innebär det alltid att tjänsten inte returnerar något nyttodata. Dessa fel är formaterade på följande sätt: Parameter Id Description Data Beskrivning En numerisk representation av det aktuella felet. En textuell beskrivning av felet. Data kopplat till felet. Tom för vissa fel. Respektive fel beskriver innehållet i denna. Varje fel kan förekomma mer än en gång. Här följer listan med möjliga felkoder och dess beskrivningar Felkod (id) Beskrivning (description) Data (data) 1 Angiven aktivitet existerar inte. Angivet id/vid för aktiviteten. 2 Angiven lärare existerar inte. Angivet id/vid för gruppen. 3 Angiven skola existerar inte. Angivet id/vid för skolan. 4 Angivet ämne existerar inte. Angivet id/vid för ämnet. 5 Angiven kurs existerar inte. Angivet id/vid för kursen. 6 Angiven grupp existerar inte. Angivet id/vid för gruppen. 7 Felaktigt tidsintervall Ospecificerat fel i tjänst Ospecificerat fel i tjänsteinfrastruktur Indata är på felaktigt format (följer inte schema) - TJÄNSTEANROP Tjänsten är implementerad genom ett request/response mönster vilket innebär att varje anrop kommer att leverera ett svar (givet att inte ett fel i något annat lager har inträffat). Tjänstens metod tar en XML-representation av XML-schemat activityserviceinput.xsd i form av en sträng som indata. Den levererar också en XML-representation av schemat activityserviceoutput.xsd i form av en sträng som utdata support@novasoftware.se 4/5

6 Det åligger på konsumenten av tjänsten att säkerställa att tjänstens indata validerar mot tjänsteschemat. Brott mot kontraktet kommer generera ett fel tillbaka till den anropande konsumenten /5

Relevanta dokument

Det finns tre sorters rapporter: Grundrapporter - standardrapporter i Skola24. Namnen börjar med ordet Grundrapport.

Det finns tre sorters rapporter: Grundrapporter - standardrapporter i Skola24. Namnen börjar med ordet Grundrapport. Introduktion rapporter I programmet finns ett antal grundrapporter färdiga att skriva ut. Det går också att skapa helt egna rapporter där man t.ex. själv väljer vilka fält som ska vara med och vilken elevgrupp