Felles studentsystemHva er URL til GAUS-Webservices?
For test er URL https://fs-test.uio.no/gausws
For prod er URL https://fsweb.no/gausws
Laste opp brukere
Grensesnitt: <url-gaus-ws>/brukere/opprett
JSON-schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "En liste med brukere.",
"id": "http://fsweb.no/gausws",
"items": {
"description": "En bruker i GAUS.",
"id": "http://fsweb.no/gausws/bruker",
"name": "bruker",
"properties": {
"epost": {
"description": "Epost til bruker.",
"id": "http://fsweb.no/gausws/bruker/epost",
"name": "epost",
"type": "string"
},
"etternavn": {
"description": "Etternavn til bruker.",
"id": "http://fsweb.no/gausws/bruker/etternavn",
"name": "etternavn",
"type": "string"
},
"fnr": {
"description": "Fødselsnummer for bruker",
"id": "http://fsweb.no/gausws/bruker/fnr",
"name": "fnr",
"type": "string"
},
"fornavn": {
"description": "Fornavn til bruker.",
"id": "http://fsweb.no/gausws/bruker/fornavn",
"name": "fornavn",
"type": "string"
},
"institusjonsnr": {
"description": "Institusjonsnr som brukeren tilhører.",
"id": "http://fsweb.no/gausws/bruker/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
}
},
"required": [
"fnr",
"etternavn",
"fornavn",
"epost",
"institusjonsnr"
],
"type": "object"
},
"name": "/",
"required": [
"0"
],
"type": "array"
}
pre
JSON-eksempel
[
{
"fnr": "FNR",
"etternavn": "Nordmann",
"fornavn": "Ola",
"epost": "email",
"institusjonsnr": 1234
}
]
Laste opp saker
Grensesnitt: <url-gaus-ws>/sak/opprett
JSON-schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "En liste med godkjenningssaker.",
"id": "http://fsweb.no/gausws",
"items": {
"description": "En godkjenningssak.",
"id": "http://fsweb.no/gausws/godkjenningssak",
"properties": {
"delerSlettet": {
"default": false,
"description": "Om det er slettet deler av saken. I så fall vil integrasjonen gjøre en diff.",
"id": "http://fsweb.no/gausws/godkjenningssak/delerSlettet",
"name": "delerSlettet",
"type": "boolean"
},
"institusjonsnr": {
"description": "Institusjonsnummeret for institusjonen som sender denne saken.",
"id": "http://fsweb.no/gausws/godkjenningssak/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
},
"saksbehandler": {
"description": "Informasjon om saksbehandleren som laster opp saken.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler",
"properties": {
"epost": {
"description": "Eposten til saksbehandler.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/epost",
"name": "epost",
"type": "string"
},
"etternavn": {
"description": "Etternavnet til saksbehandler.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/etternavn",
"name": "etternavn",
"type": "string"
},
"fornavn": {
"description": "Fornavnet til saksbehandler.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/fornavn",
"name": "fornavn",
"type": "string"
},
"initialer": {
"description": "Saksbehandlers initialer.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/initialer",
"name": "initialer",
"type": "string"
},
"institusjonsnr": {
"description": "Institusjonsnummeret til institusjonen saksbehandleren hører til.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
},
"telefonnr": {
"description": "Telefonnummeret.",
"id": "http://fsweb.no/gausws/godkjenningssak/saksbehandler/telefonnr",
"name": "telefonnr",
"type": "string"
}
},
"required": [
"etternavn",
"fornavn",
"initialer",
"institusjonsnr"
],
"name": "saksbehandler",
"type": "object"
},
"sak": {
"description": "Hovedinnholdet i godkjenningssaken.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak",
"properties": {
"avslagsarsak": {
"description": "Grunn sak eventuelt er avslått.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/avslagsarsak",
"name": "avslagsarsak",
"type": "string"
},
"datoAvsluttetTimestamp": {
"description": "Java timestamp (millisekunder siden 1970) for når saken er avsluttet.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/datoAvsluttetTimestamp",
"name": "datoAvsluttetTimestamp",
"type": "integer"
},
"datoKomplettTimestamp": {
"description": "Java timestamp (millisekunder siden 1970) for når saken var komplett.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/datoKomplettTimestamp",
"name": "datoKomplettTimestamp",
"type": "integer"
},
"datoMottattTimestamp": {
"description": "Java timestamp (millisekunder siden 1970) for når saken ble mottatt.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/datoMottattTimestamp",
"name": "datoMottattTimestamp",
"title": "DatoMottattTimestamp schema.",
"type": "integer"
},
"eksternid": {
"description": "Eksternid for saken. Dette vil typisk være den interne ID'en i deres system.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/eksternid",
"name": "eksternid",
"type": "string"
},
"merknad": {
"description": "Merknad for sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/merknad",
"name": "merknad",
"type": "string"
},
"nuskode": {
"description": "Norsk standard for utdanningsgruppering. https://no.wikipedia.org/wiki/Norsk_standard_for_utdanningsgruppering",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/nuskode",
"name": "nuskode",
"type": "string"
},
"status": {
"description": "Status.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/status",
"enum": [
"BEHANDLES",
"MANGEL",
"UTGÅTT",
"UFORDELT",
"UBEHANDLET",
"BEHANDLET",
"TRUKKET"
],
"name": "status",
"type": "string"
},
"studiepoengLk": {
"description": "Antall studiepoeng rapportert til lånekassen.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/studiepoengLk",
"name": "studiepoengLk",
"type": "number"
},
"studiepoengOmfang": {
"description": "Antall studiepoeng som saken omfatter.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/studiepoengOmfang",
"name": "studiepoengOmfang",
"type": "number"
},
"studieprogramnavn": {
"description": "Navn på studieprogrammet saken omfatter.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/studieprogramnavn",
"name": "studieprogramnavn",
"type": "string"
},
"type": {
"description": "Type sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/sak/type",
"enum": [
"ANNET",
"REALKOMP",
"FORKUNNSK",
"INNPASS",
"FORHÅND"
"NOKUT"
],
"name": "type",
"type": "string"
}
},
"required":[
"status",
"type",
"eksternid"
],
"name": "sak",
"type": "object"
},
"person": {
"description": "Personen saken er knyttet til.",
"id": "http://fsweb.no/gausws/godkjenningssak/person",
"properties": {
"eksternid": {
"description": "Eksternid for person. Dette vil typisk være den interne ID'en i deres system.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/eksternid",
"name": "eksternid",
"type": "string"
},
"etternavn": {
"description": "Etternavnet til personen.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/etternavn",
"name": "etternavn",
"type": "string"
},
"fnr": {
"description": "Fødselsnummer på person.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/fnr",
"name": "fnr",
"type": "string"
},
"fodselsdatoTimestamp": {
"description": "Java timestamp (millisekunder siden 1970) for fødselsdato.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/fodselsdatoTimestamp",
"name": "fodselsdatoTimestamp",
"type": "integer"
},
"fornavn": {
"description": "Fornavnet til personen.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/fornavn",
"name": "fornavn",
"type": "string"
},
"hjemmeadresse": {
"description": "Hjemmeadresse for person. Full adresse.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/hjemmeadresse",
"name": "hjemmeadresse",
"type": "string"
},
"institusjonsnr": {
"description": "Institusjonsnummeret til institusjonen som personen tilhører.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
},
"kjonn": {
"description": "Kjønnet til personen.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/kjonn",
"enum": [
"F",
"M"
],
"name": "kjonn",
"type": "string"
},
"landkodeStatsborgerskap": {
"description": "Landkode for statsborgerskap i ISO 3166-1 alfa-2.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/landkodeStatsborgerskap",
"name": "landkodeStatsborgerskap",
"type": "string"
},
"sprakkodeMorsmal": {
"default": "NO",
"description": "Landkode for morsmål i ISO 3166-1 alfa-2.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/sprakkodeMorsmal",
"name": "sprakkodeMorsmal",
"type": "string"
},
"studieadresse": {
"description": "Studieadresse, full adresse.",
"id": "http://fsweb.no/gausws/godkjenningssak/person/studieadresse",
"name": "studieadresse",
"type": "string"
}
},
"required":[
"institusjonsnr",
"eksternid",
"fornavn",
"etternavn"
],
"name": "person",
"type": "object"
},
"dokumenter": {
"description": "Liste med dokumenter knyttet til en sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter",
"items": {
"description": "Et dokument.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument",
"properties": {
"dokumentBase64": {
"description": "En base64 enkodet streng for dokumentet.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument/dokumentBase64",
"name": "dokumentBase64",
"type": "string"
},
"eksternid": {
"description": "En ekstern dokumentid. Kan typisk være lokal id i deres system.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument/eksternid",
"name": "eksternid",
"type": "string"
},
"filextention": {
"description": "Filendelse på dokumentet.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument/filextention",
"name": "filextention",
"type": "string"
},
"filnavn": {
"description": "Filnavn for opplastet fil.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument/filnavn",
"name": "filnavn",
"type": "string"
},
"type": {
"description": "Dokumenttype. Fritekst, maks 10 tegn.",
"id": "http://fsweb.no/gausws/godkjenningssak/dokumenter/dokument/type",
"name": "type",
"type": "string"
}
},
"required":[
"eksternid"
],
"name": "dokument",
"type": "object"
},
"name": "dokumenter",
"type": "array"
},
"konklusjoner": {
"description": "Liste med konklusjoner knyttet til en sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner",
"items": {
"description": "En Konklusjon på en sak er utfallet av en søknad om godkjenning.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon",
"properties": {
"eksternid": {
"description": "Ekstern ID for konklusjonen, typisk den lokale ID'en i deres system.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon/eksternid",
"name": "eksternid",
"type": "string"
},
"konklusjonsnr": {
"description": "Løpenummer for konklusjon.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon/konklusjonsnr",
"name": "konklusjonsnr",
"type": "integer"
},
"tekst": {
"description": "Selve konklusjonen i fritekst.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon/tekst",
"name": "tekst",
"type": "string"
},
"tekstAvslag": {
"description": "Tekst ved avslag på sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon/tekstAvslag",
"name": "tekstAvslag",
"type": "string"
},
"type": {
"description": "Type konklusjon.",
"id": "http://fsweb.no/gausws/godkjenningssak/konklusjoner/konklusjon/type",
"enum": [
"OMFANG",
"JEVNGOD",
"REALKOMP",
"GODKJVURD",
"EMNEOVERL",
"FORKRAV",
"INNPASS"
"GODKJENT"
],
"name": "type",
"type": "string"
}
},
"required":[
"konklusjonsnr",
"eksternid",
"type"
],
"name": "konklusjon",
"type": "object"
},
"name": "konklusjoner",
"type": "array"
},
"utdanningsinstitusjoner": {
"description": "Liste over utdanningsinstitusjoner for en sak.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner",
"items": {
"description": "En utdanningsinstitusjon er en institusjon personen har studert ved.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon",
"properties": {
"arstallSisteResultat": {
"description": "Årstallet personen oppnådde siste resultat.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/arstallSisteResultat",
"name": "arstallSisteResultat",
"type": "integer"
},
"institusjonsnr": {
"description": "Nummeret til institusjonen.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
},
"merknad": {
"description": "Fritekst merknad rundt institusjonen.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/merknad",
"name": "merknad",
"type": "string"
},
"utdanningsresultater": {
"description": "Liste over resultater oppnådd ved en gitt institusjon.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater",
"items": {
"description": "Et resultat ved en gitt institusjon.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat",
"properties": {
"eksternid": {
"description": "Eksternid for resultatet, typisk intern id i deres system.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/eksternid",
"name": "eksternid",
"type": "string"
},
"institusjonsnr": {
"description": "Nummeret til institusjonen.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/institusjonsnr",
"name": "institusjonsnr",
"type": "integer"
},
"kategorikode": {
"description": "Kategori for resultat.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/kategorikode",
"enum": [
"PRAKSIS",
"EMNE",
"KVAL",
"EMNESAML",
"DELSTUDIER"
],
"name": "kategorikode",
"type": "string"
},
"niva": {
"description": "Nivå på resultatet.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/niva",
"enum": [
"BACHELOR",
"MASTER",
"PHD"
],
"name": "niva",
"type": "string"
},
"studnavnEngelsk": {
"description": "Engelsk studienavn.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/studnavnEngelsk",
"name": "studnavnEngelsk",
"type": "string"
},
"studnavnOriginal": {
"description": "Studienavn på originalspråket.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/studnavnOriginal",
"name": "studnavnOriginal",
"type": "string"
},
"tallVarighet": {
"description": "Varighet på kurset.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/tallVarighet",
"title": "TallVarighet schema.",
"name": "tallVarighet",
"type": "integer"
},
"tidsenhetVarighet": {
"description": "Tidsenhet for varighet.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/tidsenhetVarighet",
"enum": [
"MINUTTER",
"TIMER",
"DAGER",
"UKER",
"MÅNEDER",
"ÅR",
"SEMESTRE"
],
"name": "tidsenhetVarighet",
"type": "string"
},
"tidspunkt": {
"description": "Tidspunkt for når resultatet ble oppnådd.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/tidspunkt",
"name": "tidspunkt",
"type": "string"
},
"vektingstall": {
"description": "Vekttal gitt for resultatet.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/vektingstall",
"name": "vektingstall",
"type": "number"
},
"vektingstallNormertAar": {
"description": "Antall vekttall for et normert år.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/vektingstallNormertAar",
"name": "vektingstallNormertAar",
"type": "number"
},
"vektingstype": {
"description": "Type vekttall.",
"id": "http://fsweb.no/gausws/godkjenningssak/utdanningsinstitusjoner/utdanningsinstitusjon/utdanningsresultater/utdanningsresultat/vektingstype",
"enum": [
"VT",
"FP",
"PR",
"SP"
],
"name": "vektingstype",
"type": "string"
}
},
"required":[
"institusjonsnr",
"eksternid",
"studnavnOriginal"
],
"name": "utdanningsresultat",
"type": "object"
},
"name": "utdanningsresultater",
"type": "array"
}
},
"required":[
"institusjonsnr",
"utdanningsresultater"
],
"name": "utdanningsinstitusjon",
"type": "object"
},
"name": "utdanningsinstitusjoner",
"type": "array"
}
},
"required": [
"institusjonsnr",
"konklusjoner",
"person",
"sak",
"saksbehandler",
"utdanningsinstitusjoner"
],
"name": "godkjenningssak",
"type": "object"
},
"name": "/",
"type": "array"
}
JSON-eksempel
[
{
"delerSlettet": false,
"institusjonsnr": 1234,
"saksbehandler": {
"epost": "saksbehandler@uio.no",
"etternavn": "Saksbehandler",
"fornavn": "Grundig",
"initialer": "GS",
"institusjonsnr": 1234,
"telefonnr": "12345678"
},
"sak": {
"avslagsarsak": "Grunn sak er avslått",
"datoAvsluttetTimestamp": 1457344113727,
"datoKomplettTimestamp": 1457344112727,
"datoMottattTimestamp": 1457344111727,
"eksternid": "12312",
"merknad": "Saken er bif",
"nuskode": "NUS",
"status": "BEHANDLES",
"studiepoengLk": 10.0,
"studiepoengOmfang": 15.0,
"studieprogramnavn": "SPROG",
"type": "REALKOMP"
},
"person": {
"eksternid": "1111",
"etternavn": "Nordmann",
"fnr": "12345678909",
"fodselsdatoTimestamp": 1457144118727,
"fornavn": "Ola",
"hjemmeadresse": "Slottsplassen 1, 0010 Oslo",
"institusjonsnr": 1234,
"kjonn": "M",
"landkodeStatsborgerskap": "NO",
"sprakkodeMorsmal": "NO",
"studieadresse": "Problemveien 1, 0316 Oslo"
},
"dokumenter": [
{
"dokumentBase64": "BASE64ENKODET STRENG",
"eksternid": "324234",
"filextention": "PDF",
"filnavn": "Opplysninger.pdf",
"type": "DOKUMENT TYPE"
}
],
"konklusjoner": [
{
"eksternid": "12323",
"konklusjonsnr": 12,
"tekst": "Konklusjon fritekst",
"tekstAvslag": "Avslag fritekst",
"type": "INNPASS"
}
],
"utdanningsinstitusjoner": [
{
"arstallSisteResultat": 2015,
"institusjonsnr": 4321,
"merknad": "Merknad fritekst",
"utdanningsresultater": [
{
"eksternid": "2313112",
"institusjonsnr": 4321,
"kategorikode": "EMNE",
"niva": "BACHELOR",
"studnavnEngelsk": "STUDY NAME",
"studnavnOriginal": "STUDIENAVN",
"tallVarighet": 1,
"tidsenhetVarighet": "SEMESTRE",
"tidspunkt": "HØST 2015",
"vektingstall": 30,
"vektingstallNormertAar": 40,
"vektingstype": "SP"
}
]
}
]
}
]
Indeksering
GAUS benytter seg av SOLR for å gjøre søk raskere. Ulempen er at når data tilføres må denne indeksen oppdateres. Det er satt opp en jobb som gjør dette hver natt, men det kan være man ønsker å kjøre denne indekseringen selv. Et parameterløst kall mot: https://fsweb.no/gausws/indeksering/inkrementell bygger indeks for endringer.