Kontakt web-servicen

Produktionsversionen af webservicens findes her

https://data.stil.dk/instregws/dataservicexml.asmx

Testversionen af samme service findes her

https://test-data.stil.dk/instregws/dataservicexml.asmx

Bemærk at testversionen udstiller testdata og ikke 100% i sync med Produktionsversionen
af institutionsregisteret.

Web-servicen udstiller en række metoder, heriblandt en simpel HelloWorld
metode, der blot returnerer ”Hello World”. En første test,
for at tjekke tilgængelighed, kan med fordel køres mod denne metode.

Credentials

For at tilgå visse metoder i servicen skal der anføres Credentials i soapheaderen.
Credentials består af et Username og et Password. For et
eksempel se under metoden HelloWorldCredentials. Credentials kan
rekvireres hos STIL.

Web-servicens metoder: HelloWorld

HelloWorld()

Pinger web-servicen, der returnerer et ”Hello World” såfremt webservicen
svarer.

HelloWorldCredentials()

Pinger web-servicen med Credentials i soapheaderen. Der returneres et
”Hello [Username]” såfremt der er anført et username i soapheaderen.

Eksempel

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:ins="http://statistik.uni-c.dk/instreg/">
	<soap:Header>
		<ins:Credentials>
			<ins:Username>Henrik</ins:Username>
			<ins:Password>Hemmeligt</ins:Password>
		</ins:Credentials>
	</soap:Header>
	<soap:Body>
		<ins:HelloWorldCredentials/>
	</soap:Body>
</soap:Envelope>

Returnerer

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<HelloWorldCredentialsResponse xmlns="http://statistik.uni-c.dk/instreg/">
			<HelloWorldCredentialsResult>Hello Henrik</HelloWorldCredentialsResult>
		</HelloWorldCredentialsResponse>
	</soap:Body>
</soap:Envelope>

Alternativt returneres ”Hello Unknown”, såfremt username er blankt, eller ”Missing Credentials” såfremt credentials er udeladt.

Web-servicens metoder: GetAll

Disse metoder kræver at der anføres credentials i soap-headeren.

Web-servicens metoder: GetAll()

Henter data for alle institutioner inklusiv aktive, nedlagte og temporære, dog eksklusiv testinstitutioner.

GetAlleAktive()

Henter data for alle aktive institutioner, dvs. eksklusiv nedlagte, tempo-rære og testinstitutioner.

GetAllInklTest

Henter data for alle institutioner inklusiv aktive, nedlagte, temporære og testinstitutioner.

GetAllAktiveInklTest

Henter data for alle aktive institutioner inklusiv testinstitutioner, eksklu-siv nedlagte og temporære institutioner.

GetAllAktiveEksklAfvikling

Henter data for alle aktive institutioner eksklusiv nedlagte, temporære og testinstitutioner, samt institutioner under afvikling

GetAll… metoder, format på response

