...
Oppslag v.h.a. objektnøkkel: /<tjeneste>/<key> - eksempel eiendom:
https://beta-api.ambita.com/realty/v1/cadastres/12433006-558189-24488-0-20Opplag v.h.a. nøkler for andre objekter: /<key-eier>/<key>/<tjeneste> - eksempel for å hente adresse med eiendom-nøkke: cadastres/1243-55-244nøkkel:
https://beta-api.ambita.com/realty/v1/cadastres/3006-8189-88-0-20/addresses/
Lenker: For å forenkle videre søk fra en tjeneste til neste er det lagt til lenker i tjenestene. Lenker er lagt inn for det mest brukte kallsekvensene som benyttes. For eksempel kan en for en eiendom benytte lenker for å finne eiere, adresser, boliger og bygninger til denne eiendommen Lenker fra eiendom til eiere
Eksemplel lenke fra eiendom til eiere:
Code Block | ||
---|---|---|
| ||
links: { self: { rel: “Cadastre”, href: “https://beta-api.ambita.com/realty/v1/cadastres/12433006-558189-24488-0-2”0” }, owners: { rel: “Person”, href: “https://beta-api.ambita.com/realty/v1/cadastres/12433006-558189-24488-0-20/owners/” } } |
Kvalifisering lenker:
Skille mellom søk og opplag. Tjenester for søk og opplag har samme navn, men det framgår av lenke om det er søk eller oppslag:
Søk eiendom: search/cadastres
Opplag eiendom: cadastres
Tjenester med de samme data for eiendommer og borettsandeler som eierforhold og omsetninger, men , men der det framgår av om det er eiendom eller borettsandeborettsandel:
Eierskap eiendom: cadastre/ownerships
Eierskap borettsandel: share/ownerships
Kategorier: Tjenestene er inndelt i fem kategorier:
Oppslag ved hjelp av objektet unik objektets unike ident, returnerer et element. Eksempel opplag adresse v.h.a. offisiell ident for adresse:
https://beta-api.ambita.com/realty/v1/addresses/1053006-159502680-65Opplag ved hjelp av unike identer for relaterte objekter returnerer en liste. Eksempler, matrikkel (eiendommens unike key) mot adresse, bygning, eiere, boliger / bruksenheter, teiger, omsetninger: /cadastres/addresses/ /cadastres/buildings/ /cadastres/owners/ /cadastres/units/ /cadastres/plots/ /cadastres/conveyances/plots/ /cadastres/conveyances/
https://beta-api.ambita.com/realty/v1/cadastres/3006-8189-88-0-0/addresses/Oppslagsressurser ved hjelp av ident for andre relaterte objekter returnerer liste over elementer. Eksempel opplag på en eiendom med id til en adresse:
https://beta-api.ambita.com/realty/v1/cadastres/?addressId=27347Query søk returnerer liste over elementer. Eksempel søk på en eiendom med deler av den offisielle identen (matrikkelen) til en eiendom:
https://beta-api.ambita.com/realty/v1/search/cadastres/?query=12014601+5+1Geografisk søk returnerer liste over elementer. Eksempel søk på eiendom innen et rektangel:
https://beta-api.ambita.com/realty/v1/pocs/?eastingMin=-59448&northingMin=6779504&eastingMax=-57557&northingMax=6782860Støttetjenester returnerer data som er spesifikke for den enkelte tjeneste. Eksempel dictionary med oversikt over felter i EDR Realty RestAPI oversatt fra engelsk til norsk:
https://beta-api.ambita.com/realty/v1/dictionary/?languageFrom=En
...
Query: Tegn for tegn søk (som for eksempel ønsket antall tegn i et gatenavn for å få returnert alle gater som starter med den oppgitte tegnstrengen. Krav om at minimum 3 tegn oppgis. Søk foretas v.h.a. elastic seach engine for å ivareta ulike skrivemåter, ulik rekkefølge på felter, m.v.
Oppslag: Oppslag med relaterte identer (som for eksempel oppslag med adresse for å finne en eiendom der en ikke kjenner eiendommens matrikkel). Ved opplag v.h.a. relaterte identer returneres lister med ingen, en eller flere forekomster.
...
Person:
Søk (/realty/v1/search/persons/):
Navn, person / organisasjon
Oppslag (/realty/v1/persons/):
Fødselsnr / organisasjonsnr / anonymPersonID
Matrikkel (offisiell id eiendom)
Organisasjonsnr og andelsnr, borettslag
Gate/vei:
Søk (/realty/v1/search/streetstreets/):
Navn, gate / vei
Oppslag (street/realty/v1/streets/):
Kommunenr og gatenr
Krets (eksempel: postnr og bydel)
Adresse:
Søk (/realty/v1/search/addresses/):
Navn gate / vei, husnr og eventuelt bokstav, eventuelt kommunenavn / poststedsnavn
Oppslag (/realty/v1/addresses/):
AdresseID (kommune, gatekode, husnr, eventuelt bokstav)
Krets (eksempel postnr og bydel)
Matrikkel (offisiell id eiendom)
Organisasjonsnr og andelsnr, borettslag
Bygningsnr
BruksenhetsID/BoligID
Eiendom:
Søk (/realty/v1/search/cadastres/):
Matrikkel (offisiell id eiendom)
Oppslag (/realty/v1/cadastres/):
AdresseID (kommune, gatekode, husnr, eventuelt bokstav)
Bygningsnr
AnonymPersonID
Posisjon (koordinat)
Borettslag:
Søk (/search/housingcooperatives):
Navn, borettslag
Oppslag (/housingcooperatives):
Organisasjonsnr, borettslag
Borettsandel:
Søk (/search/shares):
Navn, borettslag og andelsnr
Oppslag (shares):
Organisasjonsnr, borettslag og andelsnr
AdresseID (kommune, gatekode, husnr, eventuelt bokstav)
AnonymPersonID
Posisjon (koordinat)
Bygning:
Søk:
Ingen
Oppslag (/search/buildings):
Bygningsnr
Matrikkel (offisiell id eiendom)
AdresseID (kommune, gatekode, husnr, eventuelt bokstav)
BruksenhetsID/BoligID
Bruksenhet/Bolig:
Søk:
Ingen
Oppslag (/separatelyoccupiedunits):
BruksenhetsID/BoligID
Matrikkel (offisiell id eiendom)
AdresseID (kommune, gatekode, husnr, eventuelt bokstav)
Bygningsnr
Sted:
Søk (/search/places):
Stedsnavn, eventuelt kommune
Oppslag:
Ingen
...