slam api 2015 - norkart · 2018. 9. 11. · title: microsoft word - slam api 2015.docx author:...

Dato: 11.09.2018 Side 1

KOMTEK- SLAM API

Oppdatert 11.09.18

Norkart 2

1 Innhold 2 OVERORDNET BESKRIVELSE 5

2.1 Protokoll 5

2.2 Autentisering 5

2.3 Metodekall 5

3 METODER 6

3.1 Felles for alle metoder 6

3.2 Kundekobling (datagrunnlag oversikt) 6

3.2.1 Datamodell, KundekoblingDto 6

3.2.2 Metodekall 6

3.2.3 Eksempel på data 6

3.3 Typetømming 7

3.3.1 Datamodell, TommetypeDto 7

3.3.2 Metodekall 7


3.4 Tømmeaktører 8

3.4.1 Datamodell, TommeaktorDto 8

3.4.2 Metodekall 8


3.5 Resipienter 9

3.5.1 Datamodell, ResipientDto 9

3.5.2 Metodekall 9


3.6 Materialtyper 10

3.6.1 Datamodell, MaterialtypeDto 10

3.6.2 Metodekall 10


3.7 Innholdstyper 11

3.7.1 Datamodell, InnholdstypeDto 11

3.7.2 Metodekall 11


3.8 Anleggstyper 12

3.8.1 Datamodell, AnleggstypeDto 12

3.8.2 Metodekall 12


3.9 Adkomsttyper 13

Norkart 3

3.9.1 Datamodell, AdkomstDto 13

3.9.2 Metodekall 13


3.10 Avviksmeldinger 14

3.10.1 Datamodell, AvviksmeldingerDto 14

3.10.2 Metodekall 14


3.11 Arbeidslister 15

3.11.1 Datamodell, ArbeidslisteDto 15



3.12 Arbeidslisteoppgaver 16

3.12.1 Datamodell, ArbeidslisteoppgaveDto 16



3.13 Anlegg endret etter gitt dato 17

3.13.1 Datamodell, AnleggDto 17



3.14 Anlegg på id 18



3.15 Tilknyttede avtaler 19

3.15.1 Datamodell, AvtaleDto 19



3.16 Avtaler endret etter gitt dato 21

3.16.1 Datamodell, AvtaleDto 21



3.17 Oppdatering av anlegg 22

3.17.1 Datamodell, AnleggFeltDto 22


3.18 Registrering av besøk (tømming). 23

3.18.1 Datamodell, BesoekDto 24


3.18.3 Krav til tømmedata 25

Norkart 4

3.19 Registrering av avvik 25

3.19.1 Datamodel, AvvikDto 25


3.20 Tilknyttede bygninger 26

3.20.1 Datamodell, TilknyttedeBygningerDto 26



3.21 Tilknyttede Adresser 27

3.21.1 Datamodell, TilknyttedeAdresserDto 27



3.22 Transaksjoner/logg 28

3.22.1 Datamodell, TransaksjonDto 28



3.23 Anlegg avtale kobling 29

3.23.1 Datamodell, AnleggAvtaleKoblingDto 29



3.24 Vis registrerte besøk 30

3.24.1 Datamodell, BesoekDTO 30



3.25 Hent alle anlegg-bygningingskoblinger 31

3.25.1 Datamodell, BesoekDTO 31



3.26 Hent anleggsstatuser 32

3.26.1 Datamodell, AnleggStatusDto 32



Norkart 5

2 OVERORDNET BESKRIVELSE

Dette dokumentet beskriver integrasjonspunkt mellom KOMTEK og renovatører på slamtømming. Den første versjonen baserer seg på servicelaget for KTF. Versjon to ligger på en sentral server og er den samme for alle kommunene. Versjon en ble installert i DMZ sonen hos kommunen. Versjon to har fått norsk språkdrakt.

Alle kode-eksempler vil vises i C#.