Returnerer alle eksisterende felter i registeret. For yderlige dokumentati-on se feltliste eller brugerhåndbog på registerets hjemmeside.
Eksemplet er beskåret til kun at indeholde oplysninger på 2 institutioner af de i alt ca. 8.000 institutioner i registeret.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<GetAllInklTestResponse xmlns="http://statistik.uni-c.dk/instreg/">
			<GetAllInklTestResult Version="0.1" LastUpdated="2014-06-23T00:00:00">
				<Institutioner>
					<Institution>
						<INST_NR>201001</INST_NR>
						<INST_NAVN_FORK>Blovstrød Sk</INST_NAVN_FORK>
						<POSTNR>3450</POSTNR>
						<INST_NAVN>Blovstrød Skole</INST_NAVN>
						<CVR_NR>60183112</CVR_NR>
						<P_NR>1003275848</P_NR>
						<INST_LEDER>Kirsten S. Andersen</INST_LEDER>
						<TLF_NR>4810 8888</TLF_NR>
						<INST_ADR>Kærvej 10</INST_ADR>
						<VEJKODE>4717</VEJKODE>
						<HUSNRBOGSTAV>10</HUSNRBOGSTAV>
						<POSTBOKS xsi:nil="true"/>
						<ETAGE xsi:nil="true"/>
						<DOERBETEGNELSE xsi:nil="true"/>
						<AJOUR_DATO>2009-12-15T00:00:00</AJOUR_DATO>
						<AJOUR_BRUGER>HRK</AJOUR_BRUGER>
						<KOMMUNE_NR>201</KOMMUNE_NR>
						<KOMMUNE_NR_3>201</KOMMUNE_NR_3>
						<NEDLAGT_MND xsi:nil="true"/>
						<EJER_KODE>2</EJER_KODE>
						<UNDERV_NIV>9</UNDERV_NIV>
						<OPRETTET_MND>193808</OPRETTET_MND>
						<MIN_KODE>1</MIN_KODE>
						<INST_TYPE_2>121</INST_TYPE_2>
						<INST_TYPE_3>1012</INST_TYPE_3>
						<AKTIV_KODE>1</AKTIV_KODE>
						<BEL_KOMMUNE>201</BEL_KOMMUNE>
						<FLYTTE_KODE xsi:nil="true"/>
						<FLYTTE_INST xsi:nil="true"/>
						<HOVEDSKOLE_INST xsi:nil="true"/>
						<E_MAIL>blovstrod.skole@alleroed.dk</E_MAIL>
						<WEB_ADR>www.blovstroedskole.dk</WEB_ADR>
						<ENHEDSART>0</ENHEDSART>
						<VEJNAVN>Kærvej</VEJNAVN>
						<LOKALITET xsi:nil="true"/>
						<STEDNAVN xsi:nil="true"/>
						<GEO_BREDDE_GRAD>55.866247191515683</GEO_BREDDE_GRAD>
						<GEO_LAENGDE_GRAD>12.386330257887748</GEO_LAENGDE_GRAD>
						<POSTDISTRIKT>Allerød</POSTDISTRIKT>
						<BEL_REGION>1084</BEL_REGION>
						<REGION_NR xsi:nil="true"/>
					</Institution>
					<Institution>
						<INST_NR>201002</INST_NR>
						<INST_NAVN_FORK>Lynge Sk.</INST_NAVN_FORK>
						<POSTNR>3540</POSTNR>
						<INST_NAVN>Lynge Skole</INST_NAVN>
						<CVR_NR>60183112</CVR_NR>
						<P_NR>1003276182</P_NR>
						<INST_LEDER>Thomas Kirkegård</INST_LEDER>
						<TLF_NR>4818 7017</TLF_NR>
						<INST_ADR>Ved Gadekæret 15</INST_ADR>
						<VEJKODE>9301</VEJKODE>
						<HUSNRBOGSTAV>15</HUSNRBOGSTAV>
						<POSTBOKS xsi:nil="true"/> <ETAGE xsi:nil="true"/>
						<DOERBETEGNELSE xsi:nil="true"/>
						<AJOUR_DATO>2009-12-15T00:00:00</AJOUR_DATO>
						<AJOUR_BRUGER>HRK</AJOUR_BRUGER>
						<KOMMUNE_NR>201</KOMMUNE_NR>
						<KOMMUNE_NR_3>201</KOMMUNE_NR_3>
						<NEDLAGT_MND xsi:nil="true"/>
						<EJER_KODE>2</EJER_KODE>
						<UNDERV_NIV>10</UNDERV_NIV>
						<OPRETTET_MND>191008</OPRETTET_MND>
						<MIN_KODE>1</MIN_KODE>
						<INST_TYPE_2>121</INST_TYPE_2>
						<INST_TYPE_3>1012</INST_TYPE_3>
						<AKTIV_KODE>1</AKTIV_KODE>
						<BEL_KOMMUNE>201</BEL_KOMMUNE>
						<FLYTTE_KODE xsi:nil="true"/>
						<FLYTTE_INST xsi:nil="true"/>
						<HOVEDSKOLE_INST xsi:nil="true"/>
						<E_MAIL>lynge.skole@alleroed.dk</E_MAIL>
						<WEB_ADR>www.lyngeskole.dk</WEB_ADR>
						<ENHEDSART>0</ENHEDSART>
						<VEJNAVN>Ved Gadekæret</VEJNAVN>
						<LOKALITET xsi:nil="true"/>
						<STEDNAVN xsi:nil="true"/>
						<GEO_BREDDE_GRAD>55.843420119582134</GEO_BREDDE_GRAD>
						<GEO_LAENGDE_GRAD>12.284686726347989</GEO_LAENGDE_GRAD>
						<POSTDISTRIKT>Lynge</POSTDISTRIKT>
						<BEL_REGION>1084</BEL_REGION>
						<REGION_NR xsi:nil="true"/>
					</Institution>
				</Institutioner>
			</GetAllInklTestResult>
		</GetAllInklTestResponse>
	</soap:Body>
