Felles studentsystemTjenesten består av et antall operasjoner, til dels operasjoner som leverer større uttrekk (XML-data) og til dels operasjoner som henter ut eller tilbakeskriver enkeltelement.
I den tekniske dokumentasjonen finner man en mer detaljert beskrivelse av hvordan operasjonene brukes, bl.a. med beskrivelse av hvilke parametre operasjonene kan ta imot.
Større uttrekk
| getBASData: |
Hovedoperasjonen i tjenesten, som leverer XML-data om studenter, fagpersoner, studieprogram, kurs og undervisningsenheter (emner). Man kan velge om data om fagpersoner og historikk skal legges ved. Man kan be om fullt uttrekk, eller bare endringer siden forrige gang operasjonen ble utført (for samme institusjon). |
| getBASDataMedFP: |
Tilsvarer getBASData med fagpersoner. Denne er nå overflødig. |
| getBASEksport: |
Inkrementell utgave av getBASData som leverer endringer etter en gitt dato. |
| getLegacyBASData: |
Gammel utgave av getBASData som ikke lenger blir vedlikeholdt. Vi anbefaler å bruke getBASData i stedet. - |
| getFagpersoner: |
Alle fagpersoner. |
| getKull: |
Aktive kull |
| getRom: |
Alle rom. |
Håndtering av store datamengder
Flere av operasjonene over finnes i en variant med navn "...AsAttachment". Disse leverer utdata i form av vedlegg. Vi anbefaler at man bruker disse pga. mer effektiv håndtering av store datamengder:
-
getBASDataAsAttachment
-
getBASDataMedFPAsAttachment
-
getLegacyBASDataAttachment
-
getFagpersonerAsAttachment
Uthenting/tilbakeskriving av opplysninger om enkeltpersoner
BAS-tjenesten inneholder også operasjoner for uthenting (fra FS) og tilbakeskriving (til FS) av opplysninger om enkeltpersoner. Operasjonene kommer som regel i par getX (uthenting) og setX (oppdatering).
| getEmail / setEmail: |
Henter ut eller oppdaterer epostadressen til person med gitt personnummer. |
| getFagperson / setFagperson: |
Henter ut eller oppdaterer opplysninger om en fagperson, representert på XML-format. Opplysningene er de samme som BAS-uttrekket leverer. |
| getFagpersonAsAttachment / setFagpersonFromAttachment: |
Gjør det samme som getFagperson/setFagperson, men overfører data i vedlegg. |
| getImage / setImage: |
Henter ut eller oppdaterer bildet av en person med gitt personnummer. |
| getImageAsAttachment / setImageFromAttachment: |
Gjør det samme som getImage/setImage, men overfører data i vedlegg. |
| getUsername / setUsername: |
Henter ut eller oppdaterer epostadressen til person med gitt personnummer. |
| getSted: |
Leverer opplysninger om et sted som XML, gitt parametre institusjonsnr, fakultetnr, instituttnr og gruppenr. |
| getStedAsAttachment: |
Gjør det samme som getSted, men overfører data i vedlegg. |