2.1 Protokoll SAPI er basert på Microsoft sitt Web API grensesnitt. All datautveksling skjer med JSON protokollen. For mer informasjon om JSON se http://json.org/

2.2 Autentisering Alle metodekall skal inneholde WebClient headers med informasjon om Kundenavn, Brukernavn og passord.

Eks

var client = new System.Net.WebClient();

client.Headers["Kundenavn"] = "XXXXX"; client.Headers["Brukernavn"] = "XXXXX"; client.Headers["Passord"] = "XXXX"; client.Headers.Add("Content-Type", "application/json"); client.UseDefaultCredentials = true; client.Encoding = Encoding.UTF8;

Kundenavn, brukernavn og passord oppgis av NORKART AS.

2.3 Metodekall Alle metodekall uavhengig av uthenting eller registrering av data skal inneholde informasjon om hvilket datagrunnlag som betjenes.

Alle metoder som henter ut data eller registrerer data er det påkrevd at det legges til en informasjon til i WebClient headers

client.Headers["Datagrunnlag"] = "XXXX";

Norkart 6

3 METODER

3.1 Felles for alle metoder Alle metoder forutsetter at det settes følgende data

Viktig å merke seg at det er påkrevd å bruke datagrunnlag i alle metodekall utenom uthentingen av datagrunnlaget (kundekoblingen).

private const string url = "http://XXXXXXXXXXXXXXXXXXXXXX";

var client = new System.Net.WebClient(); client.Headers["Kundenavn"] = "xxxxxxxxxx"; client.Headers["Brukernavn"] = " xxxxxxxxxx"; client.Headers["Passord"] = " xxxxxxxxxx"; client.Headers["Datagrunnlag"] = " xxxxxxxxxx"; client.Headers.Add("Content-Type", "application/json"); client.UseDefaultCredentials = true; client.Encoding = Encoding.UTF8;

3.2 Kundekobling (datagrunnlag oversikt) Metoden henter ut alle koblinger kunden har mot diverse datagrunnlag. Datagrunnlaget vil være påkrevd i alle andre metoder som henter ut data.

3.2.1 Datamodell, KundekoblingDto

Datafelt .NET Datatype Beskrivelse Kunde String (255) Renovatør Datagrunnlag String (255) Data fra KOMTEK, kan

være kommune eller IKS.

3.2.2 Metodekall

var response = client.DownloadString(url + "Datagrunnlag/");

3.2.3 Eksempel på data [{"Kunde":"Septik24","Datagrunnalg":"FunktestSlamRingsaker"},{"Kunde":"Septik24" ,"Datagrunnlag":"Askøy kommune"}]

Norkart 7

3.3 Typetømming Lister ut alle registrerte typer tømminger som er registrert i datagrunnlaget.

3.3.1 Datamodell, TommetypeDto

Datafelt .NET Datatype Beskrivelse Datagrunnlag String (255) En tekst som angir

opprinnelsen til dataene Id Integer Unik id for tømmetypen i

dette datagrunnlaget. Tekst String (50) Beskrivende navn for

tømmetypen

3.3.2 Metodekall var response = client.DownloadString(url + "Tommetyper/");

3.3.3 Eksempel på data

[{"Datagrunnlag":"FunktestSlamRingsaker","Id":0,"Tekst":"R: {Ukjent}"]

Norkart 8

3.4 Tømmeaktører Lister ut alle tømmeaktører registrert på valgt datagrunnlag.

3.4.1 Datamodell, TommeaktorDto


opprinnelsen til dataene Id Integer Unik id for tømmeaktøren

i dette datagrunnlaget. Tekst String (50) Beskrivende navn for

tømmeaktøren

3.4.2 Metodekall var response = client.DownloadString(url + "Tommeaktorer/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":1,"Tekst":"R: Kommunens renovatør"}]

Norkart 9

3.5 Resipienter Lister ut alle resipienter registrert på valgt datagrunnlag.

3.5.1 Datamodell, ResipientDto


