FSWS CRUD

FSWS CRUD er en web-tjeneste som tilbyr CRU(D)-operasjoner (Create, Replace, Update, Delete) mot et utvalg av tabeller i FS. Delete er forel�pig ikke st�ttet.

Pakken inneholder tre hovedoperasjoner doUpsert, doSelect og doSelectMany. Alle tre operasjoner tar �n inndataparameter p� XML-format, og leverer ogs� returdata p� XML-format.

Tjenesten er SOAP-basert og bruker "stil" document/literal.

For formell definisjon av tjenesten, se lenke til WSDL og XML-skjema p� hovedsiden.

HTML-presentasjon av XML-skjemaet.

HTML-presentasjon versjon 1.1 av XML-skjemaet.

Kortfattet beskrivelse
Operasjoner

doUpsert
doSelect
doSelectMany

Tabeller

Person
Soknad
SoknadsAlternativ
Student
Vurdkombmelding
Undervisningsmelding
Studieprogramstudent
KullKlasseStudent
StudentVurdKombProtokoll

Kortfattet beskrivelse

Operasjon	Parametre	Returverdi
doUpsert	String rowXml	String	Tar kolonneverdier for en enkelt rad som parameter, gj�r INSERT hvis forekomsten ikke finnes, og UPDATE ellers.
doSelect	String rowXml	String	Tar kolonneverdier for prim�rn�kkelen som parameter, og returnerer �vrige kolonneverdier, sammen med en statuskode og en melding.
doSelectMany	String rowXml	String	Tar kolonneverdier for noen kolonner som parameter, og returnerer �vrige kolonneverdier for alle rader som tilfredsstiller s�kekriteriene.

Operasjoner

Tjenesten tilbyr tre operasjoner doUpsert, doSelect og doSelectMany. Alle operasjonene tar �n inndataparameter p� XML-format, og leverer ogs� returdata p� XML-format. B�de inndata og utdata kodes med tegnsett ISO-8859-1.

doUpsert

Operasjonen doUpsert tar kolonneverdier for en enkelt rad som parameter, gj�r INSERT hvis forekomsten ikke finnes, og UPDATE ellers. Returnerer en statuskode og en melding. Kode kan v�re 1 (vellykket), -1 (generell feil), eller -3 (fremmedn�kkelbrudd mot en av tabellene som kan oppdateres via CRUD). For vellykket Upsert vil meldingen v�re NYREGISTRERING eller OPPDATERING.

