Felles studentsystemStatus
Under utvikling.
TjenesteURL'er
Her angis rot-url'er. I beskrivelsen av tjenestene står resten av URL'en.
For test: https://fs-test.uio.no/fsrest/rest/oppmote/
For prod: https://fsws.usit.no/fsrest/rest/oppmote/
Tjenestebeskrivelser
GET-grensesnitt
Der det er spesifisert "Query-parametre", så spesifiseres dette på følgende måte: http://url?param1=verdi¶m2=verdi
Begge tjenestene returnerer JSON.
Tjenestene
Følgende tjenester eksisterer:
- Hent undervisningsaktiviteter
- Hent aktivitetinformasjon
- Hent alle registrerte studenter
- Hent mulige studenter
- Hent registrert oppmøte for en student
- Lagre oppmøteinformasjon
| Navn: | Hent undervisningsaktiviteter |
| Beskrivelse: | Denne tjenesten henter ut oversikt over undervisningsaktiviteter for en fagperson. |
| Rolle: | oppmote-user |
| Type kall: | GET |
| URL: | aktiviteter |
| Parametre: | Query-parametre: fodselsdato: Fagpersonens fødselsdato på formatet ddMMyy personnr: Fagpersonens personnr terminkode: Terminkode, typisk VÅR eller HØST arstall: Årstallet, fire siffer uke: Valgri parameter. Hvis oppgitt (ukenummer), vil aktivitetene som undervises ha timeplanforekomst i FS den gitte uka. |
| Retur: | JSON (Schema) |
| Navn: | Hent aktivitetinformasjon |
| Beskrivelse: | Denne tjenesten henter ut informasjon (studenter og timeplan) om en aktivitet. |
| Rolle: | oppmote-user |
| Type kall: | GET |
| URL: | aktivitetinfo |
| Parametre: | Query-parametre: aktivitetkode: Aktivitetens kode, f.eks. '7'. institusjonsnr: Institusjonsnummeret emnekode: Emnekoden, f.eks. 'EXPHIL03' versjonskode: Versjonskoden, ofte '1''. arstall: Årstallet, fire siffer. terminkode: Terminkoden, typisk 'VÅR' eller 'HØST' terminnr: Terminnummeret, ofte 1 |
| Retur: | JSON (Schema) |
| Navn: | Hent allerede registrerte studenter |
| Beskrivelse: | Denne tjenesten henter ut studenter som allerede er meldt møtt til en gitt aktivitet på en gitt dato. |
| Rolle: | oppmote-user |
| Type kall: | GET |
| URL: | alleredeRegistrert |
| Parametre: | Query-parametre: aktivitetkode: Aktivitetens kode, f.eks. '7'. institusjonsnr: Institusjonsnummeret emnekode: Emnekoden, f.eks. 'EXPHIL03' versjonskode: Versjonskoden, ofte '1''. arstall: Årstallet, fire siffer. terminkode: Terminkoden, typisk 'VÅR' eller 'HØST' terminnr: Terminnummeret, ofte 1 datoFrammote: Dato for frammøte, på formatet ddMMyyyy. undplanlopenr: Timeplanens løpenummer, se timeplan-objektet i aktivitetinformasjon |
| Retur: | JSON (Schema) |
| Navn: | Hent mulige studenter |
| Beskrivelse: | Denne tjenesten henter ut studenter, og er ment som utgangspunkt for å legge til ekstra studenter når studentene ikke opprinnelig er meldt til aktivitetsgruppa. Studentene som hentes ut har enten vurderings- eller undervisningsmelding i det gitte emnet (og semesteret). |
| Rolle: | oppmote-user |
| Type kall: | GET |
| URL: | studenter |
| Parametre: | Query-parametre: emnekode: Emnekoden, f.eks. 'EXPHIL03' versjonskode: Versjonskoden, ofte '1''. arstall: Årstallet, fire siffer. termin: Terminkoden, typisk 'VÅR' eller 'HØST' |
| Retur: | JSON (Schema) |
| Navn: | Hent registrert oppmøte for en student |
| Beskrivelse: | Denne tjenesten henter ut oppmøtet som er registrert på en student et gitt semester |
| Rolle: | oppmote-user |
| Type kall: | GET |
| URL: | studentoppmote |
| Parametre: | Query-parametre: fodselsdato: Studentens fødselsdato, på formatet ddMMyyyy personnr: Studentens personnummer. arstall: Årstallet, fire siffer. terminkode: Terminkoden, typisk 'VÅR' eller 'HØST' instnr: Institusjonsnummeret slik at det sjekkes mot riktig base. |
| Retur: | JSON (Schema) |
| Navn: | Lagre oppmøteinformasjon |
| Beskrivelse: | Denne tjenesten lagrer informasjon om oppmøte |
| Rolle: | oppmote-user |
| Type kall: | POST |
| URL: | https://<server>/fsrest/rest/oppmote/lagre |
| Parametre: | fodselsdato: Studentens fødselsdato, på formatet ddMMyy personnr: Studentens personnummer aktivitetkode: Aktivitetens kode, f.eks. '7'. institusjonsnr: Institusjonsnummeret emnekode: Emnekoden, f.eks. 'EXPHIL03' versjonskode: Versjonskoden, ofte '1''. arstall: Årstallet, fire siffer. terminkode: Terminkoden, typisk 'VÅR' eller 'HØST' terminnr: Terminnummeret, ofte 1 datoFrammote: Datoen for frammøtet, på formatet ddMMyyyy merknad: Dersom det skal være en merknad til frammøtet type: Må være enten "nye" (lagre nytt frammøte), "oppdatere" (oppdatere frammøte som allerede er registrert) eller "slette" (slette tidligere registrert frammøte). undplanlopenr: Timeplanens løpenummer, se timeplan-objektet i aktivitetinformasjon |
| Retur: | Ingenting |