opprinnelsen til dataene Id Integer Unik id for resipienten i


resipienten

3.5.2 Metodekall var response = client.DownloadString(url + " Resipienttyper/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":1,"Tekst":"{Ukjent}"},{"Datagrunnl

ag":"FunktestSlamRingsaker","Id":2,"Tekst":"Ingen"}]

Norkart 10

3.6 Materialtyper Lister ut alle materialtyper registrert på valgt datagrunnlag.

3.6.1 Datamodell, MaterialtypeDto


opprinnelsen til dataene Id Integer Unik id for materialtypen i


materialtypen

3.6.2 Metodekall var response = client.DownloadString(url + " Materialtyper/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":1,"Tekst":"R: {Ukjent}"},{"Datagrunnlag":"FunktestSlamRingsaker","Id":2,"Tekst":"R: Betong"}]

Norkart 11

3.7 Innholdstyper Lister ut alle innholdstyper registrert på valgt datagrunnlag.

3.7.1 Datamodell, InnholdstypeDto


opprinnelsen til dataene Id Integer Unik id for innholdstype i


innholdstypen

3.7.2 Metodekall var response = client.DownloadString(url + " Innholdstyper/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":0,"Tekst":"R: {Ukjent}"},{"Datagru

nnlag":"FunktestSlamRingsaker","Id":1,"Tekst":"R: Gråvann"}}]

Norkart 12

3.8 Anleggstyper Lister ut alle anleggstyper registrert på valgt datagrunnlag.

3.8.1 Datamodell, AnleggstypeDto


opprinnelsen til dataene Id Integer Unik id for anleggstype i

dette datagrunnlaget. Tekst String (50) Beskrivende tekst for

anleggstype

3.8.2 Metodekall var response = client.DownloadString(url + " Anleggstyper/");


[{"Datagrunnlag":"Askøy kommune","Id":1,"Tekst":"{Ukjent}"}]

Norkart 13

3.9 Adkomsttyper Lister ut alle adkomst-typer registrert på valgt datagrunnlag.

3.9.1 Datamodell, AdkomstDto


opprinnelsen til dataene Id Integer Unik id for adkomstype i

dette datagrunnlaget. Tekst String (50) Beskrivende tekst for

adkomsttype

3.9.2 Metodekall var response = client.DownloadString(url + " Adkomst/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":1,"Tekst":"R: {Ukjent}"}}]

Norkart 14

3.10 Avviksmeldinger Lister ut alle avviksmeldingstyper registrert på valgt datagrunnlag.

3.10.1 Datamodell, AvviksmeldingerDto


opprinnelsen til dataene Id Integer Unik id Tekst String (150) Beskrivende tekst

3.10.2 Metodekall var response = client.DownloadString(url + " Avviksmeldinger/");

3.10.3 Eksempel på data [{"Datagrunnlag":"FunktestSlamRingsaker","Id":23,"Tekst":"R: Forurensning"}]

Norkart 15

3.11 Arbeidslister Lister ut alle aktive arbeidslister registrert på valgt datagrunnlag.

3.11.1 Datamodell, ArbeidslisteDto