Merk at (for eksempel) Soknad har en fremmedn�kkel mot tabellen Opptak. Denne tabellen lar seg ikke oppdatere via CRUD. For at det skal v�re mulig � sette inn rader i Soknad, m� tilh�rende rad i Opptak eksistere (ettersom fremmedn�kkelen ogs� er en del av prim�rn�kkelen i Soknad.

Eksempel p� parameterverdi:

<doUpsertRequest
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://fsws.usit.no/schemas/crud crud-1.0.xsd"
  xmlns:crud="http://fsws.usit.no/schemas/crud"
  xmlns="http://fsws.usit.no/schemas/crud">
 <Person>
  <Fodselsdato>010199</Fodselsdato>
  <Personnr>12345</Personnr>
  <Kjonn>M</Kjonn>
  <Etternavn>Olsen</Etternavn>
  <Fornavn>Ola</Fornavn>
  <Landnr_Hjemland>131</Landnr_Hjemland>
  <Adrlin1_Hjemsted>Hansegata 2</Adrlin1_Hjemsted>
  <Adrlin2_Hjemsted></Adrlin2_Hjemsted>
  <Adrlin3_Hjemsted></Adrlin3_Hjemsted>
  <Postnr_Hjemsted>3200</Postnr_Hjemsted>
  <Emailadresse_Privat>ole@x.y</Emailadresse_Privat>
  <Telefonnr_Hjemsted>56781234</Telefonnr_Hjemsted>
  <Telefonnr_Mobil>98765432</Telefonnr_Mobil>
  <Studentgrunnlagkode>REA</Studentgrunnlagkode>
 </Person>
</doUpsertRequest>

Merk at elementene Adrlin2_Hjemsted og Adrlinj3_Hjemsted er tomme i eksemplet over. Det medf�rer at det blir satt inn nullmerker i databasen. Hvis denne personen finnes fra f�r og man �nsker � la v�re � oppdatere noen kolonner, s� skal disse i stedet utelates helt. I eksemplet over gj�res dette for elementet Adresseland_Hjemsted.

Hvis personen i eksemplet over ikke er registrert, s� blir responsen slik:

<doUpsertResponse xmlns="http://fsws.usit.no/schemas/crud">
<Status>
  <Kode>1</Kode>
  <Melding>NYREGISTRERING</Melding>
</Status>
</doUpsertResponse>

Flere av tabellene som lar seg oppdatere via CRUD har fremmedn�kler mot andre FS-tabeller. Ved fremmedn�kkelbrudd mot slike tabeller vil operasjonen returnere feilkode -1 (generell feil).

doSelect

Operasjonen doSelect tar kolonneverdier for prim�rn�kkelen som parameter, og returnerer �vrige kolonneverdier, sammen med en statuskode og en melding. Kode kan v�re 1 (vellykket), -1 (generell feil), eller -2 (forekomsten finnes ikke, eller parameterverdiene identifiserer ikke en unik forekomst - det siste kan inntreffe hvis noen av prim�rn�kkelkolonnene ikke er gitt verdi). For vellykket doSelect vil meldingen v�re OK.

Eksempel p� parameterverdi:

<doSelectRequest
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://fsws.usit.no/schemas/crud crud-1.0.xsd"
  xmlns:crud="http://fsws.usit.no/schemas/crud"
  xmlns="http://fsws.usit.no/schemas/crud">
 <Person>
  <Fodselsdato>010199</Fodselsdato>
  <Personnr>12345</Personnr>
 </Person>
</doSelectRequest>

Eksempel p� respons, hvis personen er registrert:

<doSelectResponse xmlns="http://fsws.usit.no/schemas/crud">
 <Status>
  <Kode>1</Kode>
  <Melding>OK</Melding>
 </Status>
 <Person>
  <Fodselsdato>010199</Fodselsdato>
  <Personnr>12345</Personnr>
  <Kjonn>M</Kjonn>
  <Etternavn>Olsen</Etternavn>
  <Fornavn>Ola</Fornavn>
  <Landnr_Hjemland>131</Landnr_Hjemland>
  <Adrlin1_Hjemsted>Hansegata 2</Adrlin1_Hjemsted>
  <Adrlin2_Hjemsted></Adrlin2_Hjemsted>
  <Adrlin3_Hjemsted></Adrlin3_Hjemsted>
  <Postnr_Hjemsted>3200</Postnr_Hjemsted>
  <Emailadresse_Privat>ole@x.y</Emailadresse_Privat>
  <Telefonnr_Hjemsted>56781234</Telefonnr_Hjemsted>
  <Telefonnr_Mobil>98765432</Telefonnr_Mobil>
  <Studentgrunnlagkode>REA</Studentgrunnlagkode>
 </Person>
</doSelectResponse>

doSelectMany

Operasjonen doSelectMany tar et tabellnavn og verdier for et antall kolonner som parametre, og returnerer alle kolonneverdier (som doSelect leverer) for alle rader som matcher verdiene i s�keparametrene.

<doSelectManyRequest
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://fsws.usit.no/schemas/crud crud-1.0.xsd"
  xmlns:crud="http://fsws.usit.no/schemas/crud"
  xmlns="http://fsws.usit.no/schemas/crud">
 <Person>
  <Etternavn>Olsen</Etternavn>
  <Landnr_Hjemland>131</Landnr_Hjemland>
 </Person>
</doSelectManyRequest>

Effekten av denne operasjonen lar seg enklest beskrive ved � vise SQL-sp�rringen som blir utf�rt:

Select Fodselsdato, Personnr, Kjonn, Etternavn, Fornavn, Landnr_Hjemland,
      Adrlin1_Hjemsted, Adrlin2_Hjemsted, Adrlin3_Hjemsted, Adresseland_Hjemsted,
      Postnr_Hjemsted
From Person
Where Etternavn = 'Olsen' 
And Landnr_Hjemland = 131;

For hvert element som gis verdi i XML-parameteren f�r vi alts� en likhet i sp�rringen (og alle likhetene kjedes sammen med And).

Resultatet av sp�rringen blir s� presentert som XML, her som et antall Person-elementer pakket inn av et doSelectManyResponse-element:

<doSelectManyResponse xmlns="http://fsws.usit.no/schemas/crud">
 <Person>
   ...
 </Person>
 <Person>
   ...
 </Person>
 <Person>
   ...
 </Person>
</doSelectManyResponse>

Tabellstrukturen

CRUD-operasjonene virker mot f�lgende FS-tabeller: Person, Soknad, SoknadsAlternativ, Student, Vurdkombmelding, Undervisningsmelding, Studieprogramstudent og KullKlasseStudent.

F�lgende opplisting viser hvilke kolonner som CRUD kan jobbe med:

Person

Emailadresse, Status_Dod og Brukernavn er lagt til i versjon 2.5.3.

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato		NUMBER(6)	NOT NULL
JA	Personnr		NUMBER(5)	NOT NULL
	Kjonn		VARCHAR(1)	NOT NULL
	Etternavn		VARCHAR(30)	NOT NULL
	Fornavn		VARCHAR(30)	NOT NULL
	Landnr_Hjemland	Land	NUMBER(3)
	Adrlin1_Hjemsted		VARCHAR(60)
	Adrlin2_Hjemsted		VARCHAR(60)
	Adrlin3_Hjemsted		VARCHAR(30)
	Adresseland_Hjemsted		VARCHAR(30)
	Postnr_Hjemsted		NUMBER(4)
	Emailadresse		VARCHAR(100)
	Status_Dod	(J/N)	VARCHAR(1)
	Brukernavn		VARCHAR(30)

Soknad

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Person	NUMBER(6)	NOT NULL
JA	Personnr	Person	NUMBER(5)	NOT NULL
JA	OPPTAKSTYPEKODE	Opptak	VARCHAR(10)	NOT NULL
JA	TERMINKODE	Opptak	VARCHAR(4)	NOT NULL
JA	Arstall	Opptak	NUMBER(4)	NOT NULL
	OPPTORGANKODE_ORD_B_ROLLE	Opptaksorgan	VARCHAR(8)

SoknadsAlternativ

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Soknad	NUMBER(6)	NOT NULL
JA	Personnr	Soknad	NUMBER(5)	NOT NULL
JA	OPPTAKSTYPEKODE	Soknad, Opptakstudieprogramtermin	VARCHAR(10)	NOT NULL
JA	TERMINKODE	Soknad, Opptakstudieprogramtermin	VARCHAR(4)	NOT NULL
JA	Arstall	Soknad, Opptakstudieprogramtermin	NUMBER(4)	NOT NULL
JA	Institusjonsnr	Opptakstudprogfordelt, Opptakstudieprogram, Kvote, Opptakstudieprogramtermin	NUMBER(8)	NOT NULL
JA	Studietypenr	Opptakstudprogfordelt, Opptakstudieprogram, Kvote, Opptakstudieprogramtermin	NUMBER(4)	NOT NULL
	Prioritetsnr		NUMBER(2)
	OPPTORGANKODE_SAKSBEH	Opptaksorgan	VARCHAR(8)
	OPPTORGANKODE_TILBUDSGIVER	Opptaksorgan	VARCHAR(8)

Student

Fichekode og Studentnr_Tildelt er lagt til i versjon 2.5.3.

NB! Kolonnen Studentnr_Tildelt kan ikke settes inn/oppdateres via web-tjenesten.

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Person	NUMBER(6)	NOT NULL
JA	Personnr	Person	NUMBER(5)	NOT NULL
	Telefonnr_Arbeid		VARCHAR(8)
	Adrlin1_Arbeid		VARCHAR(60)
	Adrlin2_Arbeid		VARCHAR(60)
	Postnr_Arbeid		NUMBER(4)
	Adrlin3_Arbeid		VARCHAR(30)
	Adresseland_Arbeid		VARCHAR(30)
	Fichekode		VARCHAR(10)
	Studentnr_Tildelt		NUMBER(6)

Vurdkombmelding

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Student	NUMBER(6)	NOT NULL
JA	Personnr	Student	NUMBER(5)	NOT NULL
JA	Institusjonsnr	Vurdkombenhet, Kommisjon	NUMBER(8)	NOT NULL
JA	EMNEKODE	Vurdkombenhet, Kommisjon	VARCHAR(12)	NOT NULL
JA	VERSJONSKODE	Vurdkombenhet, Kommisjon	VARCHAR(3)	NOT NULL
JA	VURDKOMBKODE	Vurdkombenhet, Kommisjon	VARCHAR(40)	NOT NULL
JA	Arstall	Vurdkombenhet, Kommisjon	NUMBER(4)	NOT NULL
JA	Vurdtidkode	Vurdkombenhet, Kommisjon	VARCHAR(20)	NOT NULL
	TERMINKODE_MELD_FORETATT	Ar_Arstermin	VARCHAR(4)	NOT NULL
	Arstall_Meld_Foretatt	Ar_Arstermin	NUMBER(4)	NOT NULL
	STUDIEPROGRAMKODE	Studieprogram	VARCHAR(10)

Undervisningsmelding

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Student	NUMBER(6)	NOT NULL
JA	Personnr	Student	NUMBER(5)	NOT NULL
JA	Institusjonsnr	Undervisningsenhet	NUMBER(8)	NOT NULL
JA	EMNEKODE	Undervisningsenhet	VARCHAR(12)	NOT NULL
JA	VERSJONSKODE	Undervisningsenhet	VARCHAR(3)	NOT NULL
JA	TERMINKODE	Undervisningsenhet	VARCHAR(4)	NOT NULL
JA	Arstall	Undervisningsenhet	NUMBER(4)	NOT NULL
	Terminnr	Undervisningsenhet	NUMBER(4)	NOT NULL
	TILBUDSTATKODE	Tilbudsstatus	VARCHAR(10)

Studieprogramstudent

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype	Nullmerker
JA	Fodselsdato	Student	NUMBER(6)		NOT NULL
JA	Personnr	Student	NUMBER(5)		NOT NULL
JA	STUDIEPROGRAMKODE	Kull, Studieprogram, Studieprogram_Studieretning	VARCHAR(10)		NOT NULL
JA	TERMINKODE_START	Ar_Arstermin	VARCHAR(4)		NOT NULL
JA	Arstall_Start	Ar_Arstermin	NUMBER(4)		NOT NULL
	Terminkode_Kull	Kull	VARCHAR(4)		NOT NULL
	Arstall_Kull	Kull	NUMBER(4)		NOT NULL
	STUDIERETTSTATKODE	Studierettstatus	VARCHAR(10)		NOT NULL
	Dato_Studierett_Tildelt		DATE		NOT NULL
	Status_Sperr_Aut_Oppd	(J/N)	VARCHAR(1)	'N'	NOT NULL
	Dato_Studierett_Gyldig_Til		DATE
	STUDENTSTATKODE	Studentstatus	VARCHAR(10)	'AKTIV'	NOT NULL ENABLE

KullKlasseStudent

Prim�rn�kkel	Kolonnenavn	Fremmedn�kkel	Datatype
JA	Fodselsdato	Studieprogramstudent	NUMBER(6)	NOT NULL
JA	Personnr	Studieprogramstudent	NUMBER(5)	NOT NULL
JA	STUDIEPROGRAMKODE	Kullklasse, Studieprogramstudent	VARCHAR(10)	NOT NULL
JA	TERMINKODE_START	Studieprogramstudent	VARCHAR(4)	NOT NULL
JA	Arstall_Start	Studieprogramstudent	NUMBER(4)	NOT NULL
JA	TERMINKODE	Kullklasse	VARCHAR(10)	NOT NULL
JA	Arstall	Kullklasse	NUMBER(10)	NOT NULL
JA	KLASSEKODE	Kullklasse	VARCHAR(10)	NOT NULL

StudentVurdKombProtokoll

Tabellen er lagt til i versjon 2.5.3.

NB! Denne tabellen kan kun avleses (operasjonen doUpsert er ikke st�ttet).

Key	Column Name	Foreign Key	Data Type	Nullable
Ja	Fodselsdato	Student	NUMBER(6)	NOT NULL
Ja	Personnr	Student	NUMBER(5)	NOT NULL
Ja	Institusjonsnr	Vurdkombenhet	NUMBER(8)	NOT NULL
Ja	Emnekode	Vurdkombenhet	VARCHAR(12)	NOT NULL
Ja	Versjonskode	Vurdkombenhet	VARCHAR(3)	NOT NULL
Ja	VurdKombKode	Vurdkombenhet	VARCHAR(40)	NOT NULL
Ja	Arstall	Vurdkombenhet	NUMBER(4)	NOT NULL
Ja	VurdTidKode	Vurdkombenhet	VARCHAR(20)	NOT NULL
	Karaktertall	Tallkarakter	NUMBER(5,2)