</soap:Envelope>

Web-servicens metoder: GetInstByInstNr(Instnr)

Denne metode kræver at der anføres credentials i soap-headeren. Henter data for institutionen Instnr. Parameteren Instnr er af typen Integer. Returnerer data i samme format som beskrevet under GetAll metoderne.

Web-servicens metoder: GetAllByInstType3, GetAllAktiveByInstType3, GetAllInklTestByInstType3 (Liste af InstType3)

Denne metode kræver at der anføres credentials i soap-headeren. Henter data for institutionen af type InstType3. Parameteren er liste med et eller flere heltal. Returnerer data i samme format som beskrevet under GetAll metoderne.

Fx henter følgende soap kald alle aktive institutioner af typen 1010 (Efterskoler med samlet særligt tilbud) og 1011 (Efterskoler).

<soap:Body>
	<ins:GetAllAktiveByInstType3>
		<ins:InstType3Liste>
		<ins:InstType3>1010</ins:InstType3>
		<ins:InstType3>1011</ins:InstType3>
		</ins:InstType3Liste>
	</ins:GetAllAktiveByInstType3>
</soap:Body>

Web-servicens metoder: GetLabels…

For en del af felterne i registeret udstilles indholdet som koder. Men GetLabels metoder kan man hente de tilshørende labels/tekstetiketter. Metoder returnerer alle koder og labels for et givent felt. Fx gælder det for feltet INST_TYPE_3 at der til koden 1012 hører labelen ’Folkeskoler’.

Disse metoder kræver at der anføres credentials i soap-headeren.

Metode Beskrivelse
GetLabelsInstType3Henter alle værdietiketter for feltet
INST_TYPE_3
GetLabelsAktivKodeHenter alle værdietiketter for feltet
AKTIV_KODE
GetLabelsEjerKodeHenter alle værdietiketter for feltet
EJER_KODE
GetLabelsEnhedsArtHenter alle værdietiketter for feltet
ENHEDSART
GetLabelsFlytteKodeHenter alle værdietiketter for feltet
FLYTTE_KODE
GetLabelsInstType2HovedgruppeHenter alle værdietiketter for feltet
INST_TYPE_2_ HOVEDGRUPPE
GetLabelsInstType2UndergruppeHenter alle værdietiketter for feltet
INST_TYPE_2_ UNDERGRUPPE
GetLabelsInstType2Henter alle værdietiketter for felter
INST_TYPE_2.
GetLabelsInstType3HovedgruppeHenter alle værdietiketter for feltet
INST_TYPE_3_ HOVEDGRUPPE
GetLabelsKommuneNrHenter alle værdietiketter for felterne
KOMMUNE_NR_3 og
BEL_KOMMUNE
GetLabelsKommuneRegionNrHenter alle værdietiketter for felter
KOMMUNE_NR.
GetLabelsMinKodeHenter alle værdietiketter for felter
MIN_KODE
GetLabelsPostNrHenter alle værdietiketter for felter
POSTNR.
GetLabelsRegionNr

Henter alle værdietiketter for felterne
REGION_NR og BEL_REGION_NR

Web-servicens metoder: GetHierarki…

Enkelte felter/dimensioner i registreret indgår i dimensionshierarkier. GetHierarki… metoderne udstiller et hierarki. Fx findes der en (9-delt) hovedgruppering over INST_TYPE_3, hvor inst_type_3 koderne 1010-1016 er samlet i hovedgruppe 101 ’Grundskoler’.

Disse metoder kræver at der anføres credentials i soap-headeren.

MetodeBeskrivelse
GetHierarkiInstType3Henter hierarki mellem INST_TYPE_3 og INST_TYPE_3_ HOVEDGRUPPE
GetHierarkiInstType2Henter hierarki mellem INST_TYPE_2 , INST_TYPE_2_ HOVEDGRUPPE og INST_TYPE_2_UNDERGRUPPE