3.11.2 Metodekall var response = client.DownloadString(url + " Arbeidslister/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":9,"Tekst":"Stavsberg skolekrets}]

Norkart 16

3.12 Arbeidslisteoppgaver Lister ut alle oppgaver på aktive arbeidslister registrert på valgt datagrunnlag.

3.12.1 Datamodell, ArbeidslisteoppgaveDto


opprinnelsen til dataene Id Integer Unik id ArbeidsListeId Integer Kobling mot arbeidsliste BestiltDato Nullable DateTime Bestillingsdato for

oppgaven Avtalenr Integer Avtalen anlegget er koblet

mot Anleggsnr Integer Anlegget bestillingen er

koblet mot Kommentar String (255) Eventuelle kommentarer Volum Integer Anleggets volum BestillingstypeId Integer Bestillingstype, se

tømmetyper.

3.12.2 Metodekall var response = client.DownloadString(url + " Arbeidslisteoppgaver/");


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":466,"ArbeidsListeId":9,"BestiltDato":"2012-0

3-16T00:00:00","Avtalenr":21116,"Anleggsnr":730,"Kommentar":"","Volum":4}]

Norkart 17

3.13 Anlegg endret etter gitt dato Lister ut alle anlegg som er endret etter gitt dato på valgt datagrunnlag.

3.13.1 Datamodell, AnleggDto

Datafelt .NET Datatype Beskrivelse Datagrunnlag String (255) En tekst som angir opprinnelsen

til dataene Id Integer Unik id Status Nullable Integer 0=I drift, 1=Blendet, Kommunes

egen definisjoner, se punkt 3.26.

Volum Nullable Float Anleggets volum Vaatvolum Nullable Float Anleggets våtvolum AntallKammer Nullable Integer Antall kammer på anlegget Materialtype Nullable Integer Type materiale på anlegget Innholdstype Nullable Integer Type innhold på anlegget TattiBrukDato Nullable DateTime Dato anlegget ble tatt i bruk Kommentar String (512) Kommentar på anlegget Plassering String (255) Plassering av anlegget Slangeutlegg Nullable Integer Slangeutlegg i meter AvstandTilVei Nullable Integer Avstand til vei i meter Hoydeforskjell Nullable Integer Høydeforskjell i meter Adkomsttype Nullable Integer Type adkomst Avlopstype Nullable Integer Type avløp BlendetDato Nullable DateTime Hvis blendet, angitt dato TommesAv Nullable Integer Id på renovatør ForrigeTomming Nullable DateTime Forrige tømming av anlegget NesteTomming Nullable DateTime Neste tømming av anlegget Tommefrekvens Nullable Integer Tømmefrekvens i mnd EndretDato Nullable DateTime Siste gang anleggets data ble

endret RegistrertDato Nullable DateTime Dato anlegget ble lagt inn i

KOMTEK Resipienttype Nullable Integer Type resipient Nord Nullable Double Anleggets koordinat nord Oest Nullable Double Anleggets Koordinat øst Karttype Nullable Double Sosisy type Anleggstype Nullable Integer Anleggstype, se pkt 3.8.1 StoppepunktNord Nullable Double StoppepunktOest Nullable Double

3.13.2 Metodekall var response = client.DownloadString(url + "AnleggEndretEtterDato/?endretdato=" + "2014-09-15");

Norkart 18

Datoformatet er: YYYY-MM-DD


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":1

303,"Status":0,"Volum":0.0,"Vaatvolum":0.0,"AntallKammer":0,"Materialtype":1,"In

nholdstypetype":0,"TattiBrukDato":null,"Kommentar":" ","Plassering":"198","Slang

eutlegg":0,"AvstandTilVei":0,"Hoydeforskjell":0,"Adkomsttype":1,"Avlopstype":1,"

BlendetDato":null,"TommesAv":1,"ForrigeTomming":null,"NesteTomming":"2016-03-01T

00:00:00","Tommefrekvens":12,"EndretDato":"2014-09-15T00:00:00","RegistrertDato"

:"2004-11-02T00:00:00","Resipienttype":null,"Nord":6763429.0,"Oest":589129.0,"Ka

rtype":22}]

3.14 Anlegg på id Henter ut spesifikt anlegg basert på id.

Merk at id ikke nødvendigvis korresponderer med anleggets id i kommunen.

3.14.1 Metodekall var response = client.DownloadString(url + "AnleggPaaId/?anleggsnr=" + 1);

3.14.2 Eksempel på data Returnerer model AnleggDto

Norkart 19

3.15 Tilknyttede avtaler Lister ut alle tilknyttede avtaler på gitt anleggs nummer registrert på valgt datagrunnlag.

3.15.1 Datamodell, AvtaleDto

Datafelt .NET Datatype Beskrivelse Datagrunnlag String (255) En tekst som angir opprinnelsen til dataene Id Integer Unik id EierNavn String (50) Eiernavn EierNavn2 String (50) EierAdresse String (50) EierAdresse2 String (50) EierRegion String (50) EierPostnr Nullable int EierPostSted String (50) EierLandkode String (3) EierPoststedUtland String (255) RegningsmottakerNavn String (50) RegningsmottakerNavn2 String (50) RegningsmottakerAdresse String (50) RegningsmottakerAdresse2 String (50) RegningsmottakerPostnr Nullable int RegningsmottakerPostSted String (50) RegningsmottakerRegion String (50) RegningsmottakerLandkode String (3) RegningsmottakerPoststedUtland String (255) KommuneNr Nullable int Gnr Nullable int Bnr Nullable int Fnr Nullable int Snr Nullable int Adresse String (255) Avtalens adresse Postnr Nullable int Avtalens postnummer Poststed String (50) Avtalens posted

3.15.2 Metodekall

var response = client.DownloadString(url + "AvtalePaaAnlegg/?anleggsnr=" + 1);

Norkart 20


[{"Datagrunnlag":"FunktestSlamRingsaker","Id":3160,"Eiernavn":"Smeby May-gunn","

EierNavn2":null,"EierAdresse":"Østbrumundvegen 234","EierAdresse2":null,"EierReg

ion":null,"EierPostnr":2387,"EierPostSted":"Brumunddal","EierLandkode":"NO","Eie

rPoststedUtland":null,"RegningsmottakerNavn":"Smeby May-gunn","RegningsmottakerN

avn2":null,"RegningsmottakerAdresse":"Østbrumundvegen 234","RegningsmottakerAdre

sse2":null,"RegningsmottakerPostnr":2387,"RegningsmottakerPostSted":"Brumunddal"

,"RegningsmottakerRegion":null,"RegningsmottakerLandkode":"NO","Regningsmottaker

PoststedUtland":null,"KommuneNr":412,"Gnr":78,"Bnr":5,"Fnr":0,"Snr":0,"Adresse":

"Østbrumundvegen 234","Postnr":2387,"Poststed":"Brumunddal"}]

Norkart 21

3.16 Avtaler endret etter gitt dato Lister ut alle avtaler endret etter gitt dato registrert på valgt datagrunnlag.

3.16.1 Datamodell, AvtaleDto Se AvtaleDto i «Tilknyttede avtaler».

3.16.2 Metodekall var response = client.DownloadString(url + "AvtaleEndretEtterDato/?endretdato="

+ "2014-01-01");

Datoformatet er: YYYY-MM-DD

3.16.3 Eksempel på data Se på beskrivelsen i «Tilknyttede avtaler».

Norkart 22

3.17 Oppdatering av anlegg Oppdater egenskaper på anlegget basert på Id og datagrunnlag.

3.17.1 Datamodell, AnleggFeltDto


opprinnelsen til dataene Id Integer Unik id Nord Nullable double Anlegg koordinat,N Oest Nullable double Anlegg koordinat,E StoppepunktNord Nullable double StoppepunktOest Nullable double Kartype Nullable integer Sosisys type Hoydeforskjell Nullable float Hoydeforskjell i meter Slangeutlegg Nullable float Slangeutlegg i meter Anleggstype (utgår) Nullable integer Viser til typetabellid Adkomst Nullable integer Viser til typetabellid Materiale Nullable integer Viser til typetabellid Innhold Nullable integer Viser til typetabellid Volum Nullable float Anleggets volum i kbm Plassering String (255) Tekstlig beskrivelse av

plassering

3.17.2 Metodekall var client = GetWebClient();

var serializerR = new JavaScriptSerializer();

var anlegg = new AnleggFeltDto();

anlegg.Id = 972;

anlegg.Volum = 2;

anlegg.Plassering = "Bak garasjen.";

anlegg.Innhold = 1;

anlegg.Slangeutlegg = 1;

anlegg.Hoydeforskjell = 15;

anlegg.Materiale = 2;

Norkart 23

anlegg.Kartype = 22;

anlegg.Adkomst = 2;

anlegg.Nord = 6777439;

anlegg.Oest = 578518;

anlegg.StoppepunktNord = 6777439;

anlegg.StoppepunktOest = 578518;

var data = serializerR.Serialize(anlegg);

var response = client.UploadString(url + "OppdaterAnlegg/", data);

Responsen er en tekst i følgende format:

"Oppdatering av anlegg FunktestSlamRingsaker/972:OK!" "Oppdatering av anlegg feilet, klarte ikke å serialisere anlegget!" "Oppdatering av anlegg feilet, datagrunnlaget er ikke gyldig!" "Oppdatering av anlegg FunktestSlamRingsaker/972 feilet, [Feilmelding]"

3.18 Registrering av besøk (tømming). Registrering av besøk på angitt anlegg i satt datagrunnlag.

Norkart 24

3.18.1 Datamodell, BesoekDto


opprinnelsen til dataene Id Guid Unik Guid for tømmingen.

Lages på klienten. AnleggsId Integer Komtek id for anlegg TommetypeInnhold Nullable Integer Typeid for innholdstyper TomDato DateTime Dato for tømming TommeVolum Nullable float Tømmevolum TommeType Nullable tømmetype Typeid for tømmetyper Tommemerknad String (255) Kommentar på

tømmingen. IkkeTomt Boolean Angir om tømming er

gjort eller ikke. ArbeidslisteOppgaveId Nullable Int Tilknytt tommingen til

en arbeidslisteoppgave i KOMTEK

3.18.2 Metodekall

var besoek = new BesoekDto(); besoek.AnleggsId = 972; besoek.Id = Guid.NewGuid(); besoek.IkkeTomt = false; besoek.TomDato = new DateTime(2015, 1, 19); besoek.TommeType = 1; besoek.TommeVolum = 2; besoek.Tommemerknad = "Eier var ikke hjemme, fikk tømt allikevel"; besoek.TommetypeInnhold = 1; var data = JsonConvert.SerializeObject(besoek); var response = client.UploadString(url + "Besoek/", data);

MERK!

besoek.Id må lages på klienten!

Årsaken til dette er at eventuelle avvik skal kobles til tømmingen.


Registrering av besøk: OK! Registrering feilet, årsak " + [Feilmelding] Registrering feilet, mangler datagrunnlag! Registrering feilet, mangler kundenavn! Registrering feilet, mangler brukernavn!

Norkart 25

3.18.3 Krav til tømmedata Følgende data må være satt på en tømming

Tømmedato Type tømming Tømmevolum må være større enn 0 når egenskapen Ikketømt=false. Registreringen må skje på et aktivt anlegg som har en tømmekomponent.

3.19 Registrering av avvik Registrering av avvik på avvik i valgt datagrunnlag

3.19.1 Datamodel, AvvikDto


opprinnelsen til dataene Id Guid Unik Guid for avviket.

Lages på klienten. BesoekId Guid Unik Guid for tømmingen

som avviket skal knyttes til.

Tekst String (500) Tekstlig beskrivelse MeldingstypeId Integer Meldingstype id BildeURL String (500) URL til bildet som

beskriver avviket.

3.19.2 Metodekall

var avvik = new AvvikDto(); avvik.BesoekId = besoksGuid; avvik.Id = Guid.NewGuid(); avvik.MeldingstypeId = 1; avvik.Tekst = "Eier var ikke hjemme, bommen låst"; var data = JsonConvert.SerializeObject(avvik); var response = client.UploadString(url + "Avvik/", data);

Merk at avvik.BesoekId må være knyttet til et allerede registrert besøk.


Norkart 26

Registrering av avvik: OK! Registrering feilet, årsak " + [Feilmelding] Registrering feilet, mangler datagrunnlag! Registrering feilet, mangler kundenavn! Registrering feilet, mangler brukernavn!

3.20 Tilknyttede bygninger

3.20.1 Datamodell, TilknyttedeBygningerDto


opprinnelsen til dataene ByggId String (30) Anleggnr Integer BygningsNr Long LopeNr Long KommuneId Integer BygningstypeKode Integer Bygningstype String (1000) BygningstatusKode String (255) Bygningstatus String (1000) BygingstatusDato DateTime AntallEtasjer Integer AntallBoenheter Integer Bebygdareal Double BruksarealTilBolig Double BruksarealTilAnnet Double BruksarealTotalt Double Alternativtareal Double Alternativtareal2 Double OppdatertDato DateTime

3.20.2 Metodekall

var response = client.DownloadString(url + "TilknyttedeBygninger/?anleggsnr=" + 1684);


Norkart 27

[{"Datagrunnlag":"VAP","ByggId":"13135002000","Anleggnr":1684,"BygningsNr":13135002,"LopeNr":null,"KommuneId":1432,"BygningstypeKode":151,"Bygningstype":"Bo- og servicesenter","BygningstatusKode":"TB","Bygningstatus":"Tatt i bruk","BygingstatusDato":"1991-06-01T00:00:00","AntallEtasjer":0,"AntallBoenheter":8,"Bebygdareal":0.0,"BruksarealTilBolig":577.0,"BruksarealTilAnnet":0.0,"BruksarealTotalt":577.0,"Alternativtareal":0.0,"Alternativtareal2":0.0,"OppdatertDato":"2015-02-03T17:16:11.8"}]"

3.21 Tilknyttede Adresser

3.21.1 Datamodell, TilknyttedeAdresserDto


opprinnelsen til dataene Anleggnr Integer Anlegget id fra KTF AdresseId String (30) AdresseType String (255) AdresseTypeKort String (1) Adressekode String (30) Vegnavn String (255) HusNr Integer Bokstav String (255) UnderNr Integer PostNr String (4) Poststed String (50) Adressetilleggsnavn String (255) MatrikkelenhetId String (30) OppdatertDato DateTime

3.21.2 Metodekall

var response = client.DownloadString(url + "TilknyttedeAdresser/?anleggsnr=" + 1684);


[{"Datagrunnlag":"VAP","Anleggnr":1684,"AdresseId":"14320430000240000000","AdresseType":"Gateadresse","AdresseTypeKort":"V","Adressekode":"4300","Vegnavn":"Prestebøen","HusNr":24,"Bokstav":"","UnderNr":null,"PostNr":"6809","Poststed":"FØRDE","Adressetilleggsnavn":"","MatrikkelenhetId":"14320002202340000000","OppdatertDato":"2015-02-03T17:16:12.303"}]"

Norkart 28

3.22 Transaksjoner/logg

Alle transaksjoner logges og er tilgjengelig via følgende metode.

3.22.1 Datamodell, TransaksjonDto

Datafelt .NET Datatype Beskrivelse Id Int64 Unikt id, løpenummer Kundenavn String (255) Bruker String (50) Type String (50) A = Fra kommunen

B = Fra felt tjener C = Fra felt til tjener D = Fra tjener til kommune E = Feil I = Informasjon

Data String (max) Informasjon Dato Nullable DateTime Tidspunktet for registrering

3.22.2 Metodekall

var query = string.Format("{0}Transaksjon/?startDato={1}&sluttDato={2}", url, new DateTime(2015, 4, 9).ToString("yyyy-MM-dd"), new DateTime(2015, 4, 10).ToString("yyyy-MM-dd"));


Norkart 29

"[{\"Id\":2190382,\"Kundenavn\":\"Septik24\",\"Bruker\":\"bruker\",\"Type\":\"B\",\"Data\":\"GetDatagrunnlag\",\"Dato\":\"2015-04-09T08:17:00\"}

3.23 Anlegg avtale kobling Lister ut en kobling mellom avtale og anlegg.

Merk at dette er en mange til mange kobling. Det kan være flere avtaler koblet til ett anlegg, og det kan være flere anlegg koblet til en avtale.

3.23.1 Datamodell, AnleggAvtaleKoblingDto


opprinnelsen til dataene AvtaleId Integer AnleggId Integer

3.23.2 Metodekall

var response = client.DownloadString(url + "AvtaleAnleggKobling/");


"[{ "Datagrunnlag ": "HAMAR_VAP ", "AvtaleId ":1128, "AnleggId ":1},{ "Datagrunnlag ": "HAMAR_VAP ", "AvtaleId ":1128, "AnleggId ":2},{ "Datagrunnlag ": "HAMAR_VAP ", "AvtaleId ":3348, "AnleggId ":5},{ "{ "Datagrunnlag ": "HAMAR_VAP ", "AvtaleId ":8765, "AnleggId ":2058}]"

