Felles studentsystemTeknisk dokumentasjon
Dette er den tekniske dokumentasjonen av FSWS (FS Web Service), som blant annet inkluderer WSDL-filer og XML-skjemaer for uttrekk.
- Beskrivelse av REST-tjenester i FSWS
- Beskrivelser av LMS-integrasjon
- FSWS brukerdokumentasjon
- Dokumentasjon tidligere versjoner
For henvendelser om FSWS, send epost til fs-support@sikt.no. Ta med "FSWS" i emnefeltet.
URL til tjenester
FSWS jobber mot to ulike servere, TEST og PROD.
TEST-server er https://fs-test.uio.no
PROD-server er https://fsws.usit.no
Versjon
Gjeldende versjon av FSWS-REST kan slås opp med:
Test: https://fs-test.uio.no/fsrest/Versjon
Prod: https://fsws.usit.no/fsrest/Versjon
Oversiktsbilde for FSWS
FSWS er delt opp i to typer tjenester: SOAP og REST, At man bruker SOAP-tjenestene signaliseres ved at det står "fsservices" i URL. At man bruker REST-tjenestene signaliseres ved at det står "fsrest" i URL.
Hvordan kommer jeg i gang med å teste tjenester?
For å komme igang så trenger du å ha et brukernavn og et passord. Dette må bestilles gjennom FS-kontakten på institusjonen du skal lage integrasjon mot. Den personen godkjenner behovet og sender mail til "fs-support@fsat.no" med følgende opplysninger:
- Om det er en ekstern leverandør som vil ha tilgang, i så fall navn på leverandør.
- Navn og mobilnummer til kontaktperson
- Hvilke tjenester som man ønsker å benytte
Når dette er gjort kan man sette igang å teste.
Dersom man allerede har en bruker, men mangler tilgang til de gitte tjenestene, send en mail til "fs-support@fsat.no" med hvilken bruker det gjelder og hvilken tjeneste man ønsker å få tilgang til.
SOAP vs. REST
Det er mange diskusjoner rundt SOAP mot REST i Webservicer, og den generelle konklusjonen er at dersom man ikke har spesielle behov, så er REST den beste veien å gå. Dette er den konklusjonen som FS har lagt seg på, og alle nye tjenester som kommer fra oss vil være på REST. Dette vil si at vi ikke videreutvikler SOAP-tjenestene våre, vi vil kun foreta feilrettinger.
Dersom du ikke allerede bruker SOAP-tjenestene, ikke begynn å bruke dem! Vi kommer ikke til å støtte dem utover feilrettinger. REST-grensesnittene leverer de samme dataene (og mer til) og det er her utviklingen fortsetter.
SOAP-tjenestene i FSWS
FSWS er organisert i flere tjenester. En institusjon trenger bare ett brukernavn/passord mot FSWS, men man må be om tilgang til hver enkelt tjeneste.
Beskrivelse av tjenestene:
- BAS: Uttrekk til BrukerAdministrative Systemer.
- Bris: Uttrekk til Studentsamskipnaden i Oslo.
- CDM: Uttrekk til utdanning.no.
- CRUD: Innsetting, oppdatering og uthenting mot utvalgte FS-tabeller.
- Portal: Uttrekk til bruk i institusjonenes portaler.
- StudInfo: Gjør pakken fs.pk_fs20040 tilgjengelig som web service.
- StudInfo2 (pdf)
Testing og utvikling av klienter
WSDL og XML-skjemaer
WSDL (Web Services Description Language) beskriver grensesnittet mot SOAP web-tjenester. XML Schema beskriver strukturen på XML-dokumenter (bla. uttrekk fra FSWS).
Dataporten
FS har nå begynt å lage tjenester mot Dataporten, du kan lese mer om dette her.