Norkart 30

3.24 Vis registrerte besøk Henter ut alle registreringer på valgt datagrunnlag

3.24.1 Datamodell, BesoekDTO Se definisjonen tidligere i dokumentasjonen.

3.24.2 Metodekall

var query = string.Format("{0}Besoek/?startDato={1}&sluttDato={2}",

url, new DateTime(2014, 1, 1).ToString("yyyy-MM-dd"), new DateTime(2016, 1, 1).ToString("yyyy-MM-dd"));

var response = client.DownloadString(query);


"[{ "Datagrunnlag ": "HAMAR_VAP ", "Id ": "d0a86b7d-b32a-4e53-826c-18e766df3131 ", "AnleggsId ":1, "TommetypeInnhold ":1, "TomDato ": "2015-01-19T00:00:00 ", "TommeVolum ":2.0, "TommeType ":1, "Tommemerknad ": "Fikk ikke tømt , årsak registrert som avvik ", "IkkeTomt ":false},{ "Datagrunnlag ": "HAMAR_VAP ", "Id ": "2d59b0a5-9572-4fd8-9863-c6f87849bd36 ", "AnleggsId ":1, "TommetypeInnhold ":1, "TomDato ": "2015-01-19T00:00:00 ", "TommeVolum ":2.0, "TommeType ":1, "Tommemerknad ": "Fikk ikke tømt , årsak registrert som avvik ", "IkkeTomt ":false}]"

Norkart 31

3.25 Hent alle anlegg-bygningingskoblinger

Henter alle anlegg hvor det er kobling til et eller flere bygninger

3.25.1 Datamodell, BesoekDTO


opprinnelsen til dataene AnleggNr Integer TilknyttedeBygninger List<long> En liste med bygningsnr

3.25.2 Metodekall

var response = client.DownloadString(url + "TilknyttedeBygninger/");

var liste = serializerR.Deserialize<List<AnleggBygningsnrKoblingDto>>(response);


"[{ "Datagrunnlag ": "VAP ", "AnleggNr ":1706, "TilknyttedeBygninger ":[13135002]}]"

Norkart 32

3.26 Hent anleggsstatuser Henter alle typer anleggsstatuser. Det er to typer som er faste.

Id=0, I bruk

Id=1, Blendet.

Utover dette kan kommunen definere egne statuser der de har behov for det.

3.26.1 Datamodell, AnleggStatusDto



3.26.2 Metodekall

var response = client.DownloadString(url + " Anleggstatus/");

var liste = serializerR.Deserialize<List< AnleggStatusDto >>(response);


Norkart 33

"[{"Datagrunnlag":"Årim","Id":0,"Tekst":"I bruk"},{"Datagrunnlag":"Årim","Id":1,"Tekst":"Blendet"},{"Datagrunnlag":"Årim","Id":2,"Tekst":"Planlagt"},{"Datagrunnlag":"Årim","Id":3,"Tekst":"Fritak"}]"

slam api 2015 - norkart · 2018. 9. 11. · title: microsoft word - slam api 2015.docx author:...

Documents