export interface paths { "/systemping": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get: operations["status"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/objectscores/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/codefields/{codefieldKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get codefield * @description Returns codefield */ get: operations["getCodeField"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/codefields/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get all codefields * @description Returns all codefields */ get: operations["listCodeFields"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/creationofrights/{rightKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get creation of right */ get: operations["getRight"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{documentKey}/creationofrights/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get creation of rights by document key */ get: operations["listRightsByDocument"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/buildings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get buildings for a cadastre */ get: operations["listBuildingsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/buildings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get buildings for an address */ get: operations["listBuildingsByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/singleheritages/{singleHeritageKey}/buildings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get buildings for a single heritage */ get: operations["listBuildingsBySingleHeritage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{unitKey}/building/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the building for a separately occupied unit */ get: operations["getBuildingByUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/culturalheritages/{culturalHeritageKey}/buildings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get buildings for a cultural heritage */ get: operations["listBuildingsByCulturalHeritage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/building/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the building for a building change */ get: operations["getBuildingByBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/building/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the building for a share */ get: operations["getBuildingByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get building * @description Returns building */ get: operations["getBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get buildings * @description Returns buildings */ get: operations["listBuildings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/persons/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get persons * @description Search for persons. Requires at least one letter in query string to do search. */ get: operations["searchForPersonsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/ownershipsowningthisshare/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get ownerships by share */ get: operations["listShareOwnershipsByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/shareownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get ownerships by person */ get: operations["listShareOwnershipsByPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/ownerships/{ownershipKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ownership * @description Returns ownership */ get: operations["getShareOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/user": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get logged in user * @description Returns logged in user */ get: operations["getLoggedInUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/objectscore/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get object score for a cadastre */ get: operations["getCadastreObjectScore"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/historicaltitlepdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get historical title for Share PDF by share */ get: operations["getHistoricalTitleSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/historicalmortgagepdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get historical mortgage for Share PDF by share */ get: operations["getHistoricalMortgageSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/historicalshareinfopdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get historical share info PDF by share */ get: operations["getHistoricalShareInfoPDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/compound/personsownings/{personKeys}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get persons ownings * @description Returns persons ownings for supplied person keys. */ get: operations["getPersonsOwnings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/compound/customerscorecoowner/{personKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get customerscore coowner * @description Returns customerscore coowner */ get: operations["getCustomerScoreCoOwner"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/housingvalue/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get housing value for a share */ get: operations["getShareHousingValue"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/organizations/{organizationKey}/accountant/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get accountant organization for a Housing Cooperative/ Corporation */ get: operations["getAccountantOrganizationForCooperative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/accountant/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get accountant organization for a cadastre */ get: operations["getAccountantOrganizationForCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/accountant/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get accountant organization for a cooperative share */ get: operations["getAccountantOrganizationForShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/simpleorganizations/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get organizations as simple list * @description Returns organizations by industry code as simple list */ get: operations["simplelistOrganizations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/organizations/{organizationKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get organization * @description Returns organization */ get: operations["getOrganization"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/organizations/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get organizations * @description Returns organizations by industry code or parent */ get: operations["listOrganizations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/organizations/{organizationKey}/root/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get root level organization * @description Returns root in conglomerate */ get: operations["getRootOrganization"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/ownerships/{ownershipKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/ownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/sectionings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get sectionings for a cadastre */ get: operations["listSectioningsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/sectionings/{sectioningKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get sectioning * @description Returns sectioning */ get: operations["getSectioning"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/sectionings/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get sectionings * @description Returns sectionings */ get: operations["listSectionings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get addresses * @description Search for addresses */ get: operations["searchForAddressesV"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get addresses related to a cadastre */ get: operations["listAddressesByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get addresses related to a building */ get: operations["listAddressesByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get addresses related to a building change */ get: operations["listAddressesByBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/streets/{streetKey}/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get addresses in a street */ get: operations["listAddressesByStreet"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/districts/{districtKey}/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get addresses in a district */ get: operations["listAddressesByDistrict"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{unitKey}/address/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the address for a separately occupied unit * @description The address for the unit is not always present */ get: operations["getAddressByUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/positions/{x},{y},{inputDatum}/nearbyaddresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get addresses near position * @description The list is sorted by distance */ get: operations["listAddressesNearPosition"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/presentationaddress/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the presentation address for a cadastre * @description The presentation address for the cadastre is not always present */ get: operations["getPresentationAddressByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/address/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the address for a housing cooperative share * @description The address for the share is not always present */ get: operations["getAddressByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a unique address * @description Returns address */ get: operations["getAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get addresses by other keys * @description Returns addresses */ get: operations["listAddresses"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/lienscalculation/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get liens calculation for a share */ get: operations["getShareLiensCalculation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/creationofrights/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get creation of rights related to a share */ get: operations["getRightsForShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/conveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get conveyances for a cadastre */ get: operations["listCadastreConveyancesByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pocs/{pocKey}/cadastreconveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get conveyances for a poc */ get: operations["listCadastreConveyancesByPoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/conveyances/{conveyanceKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get conveyance * @description Returns conveyance */ get: operations["getCadastreConveyance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get shares * @description Search for shares */ get: operations["searchForShares"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/conveyances/{conveyanceKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/conveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/validation/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Validate the cadastre */ get: operations["validateCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/positions/{x},{y},{datum}/plot/polygon/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get plot-polygons by position * @description Returns polygons as geojson */ get: operations["getPlotPolygonsByPosition"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/polygon/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get polygons for cadastre * @description Returns polygons as geojson */ get: operations["getPolygonsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/geojson/pocs/{pocId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get POC GeoJSON * @description Returns POC GeoJSON */ get: operations["getPocGeoJSON"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/geojson/pocs/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get POCs GeoJSON * @description Returns POCs GeoJSON */ get: operations["listPocsGeoJSON"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/ownerships/{ownershipKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/ownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/offices/{cadastreDocumentKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get document ident based on key * @description Returns document ident based on key */ get: operations["getCadastreOffice"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/affairs/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get affairs for a cadastre */ get: operations["listAffairsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/affairs/{affairKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get affair * @description Returns affair */ get: operations["getAffair"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/affairs/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get affairs * @description Returns affairs */ get: operations["listAffairs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/compound/shareextended/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get extended information about a share */ get: operations["getShareExtended"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/lienscalculation/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get liens calculation for cadastre */ get: operations["getCadastreLiensCalculation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/housingvalues/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/homeequity/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get home equity by person */ get: operations["getHomeEquityByPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/culturalheritages/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cultural heritages related to a building */ get: operations["listCulturalHeritagesByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/culturalheritages/{culturalHeritageKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cultural heritage * @description Returns cultural heritage */ get: operations["getCulturalHeritage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/culturalheritages/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cultural heritages * @description Returns cultural heritages */ get: operations["listCulturalHeritages"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/municipalities/{municipalityKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get municipality * @description Returns municipality */ get: operations["getMunicipality"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/municipalities/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get municipalities * @description Returns municipalities */ get: operations["listMunicipalities"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/objectscore/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get object score for a share */ get: operations["getShareObjectScore"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/coopinternals/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get coop internals for a cadastre */ get: operations["listCoopInternalsForCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/coopinternals/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get coop internals for a share */ get: operations["listCoopInternalsForShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coopinternals/{coopInternalKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get coop internal * @description Returns coop internal - Internal index-data for housing cooperative holders */ get: operations["getCoopInternal"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coopinternals/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get coop internals * @description Returns coop internals - Internal index-data for housing cooperative holders */ get: operations["listCoopInternals"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/creationofrights/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get creation of rights related to a cadastre */ get: operations["getCadastreRight"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/plots/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get plots for a cadastre */ get: operations["listPlotsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/plots/{plotKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get plot * @description Returns plot */ get: operations["getPlot"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/plots/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get plot * @description Returns plot */ get: operations["listPlots"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/landregistry/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Generates a Land Registry report for the cadastre */ get: operations["getCadastreLandRegistry"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/accountantdata/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Accountant Housing Data by cadastre * @description Returns an Accountant Housing Data for specified cadastre */ get: operations["getAccountantHousingDataByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/accountantdata/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Accountant Housing Data by share * @description Returns an Accountant Housing Data for specified share */ get: operations["getAccountantHousingDataByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/accountants/housingdata/{housingKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Accountant Housing Data * @description Returns an Accountant Housing Data for specified key */ get: operations["getAccountantHousingDataOfficialKey"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/accountants/housingdata/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Find Accountant Housing Data * @description Returns a list of Accountant Housing Data for specified parameters */ get: operations["getAccountantHousingData"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/soilcontaminations/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get soil contamination items for a cadastre */ get: operations["listSoilContaminationsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/soilcontaminations/{soilContaminationKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get soil contamination * @description Returns soil contamination */ get: operations["getSoilcontamination"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/soilcontaminations/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get soil contamination items * @description Returns soil contamination items */ get: operations["listSoilContaminations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/surroundinghousingvalues/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get surrounding housing values for a cadastre * @description Returns housing values */ get: operations["listSurroundingCadastreHousingValues"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/housingvalue/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get housing value for a cadastre */ get: operations["getCadastreHousingValue"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/streets/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get streets for an address */ get: operations["listStreetsByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/districts/{districtKey}/streets/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get streets for a district */ get: operations["listStreetsByDistrict"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/streets/{streetKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get street * @description Returns street */ get: operations["getStreet"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/streets/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get streets * @description Returns streets */ get: operations["listStreets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/ownershipsowningthiscadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get ownerships by cadastre */ get: operations["listOwnershipsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/ownershipsownedbythiscadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get ownerships owned by this cadastre */ get: operations["listOwnershipsOwnedByThisCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/cadastreownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get ownerships by person */ get: operations["listOwnershipsByPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/ownerships/{ownershipKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ownership * @description Returns ownership */ get: operations["getCadastreOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/poc/{pocKey}/shareconveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get conveyances for a poc */ get: operations["listShareConveyancesByPoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/conveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get conveyances for a share */ get: operations["listShareConveyancesByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/conveyances/{conveyanceKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get conveyance * @description Returns conveyance */ get: operations["getShareConveyance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/operatingunit/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get operating unit by any unit * @description Find operating unit by any unit */ get: operations["getOperatingUnitByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/operatingunits/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get operating unit * @description Find operating unit */ get: operations["getOperatingUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/documentcopyexistence/{shareDocumentKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get document copy existences * @description Returns document copy existences */ get: operations["getShareDocumentCopyExistence"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/singleheritages/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get single heritages related to a cadastre */ get: operations["listSingleHeritagesByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/singleheritages/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get single heritages related to a building */ get: operations["listSingleHeritagesByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/singleheritages/{singleHeritageKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single heritage * @description Returns single heritage */ get: operations["getSingleHeritage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/singleheritages/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single heritages * @description Returns single heritages */ get: operations["listSingleHeritages"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/unregisteredownershipsowningthiscadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get unregistered ownerships by cadastre */ get: operations["listUnregisteredOwnershipsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/unregisteredownershipsownedbythiscadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get unregistered ownerships owned by this cadastre */ get: operations["listUnregisteredOwnershipsOwnedByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/unregisteredcadastreownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get unregistered ownerships by person */ get: operations["listUnregisteredOwnershipsByPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/unregisteredownerships/{unregisteredOwnershipKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get unregistered ownership * @description Returns unregistered ownership */ get: operations["getUnregisteredOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/unregisteredownerships/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get unregistered ownerships * @description Returns unregistered ownerships */ get: operations["listUnregisteredOwnerships"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/cadastre/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Cadastre PDF by cadastre */ get: operations["getCadastrePDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/cadastrewithprivileges/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Cadastre PDF by cadastre with privileges */ get: operations["getCadastrePDFByCadastreWithPrivileges"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/cadastrewithleaseholdowners/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Cadastre PDF by cadastre with leasehold owners */ get: operations["getCadastrePDFByCadastreWithLeaseholdOwners"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/share/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Share PDF by share */ get: operations["getSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cadastres * @description Search for cadastres */ get: operations["searchForCadastres"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/places/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get places * @description Search for places */ get: operations["searchForPlacesV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/dictionary/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get dictionary * @description Returns dictionary */ get: operations["dictionary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/documentcopyexistence/{cadastreDocumentKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get document copy existence * @description Returns document copy existence for property */ get: operations["getCadastreDocumentCopyExistence"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/property/lienscalculations/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v2/shares/{shareKey}/objectscore/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get object score for a share */ get: operations["getShareObjectScoreV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/floors/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get floors related to a building */ get: operations["listFloorsByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/floors/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get floors related to a buildingchange */ get: operations["listFloorsByBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/floors/{floorKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get floor * @description Returns floor */ get: operations["getFloor"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/floors/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get floors * @description Returns floors */ get: operations["listFloors"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/housingcooperatives/{housingCooperativeKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get housing cooperative * @description Search for housing cooperative */ get: operations["getHousingCooperative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/creationofrights/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get creation of rights for a person */ get: operations["listRightsForPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/separatelyoccupiedunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get separately occupied units for a cadastre */ get: operations["listUnitsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/separatelyoccupiedunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get separately occupied units for a building */ get: operations["listUnitsByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/separatelyoccupiedunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the building for a building change */ get: operations["listUnitsByBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/separatelyoccupiedunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get separately occupied units for an address */ get: operations["listUnitsByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/separatelyoccupiedunit/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get separately occupied unit for a share */ get: operations["getUnitByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{separatelyOccupiedUnitKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get separately occupied unit * @description Returns separately occupied unit */ get: operations["getUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get separately occupied units * @description Returns separately occupied units */ get: operations["listUnits"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pocs/{pocId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get POC * @description Returns POC */ get: operations["getPoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pocs/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get POCs * @description Returns POCs */ get: operations["listPocs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/creationofrights/{rightKey}/currentmortgagees/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get current mortgagees of a right */ get: operations["getCurrentMortgagees"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/residents/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the residents of an address */ get: operations["listResidentsOfAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/owners/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owners of a cadastre */ get: operations["listOwnersOfCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/owners/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owners of a share */ get: operations["listOwnersOfShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/conveyances/{conveyanceKey}/buyers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the buyers participating in a conveyance of cadastres */ get: operations["listBuyersOfConveyanceOfCadastres"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/conveyances/{conveyanceKey}/sellers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the sellers participating in a conveyance of cadastres */ get: operations["listSellersOfConveyanceOfCadastres"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/conveyances/{conveyanceKey}/buyers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the buyers participating in a conveyance of shares */ get: operations["listBuyersOfConveyanceOfShares"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/conveyances/{conveyanceKey}/sellers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the sellers participating in a conveyance of shares */ get: operations["listSellersOfConveyanceOfShares"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/developers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get persons with a role as developer of a building */ get: operations["listDevelopersOfBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/contacts/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get persons with the role as contact person of a building */ get: operations["listContactsOfBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/developers/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get persons with a role as developer of a building change */ get: operations["listDevelopersOfBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/contacts/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get persons with the role as contact person of a building change */ get: operations["listContactsOfBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/ownerships/{ownershipKey}/owningperson/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owning person for a cadastre ownership */ get: operations["getOwnerOfOwnershipOnCadastres"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/ownerships/{ownershipKey}/owningperson/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owning person for a share ownership */ get: operations["getOwnerOfOwnershipOnShares"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get person * @description Get person */ get: operations["getPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get persons * @description Returns persons */ get: operations["listPersons"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/realtyestateunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get realty estate units for a cadastre */ get: operations["listRealtyEstateUnitsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/realtyestateunits/{realtyEstateUnitKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get realty estate unit * @description Returns realty estate unit */ get: operations["getRealtyEstateUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/realtyestateunits/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get realty estate unit * @description Returns realty estate unit */ get: operations["getRealtyEstateUnitByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/landregistry/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Generates a Land Registry report for the share */ get: operations["getLandRegistryForShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/customerscores/{personKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/customerscore/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get customerscore by person */ get: operations["getCustomerScore"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/homeequities/{personKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/simplemappdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Simple Technical PDF by cadastre */ get: operations["getSimpleMapPDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/mappdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Technical PDF by cadastre */ get: operations["getMapPDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/streets/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get streets * @description Search for streets */ get: operations["searchForStreetsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/housingvalues/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares for a cadastre */ get: operations["listSharesByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pocs/{pocKey}/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares for a pocId */ get: operations["listSharesByPoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares for a address */ get: operations["listSharesByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/conveyances/{conveyanceKey}/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares for a conveyance */ get: operations["listSharesByConveyance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/ownedshares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares owned by a person */ get: operations["listShareByOwningPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{unitKey}/share/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the share for a separately occupied unit */ get: operations["getShareByUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/housingcooperatives/{cooperativeKey}/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get shares for a cooperative */ get: operations["listSharesByCooperative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/ownerships/{ownershipKey}/ownedshare/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owned share for an ownership */ get: operations["getShareByOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/positions/{x},{y},{inputDatum}/nearbyshares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get shares near position * @description The list is sorted by distance */ get: operations["listSharesNearbyPosition"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get share * @description Returns share */ get: operations["getShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get shares * @description Returns shares */ get: operations["listShares"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/districts/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get districts related to a address */ get: operations["listDistrictsByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/streets/{streetKey}/districts/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get districts related to a street */ get: operations["listDistrictsByStreet"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/districts/{districtKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get district * @description Returns district */ get: operations["getDistrict"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/districts/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get districts * @description Returns districts */ get: operations["listDistricts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/compound/cadastreextended/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get extended information about a cadastre */ get: operations["getCadastreExtended"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/historicalcadastre/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Historical Cadastre PDF by cadastre */ get: operations["getHistoricalCadastrePDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/historicalshare/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Historical Share PDF by share */ get: operations["getHistoricalSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/oldcadastre/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Old Cadastre PDF ByCadastre */ get: operations["getOldCadastrePDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/search/housingcooperatives/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get housing cooperatives * @description Search for housing cooperatives */ get: operations["searchForHousingCooperatives"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/coordinates/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get coordinates for cadastre * @description Returns coordinates for a given cadastre */ get: operations["listCadastreCoordinates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/titlepdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get title for Share PDF by share */ get: operations["getTitleSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/mortgagepdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get mortgage for Share PDF by share */ get: operations["getMortgageSharePDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/shareinfopdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get share info PDF by share */ get: operations["getShareInfoPDFByShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/share/creationofrights/{shareRightKey}/pdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get CreationOfRight for share PDF by rightKey */ get: operations["getShareRightPDFByRight"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/creationofrights/{cadastreRightKey}/pdf/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get CreationOfRight for cadastre PDF by rightKey */ get: operations["getCadastreRightPDFByRight"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/conveyances/{conveyanceKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/conveyances/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/technical/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Technical PDF by cadastre */ get: operations["getTechnicalPDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pdfs/simpletechnical/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Simple Technical PDF by cadastre */ get: operations["getSimpleTechnicalPDFByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/pocs/{pocKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres with conveyance related to the location(address or plot) of the provided POC(Point of Conveyance) */ get: operations["listCadastresByPoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres related to a building */ get: operations["listCadastresByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres related to a building change */ get: operations["listCadastresByBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{addressKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres related to an address */ get: operations["listCadastresByAddress"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/streets/{streetKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres related to a street */ get: operations["listCadastresByStreet"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/conveyances/{conveyanceKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres that are part of the conveyance */ get: operations["listCadastresByConveyance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/persons/{personKey}/ownedcadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres that are part of the conveyance */ get: operations["listCadastresByOwningPerson"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/singleheritages/{singleHeritageKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres related to a single heritage */ get: operations["listCadastresBySingleHeritage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/maincadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get main cadastres for a section */ get: operations["listMainCadastresBySection"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/soilcontaminations/{soilContaminationKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for a soil contamination */ get: operations["listCadastresBySoilContamination"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/complaints/{complaintKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for a complaint */ get: operations["listCadastresByComplaint"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/sectionings/{sectioningKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for a sectioning */ get: operations["listCadastresBySectioning"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/plots/{plotKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for a plot */ get: operations["listCadastresByPlot"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/realtyestateunits/{realtyEstateUnitKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for a realty estate unit */ get: operations["listCadastresByRealtyEstateUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/affairs/{affairKey}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get cadastres for an affair */ get: operations["listCadastresByAffair"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{unitKey}/cadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the cadastre for a separately occupied unit */ get: operations["getCadastreByUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/shares/{shareKey}/landlot/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the land lot (cadastre) for a housing cooperative share */ get: operations["getCadastreByLandLotForShare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/ownerships/{ownershipKey}/ownedcadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owned cadastre for an ownership */ get: operations["getOwnedCadastreByOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastre/ownerships/{ownershipKey}/owningcadastre/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the owning cadastre for an ownership */ get: operations["getOwningCadastreByOwnership"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/positions/{x},{y},{inputDatum}/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cadastres by position * @description Returns cadastres at position */ get: operations["listCadastresByPosition"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/sections/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get all sections for any given cadastre */ get: operations["listCadastreSectionsForCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cadastre * @description Returns cadastre */ get: operations["getCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cadastres * @description Returns cadastres */ get: operations["listCadastres"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/lienscalculations/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cooperative/objectscores/{shareKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/buildingchanges/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get building changes for a cadastre */ get: operations["listBuildingChangesByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/changes/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get building changes for building */ get: operations["listBuildingChangesByBuilding"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/separatelyoccupiedunits/{unitKey}/buildingchange/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the building change for a separately occupied unit */ get: operations["getBuildingChangeByUnit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildings/{buildingKey}/changes/{version}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get building change * @description Returns building change */ get: operations["deprecatedGetBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/{buildingChangeKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get building change * @description Returns building change */ get: operations["getBuildingChange"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/buildingchanges/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get building changes * @description Returns building changes */ get: operations["listBuildingChanges"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/cadastres/{cadastreKey}/complaints/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get complaints for a cadastre */ get: operations["listComplaintsByCadastre"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/complaints/{complaintKey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get complaint * @description Returns complaint */ get: operations["getComplaint"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/complaints/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get complaints * @description Returns complaints */ get: operations["listComplaints"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/scopes/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get scope list * @description Returns scope list */ get: operations["scope"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { AddressFormatted: { /** @description Street / Cadastral number */ line1: string; /** @description Postal address */ line2: string; }; AddressIdent: { /** * Format: int32 * @description Cadastral-address: A municipality number, the geographically largest part of a cadastral. Street-address: The municipality the street is within. If a street crosses the municipality border it becomes a new street. */ municipalityNumber: number; /** * @description Is ident CadastralAddress or StreetAddress * @enum {string} */ identType: "CadastralAddressIdent" | "StreetAddressIdent"; }; AddressItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Administration: { administratorType?: components["schemas"]["Code"]; /** @description The administrators */ administrators?: components["schemas"]["Person"][]; }; ApiDate: { /** * Format: date * @description The date as yyyy-MM-dd */ timestamp: string; /** @description The date as dd/MM-yyyy */ ddmmyyyy: string; /** @description Datetime formatted following ISO-8601 with offset formatting rules */ isoDateTime: string; /** @description Date formatted following ISO-8601 - without timepart - yyyy-MM-dd */ isoDate: string; }; ApiDateTime: { /** * Format: date * @description The date as yyyy-MM-dd */ timestamp: string; /** @description The date as dd/MM-yyyy HH:mm */ ddmmyyyyHHmm: string; /** @description Datetime formatted following ISO-8601 with offset formatting rules */ isoDateTime: string; }; CadastralAddressIdent: { identType: "CadastralAddressIdent"; } & (Omit & { /** * Format: int32 * @description A cadastral unit represents the area of a farm. Filled out for Cadastral Addresses */ cadastralUnitNumber?: number; /** * Format: int32 * @description A unit represents a separate part of the farm area. Filled out for Cadastral Addresses */ unitNumber?: number; /** * Format: int32 * @description A leasehold is a contract for the lease of some land. Filled out for Cadastral Addresses */ leaseholdUnitNumber?: number; /** * Format: int32 * @description A subnumbering is a serial for separating cadastrals. Filled out for Cadastral Addresses */ subNumber?: number; }); CadastreConveyanceListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreIdent: { /** * Format: int32 * @description The municipality number */ municipalityNumber: number; /** * Format: int32 * @description The cadastral unit number */ cadastralUnitNumber: number; /** * Format: int32 * @description The unit number */ unitNumber: number; /** * Format: int32 * @description The leasehold unit number */ leaseholdUnitNumber: number; /** * Format: int32 * @description The section number */ sectionNumber: number; section: boolean; leasehold: boolean; }; CadastreLevelRelation: { cadastreLevel?: components["schemas"]["LevelCode"]; cadastreIdent: components["schemas"]["CadastreIdent"]; cadastreKey: string; municipality?: components["schemas"]["MunicipalityData"]; fraction?: components["schemas"]["Fraction"]; isActive: boolean; }; CadastreListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreOwnershipListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreScoreRight: { ident: components["schemas"]["CreationOfRightIdent"]; key: string; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; /** @description Indicates if the right is an enforcement */ isEnforcement?: boolean; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; dateRegistered?: components["schemas"]["ApiDate"]; deletedDate?: components["schemas"]["ApiDate"]; /** @description Text embedded on the document */ textLines?: string[]; documentType: components["schemas"]["Code"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; priorityType?: components["schemas"]["Code"]; timeDeleted?: components["schemas"]["ApiDateTime"]; /** @description The current amounts registered on the rights */ currentAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The original amounts registered on the rights */ originalAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The mortgagees */ mortgagees?: components["schemas"]["Person"][]; /** @description The plaintiffs */ plaintiffs?: components["schemas"]["Person"][]; /** @description The defendants */ defendants?: components["schemas"]["Person"][]; /** @description The legal representatives */ legalRepresentatives?: components["schemas"]["Person"][]; administration?: components["schemas"]["Administration"]; /** @description List of persons that have license */ personsWithLicense?: components["schemas"]["Person"][]; /** @description List of cadastres that have license */ cadastresWithLicense?: components["schemas"]["CadastreLevelRelation"][]; outstandingDebt?: components["schemas"]["OutstandingDebt"]; links?: components["schemas"]["ScoreRightLinks"]; }; Code: { /** @description The code */ code: string; /** @description The code description */ text?: string; /** @description true if the code is active, false if it is historical */ active?: boolean; links?: components["schemas"]["CodeLinks"]; }; CodeFieldItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CodeLinks: { codeField?: components["schemas"]["CodeFieldItemLink"]; }; CreationOfRightIdent: { /** * Format: int32 * @description The juridical office where this document belongs to */ office: number; /** * Format: int32 * @description The year this document was registered */ documentYear: number; /** * Format: int32 * @description The serial number of this document */ documentNumber: number; /** * Format: int32 * @description The creation of right number inside this document */ rightNumber: number; documentKey: string; }; CustomerScore: { ident: components["schemas"]["PersonIdent"]; /** @description The key for this resource */ key: string; /** @description The customers name */ customerName: string; /** @description Indicates if scoring for this person is possible */ isScorable: boolean; /** @description If not scorable, this string contains the reason */ reasonNotScorable?: string; overallRisk?: components["schemas"]["Code"]; /** * Format: int32 * @description The number of cadastres not mortgaged / containing no liens */ ownedCadastresWithoutPledge?: number; /** * Format: int32 * @description The number of shares not mortgaged / containing no liens */ ownedSharesWithoutPledge?: number; /** @description Collection of all possible high risks */ highRisks?: { [key: string]: components["schemas"]["Risk"]; }; /** @description Collection of all possible medium risks */ mediumRisks?: { [key: string]: components["schemas"]["Risk"]; }; /** @description Collection of all possible low risks */ lowRisks?: { [key: string]: components["schemas"]["Risk"]; }; mortgagesSummary?: components["schemas"]["CustomerScoreMortgagesSummary"]; links?: components["schemas"]["CustomerScoreLinks"]; }; CustomerScoreItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CustomerScoreItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CustomerScore"]; }; CustomerScoreLinks: { self: components["schemas"]["CustomerScoreItemLink"]; customer?: components["schemas"]["PersonItemLink"]; cadastreOwnerships?: components["schemas"]["CadastreOwnershipListLink"]; shareOwnerships?: components["schemas"]["ShareOwnershipListLink"]; homeEquity?: components["schemas"]["HomeEquityItemLink"]; }; CustomerScoreMortgagesSummary: { activeSummary: components["schemas"]["CustomerScoreMortgagesSummaryDetails"]; historicalSummary: components["schemas"]["CustomerScoreMortgagesSummaryDetails"]; }; CustomerScoreMortgagesSummaryDetails: { /** * Format: int64 * @description Sum of mortgages */ sumMortgage?: number; /** * Format: int32 * @description Number of mortgages */ numberOfMortgages?: number; /** * Format: int64 * @description Sum of mortgages on cadastres */ sumMortgageCadastre?: number; /** * Format: int32 * @description Number of mortgages on cadastres */ numberOfMortgagesOnCadastres?: number; /** * Format: int64 * @description Sum of mortgages on housing cooperative shares */ sumMortgageShare?: number; /** * Format: int32 * @description Number of mortgages on housing cooperative shares */ numberOfMortgagesOnShares?: number; /** * Format: int64 * @description Sum of outstanding mortgage */ sumOutstandingMortgage?: number; /** * Format: int64 * @description Sum of outstanding mortgage on cadastres */ sumOutstandingMortgageCadastre?: number; /** * Format: int64 * @description Sum of outstanding mortgage on shares */ sumOutstandingMortgageShare?: number; /** @description If has pledge securing bond */ hasPledgeSecuringBond?: boolean; /** @description If has active pledging statement */ hasActivePledgingStatement?: boolean; /** @description If has listed mortgage */ hasListedMortgage?: boolean; /** @description If mortgages have currency code <> 'NOK' */ hasMortgageWithForeignCurrency?: boolean; /** @description Mortgages on cadastres */ mortgagesOnCadastres?: { [key: string]: components["schemas"]["CadastreScoreRight"]; }; /** @description Mortgages on shares */ mortgagesOnShares?: { [key: string]: components["schemas"]["ShareScoreRight"]; }; }; Error: { /** * Format: int32 * @description A predefined error code number, uses HTTP error codes */ returnCode?: number; /** @description Describes the error situation in detail */ message?: string; }; Fraction: { /** * Format: int64 * @description The numerator of the fraction */ numerator?: number; /** * Format: int64 * @description The denominator of the fraction */ denominator?: number; }; GeoJSONCrs: { type?: string; properties?: components["schemas"]["GeoJSONProperties"]; }; GeoJSONFeature: { type: string; geometry?: components["schemas"]["Geometry"]; /** @description Bounding box */ bbox?: number[]; properties?: components["schemas"]["GeoJSONProperties"]; crs: components["schemas"]["GeoJSONCrs"]; }; GeoJSONObject: { /** @description Bounding box */ bbox?: number[]; properties?: components["schemas"]["GeoJSONProperties"]; }; GeoJSONProperties: { id?: string; name?: string; type?: string; href?: string; title?: string; sourceOfPosition?: string; realtyType?: components["schemas"]["Code"]; links?: components["schemas"]["POCLinks"]; }; Geometry: { /** @description Bounding box */ bbox?: number[]; properties?: components["schemas"]["GeoJSONProperties"]; type: string; }; HomeEquityItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Info: { /** * Format: int32 * @description A predefined info code */ realtyCode?: number; /** @description Describes the info in detail */ message?: string; /** @description A list of links to objects referenced in the Info message. It could be one or more cadastres */ links?: components["schemas"]["Link"][]; }; LevelCode: { /** @description The code */ code: string; /** @description The register code */ registerCode?: string; /** @description The code description */ text?: string; /** @description true if the code is active, false if it is historical */ active?: boolean; links?: components["schemas"]["CodeLinks"]; }; Link: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Location: { addressIdent?: components["schemas"]["AddressIdent"]; /** @description The street address key */ addressKey?: string; /** @description The street name */ street?: string; /** * Format: int32 * @description The house number on the street */ addressNumber?: number; /** @description The house letter */ letter?: string; /** @description An alternate name for the address */ alternativeAddress?: string; /** @description A short name for the address, not unique */ shortName?: string; sourceOfAddressName?: components["schemas"]["Code"]; /** * Format: int32 * @description The postal code */ postalCode?: number; /** @description The name of the district with this postal code */ postalPlace?: string; /** @description The apartment unit number */ dwellingNumber?: string; movedInDate?: components["schemas"]["ApiDate"]; formatted: components["schemas"]["AddressFormatted"]; municipality?: components["schemas"]["MunicipalityData"]; geojson?: components["schemas"]["GeoJSONObject"]; position?: components["schemas"]["GeoJSONFeature"]; }; Money: { currency: components["schemas"]["Code"]; /** * Format: int64 * @description The amount of currency */ amount: number; /** @description A text field with extra information */ text?: string; /** * Format: int64 * @description The amount converted to NOK. Present only if conversion is possible */ amountInNok?: number; }; MunicipalityData: { /** * Format: int32 * @description The municipality number */ municipalityNumber: number; /** @description The municipality name */ municipalityName: string; /** * Format: int32 * @description The region number */ regionNumber: number; /** @description The region name */ regionName: string; }; OrganizationItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; OutstandingDebt: { /** * Format: int64 * @description The amount of outstanding debt */ amount: number; updated?: components["schemas"]["ApiDateTime"]; }; PDFItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; POCItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; POCLinks: { self?: components["schemas"]["POCItemLink"]; conveyancesOfCadastre?: components["schemas"]["CadastreConveyanceListLink"]; cadastres?: components["schemas"]["CadastreListLink"]; conveyancesOfShare?: components["schemas"]["ShareConveyanceListLink"]; shares?: components["schemas"]["ShareListLink"]; }; Person: { ident: components["schemas"]["PersonIdent"]; /** @description An anonymous person id */ key: string; /** @description DEPRECATED. The date of birth for this person */ birthday?: string; dateOfBirth?: components["schemas"]["ApiDate"]; /** @description The organization number of this company */ organizationNumber?: string; personalNumberType?: components["schemas"]["Code"]; /** @description The sex of this person */ sex?: string; /** * Format: int32 * @description The current age of the person */ age?: number; /** @description If this person has Norwegian citizenship */ isNorwegianCitizen?: boolean; /** @description The official personal number of this person */ personalNumber?: string; /** @description The first name of this person */ givenName?: string; /** @description The middle name of this person */ middleName?: string; /** @description The last name of this person */ familyName?: string; /** @description The combined name of this person */ name?: string; /** @description The registered short name for a person */ shortName?: string; location?: components["schemas"]["Location"]; /** @description The address this organization has registered */ businessAddress?: string; /** @description The postal address of this person or organization */ postalAddress?: string; businessType?: components["schemas"]["Code"]; /** @description The industrial classification of this organization */ industrialClassification?: components["schemas"]["Code"][]; /** @description If this is an organisation that is a Covered Bonds Institution */ isCoveredBondsInstitution: boolean; /** @description If this is an organisation that is a Life Insurance Institution */ isLifeInsuranceInstitution: boolean; /** * Format: int32 * @description The number of main unit of this organization */ numberMainUnit?: number; deletionDate?: components["schemas"]["ApiDate"]; /** @description The foreign address of this person or organization */ foreignAddress?: string; /** @description The care of address of this person or organization */ coAddress?: string; dsfState?: components["schemas"]["Code"]; currentDataSource?: components["schemas"]["Code"]; /** @description If this person has property */ hasProperty?: boolean; summary?: components["schemas"]["Summary"]; links?: components["schemas"]["PersonLinks"]; }; PersonIdent: { /** * Format: int32 * @description An anonymous id representing a person or organization */ id: number; }; PersonItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; PersonLinks: { self?: components["schemas"]["PersonItemLink"]; ownedCadastres?: components["schemas"]["CadastreListLink"]; ownedShares?: components["schemas"]["ShareListLink"]; residence?: components["schemas"]["AddressItemLink"]; cadastreOwnerships?: components["schemas"]["CadastreOwnershipListLink"]; unregisteredCadastreOwnerships?: components["schemas"]["UnregisteredOwnershipListLink"]; shareOwnerships?: components["schemas"]["ShareOwnershipListLink"]; customerScore?: components["schemas"]["CustomerScoreItemLink"]; homeEquity?: components["schemas"]["HomeEquityItemLink"]; organization?: components["schemas"]["OrganizationItemLink"]; }; Risk: { /** @description Indicating whether this risk is present or not */ isPresent: boolean; /** @description A description of this risk */ description: string; /** @description A short description of this risk */ shortDescription: string; /** @description Type of object this risk is related to */ riskOnObject: string; /** @description If risk found in the Land Registry for fixed property, this list contains the creation of rights that is the reason for the risk. */ cadastreRights?: components["schemas"]["CadastreScoreRight"][]; /** @description If risk found in the Land Registry for cooperative shares, this list contains the creation of rights that is the reason for the risk. */ shareRights?: components["schemas"]["ShareScoreRight"][]; }; ScoreRightLinks: { creationOfRightPDF?: components["schemas"]["PDFItemLink"]; }; ShareConveyanceListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareCreationOfRightIdent: { /** * Format: int32 * @description The office this document was registered in */ office?: number; /** * Format: int32 * @description The year this document was registered */ documentYear: number; /** * Format: int32 * @description The serial number of this document */ documentNumber: number; /** * Format: int32 * @description The creation of right number inside this document */ rightNumber: number; }; ShareIdent: { /** * Format: int32 * @description The organization that owns the cooperative */ organizationNumber: number; /** * Format: int32 * @description The unique share number in a cooperative */ shareNumber: number; }; ShareListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareOwnershipListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareRelation: { shareIdent?: components["schemas"]["ShareIdent"]; shareKey?: string; housingCooperativeName?: string; isActive?: boolean; }; ShareScoreRight: { ident: components["schemas"]["ShareCreationOfRightIdent"]; key: string; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; /** @description Indicates if the right is an enforcement */ isEnforcement?: boolean; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; dateRegistered?: components["schemas"]["ApiDate"]; deletedDate?: components["schemas"]["ApiDate"]; /** @description Text embedded on the document */ textLines?: string[]; documentType: components["schemas"]["Code"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; priorityType?: components["schemas"]["Code"]; /** @description The current amounts registered on the rights */ currentAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The original amounts registered on the rights */ originalAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The mortgagees */ mortgagees?: components["schemas"]["Person"][]; /** @description The plaintiffs */ plaintiffs?: components["schemas"]["Person"][]; /** @description The defendants */ defendants?: components["schemas"]["Person"][]; /** @description The legal representatives */ legalRepresentatives?: components["schemas"]["Person"][]; /** @description The document holder */ documentHolder?: components["schemas"]["Person"][]; administration?: components["schemas"]["Administration"]; /** @description List of persons that have license */ personsWithLicense?: components["schemas"]["Person"][]; /** @description List of shares that have license */ sharesWithLicense?: components["schemas"]["ShareRelation"][]; outstandingDebt?: components["schemas"]["OutstandingDebt"]; links?: components["schemas"]["ShareScoreRightLinks"]; }; ShareScoreRightLinks: { creationOfRightPDF?: components["schemas"]["PDFItemLink"]; }; StreetAddressIdent: { identType: "StreetAddressIdent"; } & (Omit & { /** * Format: int32 * @description The street number. Filled out for Street Addresses */ streetNumber?: number; /** * Format: int32 * @description The address number within a street. Filled out for Street Addresses */ addressNumber?: number; /** @description The address letter for an address number. Filled out for Street Addresses */ letter?: string; }); Summary: { /** * Format: int32 * @description Contains count of cadastre ownerships */ numberOfCadastreOwnerships?: number; /** * Format: int32 * @description Contains count of share ownerships */ numberOfShareOwnerships?: number; /** * Format: int32 * @description Contains count of unregistered ownerships */ numberOfUnregisteredOwnerships?: number; /** * Format: int32 * @description Contains count of lease agreements */ numberOfLeaseAgreements?: number; }; UnregisteredOwnershipListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CodeField: { /** @description The codefield type */ key: string; /** @description A description of the codefield */ description?: string; /** @description A list containing the various codes that may occur in the codefield */ codes: components["schemas"]["Code"][]; links?: components["schemas"]["CodeLinks"]; }; CodeFieldItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CodeField"]; }; CodeFieldListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CodeField"][]; pagination?: components["schemas"]["Pagination"]; }; Pagination: { /** @description The previous page */ previous?: string; /** @description The next page */ next?: string; }; ApiTime: { hhmm: string; }; Appeal: { appealType?: components["schemas"]["Code"]; decisionDate?: components["schemas"]["ApiDate"]; appealDate?: components["schemas"]["ApiDate"]; denialDate?: components["schemas"]["ApiDate"]; }; AppliesTo: { /** @description List of entire cadastres/cadastreLevel this Creation of right applies to */ cadastres?: components["schemas"]["CadastreLevelRelation"][]; /** @description List of cadastre ownerships this Creation of right applies to */ cadastreOwnerships?: components["schemas"]["CadastreOwnershipRelation"][]; /** @description List of entire share/shareLevel this Creation of right applies to */ shares?: components["schemas"]["ShareLevelRelation"][]; /** @description List of share ownerships this Creation of right applies to */ shareOwnerships?: components["schemas"]["ShareOwnershipRelation"][]; /** @description List of person this Creation of right applies to */ persons?: components["schemas"]["PersonRelation"][]; /** @description List of other Creation of rights this Creation of right applies to */ creationOfRights?: components["schemas"]["CreationOfRight"][]; /** * Format: int32 * @description Number of other Creation of rights this Creation of right applies to */ numberOfCreationOfRights?: number; /** * Format: int32 * @description Number of realties(cadastres or shares) this Creation of right applies to */ numberOfRealties?: number; }; CadastreConveyanceItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreOwnership: { ident: components["schemas"]["CadastreOwnershipIdent"]; municipality?: components["schemas"]["MunicipalityData"]; key: string; /** @description Whether this ownership is registered in the Land Registry */ registered?: boolean; ownedCadastreIdent?: components["schemas"]["CadastreIdent"]; /** @description Owned cadastre key */ ownedCadastreKey?: string; cadastreLevel: components["schemas"]["LevelCode"]; /** @description Specifies if this ownership is on the maximum ownership level of the cadastre */ isMaxCadastreLevel: boolean; fraction?: components["schemas"]["Fraction"]; useOfCadastre?: components["schemas"]["Code"]; dwellingType?: components["schemas"]["Code"]; ownerType?: components["schemas"]["Code"]; owningPerson?: components["schemas"]["Person"]; owningCadastreIdent?: components["schemas"]["CadastreIdent"]; /** * Format: int32 * @description Number of owners on the level specified by cadastreLevel */ numberOfOwnersOnLevel?: number; /** @description Whether the owningPerson lives on this cadastre */ isResidence?: boolean; /** @description Specifies if this ownership active */ isActive: boolean; /** @description Specifies if the owned cadastre is active */ isOwnedObjectActive: boolean; bought?: components["schemas"]["OwnershipConveyance"]; sold?: components["schemas"]["OwnershipConveyance"]; links?: components["schemas"]["CadastreOwnershipLinks"]; }; CadastreOwnershipIdent: { cadastreIdent: components["schemas"]["CadastreIdent"]; /** * Format: int32 * @description A serial for all owners of the same cadastre */ ownershipNumber: number; /** * Format: int32 * @description A number that specifies what part of the cadastre the ownership is connected to */ cadastreLevel?: number; }; CadastreOwnershipItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreOwnershipLinks: { self?: components["schemas"]["CadastreOwnershipItemLink"]; ownedCadastre?: components["schemas"]["CadastreItemLink"]; owningPerson?: components["schemas"]["PersonItemLink"]; owningCadastre?: components["schemas"]["CadastreItemLink"]; conveyance?: components["schemas"]["CadastreConveyanceItemLink"]; boughtRight?: components["schemas"]["CreationOfRightItemLink"]; soldRight?: components["schemas"]["CreationOfRightItemLink"]; }; CadastreOwnershipRelation: { ownership: components["schemas"]["CadastreOwnership"]; /** @description Indicates if this connection is active. If not its historical */ isActive: boolean; creationOfRight?: components["schemas"]["CreationOfRight"]; }; CreationOfRight: { ident: components["schemas"]["CreationOfRightIdent"]; key: string; /** @description The document key (office-documentYear-documentNumber) */ documentKey: string; presentation: components["schemas"]["Presentation"]; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; rightType: components["schemas"]["Code"]; documentType: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; dateRegistered?: components["schemas"]["ApiDate"]; timeRegistered?: components["schemas"]["ApiDateTime"]; details?: components["schemas"]["RightDetails"]; formatted?: components["schemas"]["Formatted"]; relatedRights?: components["schemas"]["RelatedRights"]; /** @description Whether or not a copy of this document can be ordered */ documentCopyExists?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description Explanation for why a document copy does not exist */ documentCopyReasonNotExists?: string; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; priorityType?: components["schemas"]["Code"]; links?: components["schemas"]["CreationOfRightLinks"]; }; CreationOfRightItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CreationOfRightItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CreationOfRight"]; }; CreationOfRightLinks: { self: components["schemas"]["CreationOfRightItemLink"]; selfHtml: components["schemas"]["InternalHtmlLinkCreationOfRight"]; }; Downpayment: { /** @description Amounts of downpayment */ amounts?: { [key: string]: components["schemas"]["Money"]; }; }; EncumbranceTransfer: { /** @description List of transfers relevant to requested object */ transfers?: components["schemas"]["TransferredEncumbrance"][]; }; Enforcement: { /** @description The original amount on the enforcement */ originalAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The plaintiffs in the legal proceeding */ plaintiffs?: components["schemas"]["Person"][]; /** @description The legal representatives in the proceeding */ legalRepresentatives?: components["schemas"]["Person"][]; /** @description The defendants in the legal proceeding */ defendants?: components["schemas"]["Person"][]; listedPledge?: components["schemas"]["ListedPledge"]; enforcementHeldDate: components["schemas"]["ApiDate"]; enforcementHeldDateTime?: components["schemas"]["ApiDateTime"]; enforcementHeldTime?: components["schemas"]["ApiTime"]; /** @description DEPRECATED. List of encumbrances for this enforcement */ encumbrances?: components["schemas"]["CadastreOwnershipRelation"][]; /** * Format: int32 * @description DEPRECATED */ numberOfCadastres?: number; }; Exchange: { /** @description Creation of rights invoked exchanged with */ invokedExchangeWith?: components["schemas"]["CreationOfRight"][]; invokedPriorityFrom?: components["schemas"]["ApiDate"]; }; Formatted: { /** @description List of formatted rights */ formattedRights?: components["schemas"]["FormattedRight"][]; }; FormattedRight: { /** @description The key of this right */ rightKey: string; /** @description Text lines for presenting the key-data for this right */ keyLines: components["schemas"]["TextLine"][]; headingLine: components["schemas"]["TextLine"]; /** @description Text lines for presenting the content of this right */ textLines: components["schemas"]["TextLine"][]; /** * Format: int32 * @description This value is used to present indenting. If this right is a remark to another right, this value shows how many levels it is up to the main right. 0 is the lowest level. */ nestingLevel?: number; /** @description Indicates if this right is active */ isActive: boolean; links?: components["schemas"]["FormattedRightLinks"]; }; FormattedRightLinks: { right: components["schemas"]["CreationOfRightItemLink"]; rightHtml: components["schemas"]["InternalHtmlLinkCreationOfRight"]; }; InternalHtmlLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; InternalHtmlLinkCreationOfRight: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; LandData: { /** @description Original cadastres of this land data right */ fromCadastres?: components["schemas"]["LandDataCadastre"][]; /** @description Resulting cadastres of this land data right */ toCadastres?: components["schemas"]["LandDataCadastre"][]; /** @description Original shares of this land data right */ fromShare?: components["schemas"]["LandDataShare"][]; /** @description Resulting shares of this land data right */ toShare?: components["schemas"]["LandDataShare"][]; purchasePrice?: components["schemas"]["Money"]; /** @description Whether the purchase price was at market value. Is filled only when this is of type area transfer */ hasMarketValue?: boolean; /** @description Whether the realty bought contains one or more buildings. Is filled only when this is of type area transfer */ containsBuilding?: boolean; conveyanceType?: components["schemas"]["Code"]; }; LandDataCadastre: { cadastreIdent: components["schemas"]["CadastreIdent"]; cadastreKey: string; /** @description The ident of the cadastre this area belongs to */ roleText?: string; fraction?: components["schemas"]["Fraction"]; purposeSectioning?: components["schemas"]["Code"]; additionalPart?: components["schemas"]["Code"]; /** @description Indicates if active. If not its historical */ isActive: boolean; }; LandDataShare: { shareIdent: components["schemas"]["ShareIdentModel"]; isActive: boolean; housingCooperativeName: string; referencedShare?: components["schemas"]["LandDataShare"]; }; LeaseAgreement: { /** @description List of leaseholders */ leaseholders: components["schemas"]["PersonRelation"][]; amount?: components["schemas"]["Money"]; amountPeriodType?: components["schemas"]["Code"]; /** * Format: int32 * @description Duration */ duration?: number; durationPeriodType?: components["schemas"]["Code"]; fromDate?: components["schemas"]["ApiDate"]; }; LeaseholdAgreement: { /** @description Conditions in this leasehold agreement */ conditions: components["schemas"]["LeaseholdCondition"][]; }; LeaseholdCondition: { /** * Format: int32 * @description Leasehold time */ leaseholdTime?: number; leaseholdFee?: components["schemas"]["Money"]; landValue?: components["schemas"]["Money"]; conclusionDate?: components["schemas"]["ApiDate"]; }; ListedPledge: { notificationDate?: components["schemas"]["ApiDate"]; /** @description The possessors of this listed pledge */ possessors?: components["schemas"]["PersonRelation"][]; /** * Format: int32 * @description Priority */ priority?: number; }; Mortgage: { /** @description The original amounts on the mortgage document */ originalAmounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The mortgagees this mortgage refers to */ mortgagees?: components["schemas"]["PersonRelation"][]; listedPledge?: components["schemas"]["ListedPledge"]; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; /** @description Indicates that this right is a securing bond */ isPledgeSecuringBond?: boolean; }; Office: { /** * Format: int32 * @description The juridical office where this document belongs to */ officeNumber: number; /** @description The name of the office this document belongs to */ officeName: string; }; OtherEncumbrance: { /** @description List of persons that have license */ personsWithLicense?: components["schemas"]["PersonRelation"][]; /** @description List of persons that has to consent to the deletion of this right */ deletionNeedsConsentFrom?: components["schemas"]["PersonRelation"][]; /** @description List of entire cadastres/cadastreLevel that have license */ cadastresWithLicense?: components["schemas"]["CadastreLevelRelation"][]; /** @description List of cadastre ownerships that have license */ cadastreOwnershipsWithLicense?: components["schemas"]["CadastreOwnershipRelation"][]; /** @description List of entire shares/shareLevel that have license */ sharesWithLicense?: components["schemas"]["ShareLevelRelation"][]; /** @description List of share ownerships that have license */ shareOwnershipsWithLicense?: components["schemas"]["ShareOwnershipRelation"][]; }; OwnershipConveyance: { rightIdent?: components["schemas"]["CreationOfRightIdent"]; /** @description Key for title right */ rightKey?: string; timeRegistered?: components["schemas"]["ApiDateTime"]; documentType?: components["schemas"]["Code"]; }; PersonRelation: { isActive: boolean; person: components["schemas"]["Person"]; }; Presentation: { /** @description A formatted presentation string */ formatted: string; }; PriorityAppliesTo: { creationOfRight?: components["schemas"]["CreationOfRight"]; /** @description The type of the relation */ priorityRelationType?: string; /** @description Cadastres this priority affect */ cadastres?: components["schemas"]["CadastreLevelRelation"][]; /** @description Cadastres this priority affect */ shares?: components["schemas"]["ShareLevelRelation"][]; }; PriorityDecision: { /** @description Contains the text of priority relation type */ priorityRelationType?: string; /** @description The amounts in the decision */ amounts?: { [key: string]: components["schemas"]["Money"]; }; /** @description The amounts that this claim concedes with */ amountsSubordinatedWith?: { [key: string]: components["schemas"]["Money"]; }; /** @description The amounts that this claim concedes for */ amountsSubordinatedFor?: { [key: string]: components["schemas"]["Money"]; }; /** @description Contains the persons that are mortgagees */ mortgagees?: components["schemas"]["Person"][]; /** @description Contains relation about what objects this priority affect */ rightsWithOtherPriority?: components["schemas"]["PriorityAppliesTo"][]; }; /** @description Rights with relation to this Creation of right */ RelatedRights: { /** @description Remarks on this Creation of right */ remarks?: { [key: string]: components["schemas"]["CreationOfRight"]; }; /** @description Encumbrances on this Creation of right */ encumbrances?: { [key: string]: components["schemas"]["CreationOfRight"]; }; }; Remark: { /** @description Reasons for this remark */ reasons?: { [key: string]: string; }; downpayment?: components["schemas"]["Downpayment"]; transport?: components["schemas"]["Transport"]; exchange?: components["schemas"]["Exchange"]; appeal?: components["schemas"]["Appeal"]; priorityDecision?: components["schemas"]["PriorityDecision"]; administration?: components["schemas"]["Administration"]; }; RightDetails: { /** @description Text embedded on the document */ textLines: components["schemas"]["TextLineDetails"][]; /** @description Type of details. A corresponding field will be filled with data */ detailsType: string; leaseAgreement?: components["schemas"]["LeaseAgreement"]; leaseholdAgreement?: components["schemas"]["LeaseholdAgreement"]; otherEncumbrance?: components["schemas"]["OtherEncumbrance"]; enforcement?: components["schemas"]["Enforcement"]; landData?: components["schemas"]["LandData"]; title?: components["schemas"]["Title"]; mortgage?: components["schemas"]["Mortgage"]; remark?: components["schemas"]["Remark"]; office?: components["schemas"]["Office"]; encumbranceTransfer?: components["schemas"]["EncumbranceTransfer"]; appliesTo?: components["schemas"]["AppliesTo"]; }; ShareConveyanceItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareIdentModel: { /** Format: int32 */ organizationNumber: number; /** Format: int32 */ shareNumber: number; formattedString: string; uniqueKey: string; }; ShareItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareLevelRelation: { shareLevel: components["schemas"]["LevelCode"]; shareIdent: components["schemas"]["ShareIdent"]; shareKey: string; housingCooperativeName: string; fraction?: components["schemas"]["Fraction"]; isActive: boolean; }; ShareOwnership: { ident: components["schemas"]["ShareOwnershipIdent"]; municipality?: components["schemas"]["MunicipalityData"]; key: string; /** @description The name of the cooperative */ housingCooperativeName: string; /** @description Whether this ownership is registered in the Land Registry. Not used! */ registered?: boolean; ownedShareIdent?: components["schemas"]["ShareIdent"]; /** @description Owned housing cooperation share key */ ownedShareKey?: string; fraction?: components["schemas"]["Fraction"]; usedForType?: components["schemas"]["Code"]; dwellingType?: components["schemas"]["Code"]; shareLevel: components["schemas"]["LevelCode"]; /** @description Specifies if this ownership is on the maximum ownership level of the share */ isMaxShareLevel: boolean; owningPerson?: components["schemas"]["Person"]; /** * Format: int32 * @description Number of owners on the level specified by shareLevel */ numberOfOwnersOnLevel?: number; /** @description Whether the owningPerson lives in this share */ isResidence?: boolean; /** @description Specifies if this ownership active */ isActive: boolean; /** @description Specifies if the owned share is active */ isOwnedObjectActive: boolean; bought?: components["schemas"]["OwnershipConveyance"]; sold?: components["schemas"]["OwnershipConveyance"]; links?: components["schemas"]["ShareOwnershipLinks"]; objectTypeName: string; }; ShareOwnershipIdent: { shareIdent: components["schemas"]["ShareIdent"]; /** * Format: int32 * @description A serial for all owners of the same share */ ownershipNumber: number; /** * Format: int32 * @description Specifies what kind of ownership the owner has on the share */ shareLevel?: number; }; ShareOwnershipItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareOwnershipLinks: { self?: components["schemas"]["ShareOwnershipItemLink"]; ownedShare?: components["schemas"]["ShareItemLink"]; owningPerson?: components["schemas"]["PersonItemLink"]; conveyance?: components["schemas"]["ShareConveyanceItemLink"]; boughtRight?: components["schemas"]["CreationOfRightItemLink"]; soldRight?: components["schemas"]["CreationOfRightItemLink"]; }; ShareOwnershipRelation: { ownership: components["schemas"]["ShareOwnership"]; /** @description Indicates if this connection is active. If not its historical */ isActive: boolean; creationOfRight?: components["schemas"]["CreationOfRight"]; }; TextItem: { /** @description Text */ text?: string; linkToReferencedObject?: components["schemas"]["Link"]; /** * @description If set, this indicates that this text should be aligned to the left or right * @enum {string} */ alignment?: "left" | "right"; /** @description Indicates that this text should be presented with a bold text */ bold: boolean; }; TextLine: { /** @description List of text items on this line */ items: components["schemas"]["TextItem"][]; /** @description Indicates if the text represents active data. If not, it's historical. */ isActive?: boolean; }; TextLineDetails: { isActive: boolean; text: components["schemas"]["Code"]; }; Title: { /** @description List of persons that have sold title to cadastre */ cadastreSellers: components["schemas"]["CadastreOwnershipRelation"][]; /** @description List of persons that have sold title to share */ shareSellers: components["schemas"]["ShareOwnershipRelation"][]; feeBasis?: components["schemas"]["Money"]; feeCause?: components["schemas"]["Code"]; purchasePrice?: components["schemas"]["Money"]; /** @description Whether the purchase price was at market value */ hasMarketValue?: boolean; /** @description Whether the realty bought contains one or more buildings */ containsBuilding?: boolean; conveyanceType?: components["schemas"]["Code"]; }; TransferredEncumbrance: { /** @description Indicates if this connection is active. If not its historical */ isActive: boolean; transferredTo?: components["schemas"]["TransferredEncumbranceTo"]; transferredFrom?: components["schemas"]["TransferredEncumbranceFrom"]; }; TransferredEncumbranceFrom: { cadastre?: components["schemas"]["CadastreLevelRelation"]; creationOfRightIdent?: components["schemas"]["CreationOfRightIdent"]; }; TransferredEncumbranceTo: { cadastre?: components["schemas"]["CadastreLevelRelation"]; ownership?: components["schemas"]["CadastreOwnershipRelation"]; }; Transport: { /** @description Persons that the document is transported from */ fromPerson?: components["schemas"]["PersonRelation"][]; /** @description Persons that the document is transported to */ toPerson?: components["schemas"]["PersonRelation"][]; /** @description CadastreLevels the document is transported from */ fromCadastreLevel?: components["schemas"]["CadastreLevelRelation"][]; /** @description CadastreLevels the document is transported to */ toCadastreLevel?: components["schemas"]["CadastreLevelRelation"][]; /** @description ShareLevels the document is transported from */ fromShareLevel?: components["schemas"]["ShareLevelRelation"][]; /** @description ShareLevels the document is transported to */ toShareLevel?: components["schemas"]["ShareLevelRelation"][]; }; CreationOfRightsListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CreationOfRight"][]; pagination?: components["schemas"]["Pagination"]; }; AddressListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Building: { ident: components["schemas"]["BuildingIdent"]; /** @description The building number */ key: string; updatedDate?: components["schemas"]["ApiDate"]; /** * Format: int32 * @description The municipality number */ municipalityNumber: number; municipality?: components["schemas"]["MunicipalityData"]; /** * Format: int32 * @description The number of occupied units in the building */ numberOfUnits: number; /** @description If the building has a registered elevator */ hasElevator: boolean; /** * Format: int32 * @description The number of floors in the building */ numberOfFloors: number; /** * Format: double * @description The total usable area inside the building */ totalFloorSpace?: number; /** * Format: double * @description The total living area inside the building */ totalAreaOfPrimarySpace?: number; /** * Format: double * @description The total area not used for living inside the building */ areaOfSecondarySpace?: number; /** @description Whether the area is measured fully or not */ incompleteArea?: boolean; /** * Format: double * @description Area that is built on */ builtUpArea?: number; /** * Format: double * @description The total area of the building, including walls */ totalArea?: number; /** * Format: double * @description The total area of the building used for living */ totalAreaHousing?: number; /** * Format: double * @description The total area of the building not used for living */ totalAlternateArea?: number; position?: components["schemas"]["GeoJSONFeature"]; geojson?: components["schemas"]["GeoJSONObject"]; buildingStatus?: components["schemas"]["Code"]; typeOfBuilding?: components["schemas"]["Code"]; industryGroup?: components["schemas"]["Code"]; waterSupplyType?: components["schemas"]["Code"]; dischargeType?: components["schemas"]["Code"]; originType?: components["schemas"]["Code"]; /** @description The type of heating this building primarily uses */ heatingType?: components["schemas"]["Code"][]; /** @description The type of energy source this building primarily uses */ energySourceType?: components["schemas"]["Code"][]; approvedDate?: components["schemas"]["ApiDate"]; registeredApprovedDate?: components["schemas"]["ApiDate"]; startedDate?: components["schemas"]["ApiDate"]; registeredStartedDate?: components["schemas"]["ApiDate"]; usedDate?: components["schemas"]["ApiDate"]; registeredUsedDate?: components["schemas"]["ApiDate"]; /** @description The building status history */ buildingStatusHistory?: components["schemas"]["BuildingStatusHistory"][]; /** @description The registered floor information for this building. */ floors?: components["schemas"]["Floor"][]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["BuildingLinks"]; }; BuildingChangeListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; BuildingIdent: { /** * Format: int32 * @description A unique number that identifies a building */ buildingNumber: number; }; BuildingItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; BuildingLinks: { self?: components["schemas"]["BuildingItemLink"]; singleheritages?: components["schemas"]["SingleHeritageListLink"]; buildingchanges?: components["schemas"]["BuildingChangeListLink"]; culturalheritages?: components["schemas"]["CulturalHeritageListLink"]; cadastres?: components["schemas"]["CadastreListLink"]; addresses?: components["schemas"]["AddressListLink"]; units?: components["schemas"]["SeparatelyOccupiedUnitListLink"]; contacts?: components["schemas"]["PersonListLink"]; developers?: components["schemas"]["PersonListLink"]; floors?: components["schemas"]["FloorListLink"]; }; BuildingListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Building"][]; pagination?: components["schemas"]["Pagination"]; }; BuildingStatusHistory: { buildingStatus?: components["schemas"]["Code"]; buildingStatusDate?: components["schemas"]["ApiDate"]; buildingStatusRegisteredDate?: components["schemas"]["ApiDate"]; }; CulturalHeritageListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Floor: { ident: components["schemas"]["FloorIdent"]; /** @description The building number, floor number and code */ key: string; /** * Format: int32 * @description Whether this floor is active (0) or historical (1) */ eventStatus: number; /** * Format: int32 * @description The number of apartments / dwelling units on the floor */ numberOfDwellingUnits?: number; /** * Format: double * @description The total area of alternative space. */ totalAlternateArea?: number; /** * Format: double * @description The total area inside the housing, including walls */ totalArea?: number; /** * Format: double * @description The total area inside the housing, including walls */ totalAreaHousing?: number; /** * Format: double * @description The total area inside the primary rooms, excluding walls */ totalAreaOfPrimarySpace?: number; /** * Format: double * @description The total area inside the floor, excluding walls */ totalFloorSpace?: number; /** * Format: double * @description The total area inside the floor, excluding walls */ totalUsableArea?: number; links?: components["schemas"]["FloorLinks"]; }; FloorIdent: { /** * Format: int32 * @description The building number */ buildingNumber: number; /** * Format: int32 * @description The floor number */ floorNumber: number; floorLevelCode: components["schemas"]["Code"]; }; FloorItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; FloorLinks: { self?: components["schemas"]["FloorItemLink"]; building?: components["schemas"]["BuildingItemLink"]; }; FloorListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; PersonListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SeparatelyOccupiedUnitListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SingleHeritageListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; BuildingItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Building"]; }; PersonSearch: { ident: components["schemas"]["PersonIdent"]; /** @description An anonymous person id */ key: string; dateOfBirth?: components["schemas"]["ApiDate"]; /** * Format: int32 * @description The current age of the person */ age?: number; /** @description The sex of this person */ sex?: string; /** @description The organization number of this company */ organizationNumber?: string; /** @description The first name of a person */ givenName?: string; /** @description The middle name of a person */ middleName?: string; /** @description The last name of a person */ familyName?: string; /** @description The combined name of a person */ name?: string; location?: components["schemas"]["Location"]; /** @description A business address for an organization */ businessAddress?: string; dsfState?: components["schemas"]["Code"]; links?: components["schemas"]["PersonSearchLinks"]; }; PersonSearchLinks: { self: components["schemas"]["PersonItemLink"]; persons: components["schemas"]["PersonItemLink"]; ownedCadastres: components["schemas"]["CadastreListLink"]; ownedShares: components["schemas"]["ShareListLink"]; residence?: components["schemas"]["AddressItemLink"]; organization?: components["schemas"]["OrganizationItemLink"]; }; PersonSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["PersonSearch"][]; pagination?: components["schemas"]["Pagination"]; }; ShareOwnershipListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["ShareOwnership"][]; pagination?: components["schemas"]["Pagination"]; }; ShareOwnershipItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareOwnership"]; }; User: { /** @description The name of the user */ userName: string; /** @description Whether the user is active */ active: boolean; /** * Format: int32 * @description The amount of historical data fetched by default expressed in months */ defaultMonthsOfData: number; /** * Format: int32 * @description The maximum amount of historical data that can be fetched expressed in months */ maxMonthsOfData: number; /** @description Whether the filter should be enabled */ showFilter: boolean; /** @description Whether the property layer should be enabled */ showPropertyLayer: boolean; /** * Format: double * @description Lower left x coordinate */ xMin: number; /** * Format: double * @description Lower left y coordinate */ yMin: number; /** * Format: double * @description Upper right x coordinate */ xMax: number; /** * Format: double * @description Upper right y coordinate */ yMax: number; /** @description True if the customer has access to municipalities */ hasMunicipalities: boolean; }; UserItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["User"]; }; CadastreLiensCalculationItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreRisk: { /** @description Indicating whether this risk is present or not */ isPresent: boolean; /** @description A description of this risk */ description: string; /** @description A short description of this risk */ shortDescription: string; /** @description Type of object this risk is related to */ riskOnObject: string; /** @description If risk found in the Land Registry for fixed property/share, this map contains the creation of rights that is the reason for the risk. */ levels?: { [key: string]: components["schemas"]["CadastreRiskRightsInLevel"]; }; }; CadastreRiskRightsInLevel: { cadastreLevel?: components["schemas"]["LevelCode"]; rights: { [key: string]: components["schemas"]["CadastreScoreRight"]; }; }; CadastreScore: { ident: components["schemas"]["CadastreIdent"]; /** @description The key for this resource */ key: string; /** @description Indicates whether score applies to max cadastre level only */ maxCadastreLevel: boolean; /** @description Indicates if scoring for this cadastre is possible */ isScorable: boolean; /** @description If not scorable, this string contains the reason */ reasonNotScorable?: string; overallRisk?: components["schemas"]["Code"]; /** @description Collection of all possible high risks */ highRisks?: { [key: string]: components["schemas"]["CadastreRisk"]; }; /** @description Collection of all possible medium risks */ mediumRisks?: { [key: string]: components["schemas"]["CadastreRisk"]; }; /** @description Collection of all possible low risks */ lowRisks?: { [key: string]: components["schemas"]["CadastreRisk"]; }; links?: components["schemas"]["CadastreScoreLinks"]; }; CadastreScoreItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreScoreItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreScore"]; }; CadastreScoreLinks: { self?: components["schemas"]["CadastreScoreItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; liensCalculation?: components["schemas"]["CadastreLiensCalculationItemLink"]; }; AccountantHousingDataItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Address: { ident: components["schemas"]["AddressIdent"]; /** @description The address ident */ key: string; updatedDate?: components["schemas"]["ApiDate"]; formatted: components["schemas"]["AddressFormatted"]; addressType: components["schemas"]["Code"]; municipality: components["schemas"]["MunicipalityData"]; postalPlace: components["schemas"]["PostalPlace"]; position?: components["schemas"]["GeoJSONFeature"]; /** * Format: int32 * @description Whether the address is active (0) or historical (1) */ eventStatus: number; /** @description An alternate name for the address */ alternativeAddress?: string; /** @description A short name for the address, not unique */ shortName?: string; sourceOfAddressName?: components["schemas"]["Code"]; street?: components["schemas"]["Street"]; geojson?: components["schemas"]["GeoJSONObject"]; /** @description If the person has a share */ hasShare?: boolean; /** @description If the person has housing */ hasHousing?: boolean; /** @description If the person has a holiday home */ hasHolidayHome?: boolean; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["AddressLinks"]; }; AddressLinks: { self?: components["schemas"]["AddressItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; buildings?: components["schemas"]["BuildingListLink"]; units?: components["schemas"]["SeparatelyOccupiedUnitListLink"]; districts?: components["schemas"]["DistrictListLink"]; shares?: components["schemas"]["ShareListLink"]; street?: components["schemas"]["StreetListLink"]; }; AffairListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Agriculture: { updatedDate?: components["schemas"]["ApiDate"]; cadastreIdent?: components["schemas"]["CadastreIdent"]; /** @description The cadastre key */ cadastreKey?: string; /** * Format: int32 * @description Agricultural area in acres */ agriculturalArea?: number; /** * Format: int32 * @description Area where the use is not specified in acres */ otherArea?: number; /** * Format: int32 * @description Forest area in acres */ forestArea?: number; /** * Format: int32 * @description Full grown areas in acres */ fullGrownArea?: number; /** * Format: int32 * @description Cultivated area in acres */ cultivatedArea?: number; /** * Format: int32 * @description Pasture area in acres */ pastureArea?: number; /** * Format: double * @description The area of the cadastre that is specified as opposed to measured area in square meters */ specifiedArea?: number; areaSource?: components["schemas"]["Code"]; /** @description Whether the agriculture is historical in the land registry */ isHistoricalRegisteredLand?: boolean; /** @description Whether the agriculture is historical in the technical land registry */ isHistoricalTechnicalRegisteredLand?: boolean; /** @description Organization companies connected to cadastre */ companies?: components["schemas"]["AgricultureCompany"][]; links?: components["schemas"]["AgricultureLinks"]; }; AgricultureCompany: { updatedDate?: components["schemas"]["ApiDate"]; /** * Format: int32 * @description Organization number connected to farm */ orgnr?: number; /** @description Eigth digit producer number */ producerNumber8?: string; /** @description Ten digit producer number */ producerNumber10?: string; links?: components["schemas"]["AgricultureCompanyLinks"]; }; AgricultureCompanyLinks: { organization?: components["schemas"]["OrganizationItemLink"]; }; AgricultureLinks: { operatingUnit?: components["schemas"]["OperatingUnitItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; buildings?: components["schemas"]["BuildingListLink"]; }; BuildingChangeItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; BuildingListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Cadastre: { ident: components["schemas"]["CadastreIdent"]; key: string; position?: components["schemas"]["GeoJSONFeature"]; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; municipality?: components["schemas"]["MunicipalityData"]; /** @description Whether the cadastre is sectioned in the technical land registry */ isSectioned?: boolean; /** @description Whether the cadastre is historical in the land registry */ isHistoricalRegisteredLand?: boolean; /** @description Whether the cadastre is historical in the technical land registry */ isHistoricalTechnicalRegisteredLand?: boolean; /** @description Whether the cadastre is registered in the land registry */ isRegisteredLand?: boolean; /** @description Whether the cadastre is registered in the technical land registry */ isTechnicalRegisteredLand?: boolean; /** @description Whether it is possible to add a mortgage to the cadastre */ canBeMortgaged?: boolean; /** @description Whether the cadastre is sellable */ canBeSold?: boolean; propertyType?: components["schemas"]["Code"]; establishedDate?: components["schemas"]["ApiDate"]; /** @description The name of this cadastre unit */ unitName?: string; /** * Format: double * @description The area of the cadastre that is specified as opposed to measured area */ specifiedArea?: number; areaSource?: components["schemas"]["Code"]; /** * Format: double * @description The area of a unregistered farm commons */ unregisteredFarmCommonsArea?: number; areaSourceForUnregisteredFarmCommons?: components["schemas"]["Code"]; /** * Format: double * @description The area of a disputed plot */ disputedPlotArea?: number; areaSourceForDisputedPlot?: components["schemas"]["Code"]; /** * Format: double * @description The area of a shared area */ sharedArea?: number; areaSourceForSharedArea?: components["schemas"]["Code"]; /** * Format: double * @description The area of the main cadastre, only present on sections */ areaMainCadastre?: number; areaSourceForMainCadastre?: components["schemas"]["Code"]; /** @description The land taxation was an estimate of the size of a new cadastre and was used to calculate the land tax. This law was repealed in 1980 */ landTaxation?: number; /** @description Whether a leasehold is tied to a geographic point (true) or is measured land (false) */ pointHitch?: boolean; /** @description Whether the cadastre is registered from new land. Most cadastres come from other cadastres */ newRegistration?: boolean; /** @description Whether the cadastre is an agricultural cadastre */ agriculturalCadastre?: boolean; agriculture?: components["schemas"]["Agriculture"]; industryGroup?: components["schemas"]["Code"]; /** @description Whether this cadastre has expired */ expired?: boolean; /** @description Whether there are any active leaseholds on this cadastre */ hasActiveLeasedLand?: boolean; /** @description Whether there are registered any noted complaints on this cadastre */ hasNotedComplaint?: boolean; /** @description Whether there are registered land acquisition on this cadastre */ hasRegisteredLandAcquisition?: boolean; /** @description Whether there are registered land consolidation required on this cadastre */ hasRegisteredLandConsolidationRequired?: boolean; /** @description Whether it is possible to create an Old Cadastre PDF based on this cadastre */ hasOldCadastre?: boolean; /** @description Whether this cadastre are included in total real estate */ includedInTotalRealEstate?: boolean; /** @description Whether there are registered any single heritage on this cadastre */ hasSingleHeritage?: boolean; /** @description Whether there are registered any soil contamination on this cadastre */ hasSoilContamination?: boolean; /** @description Whether this cadastre has any separately occupied units of type housing */ hasHousing?: boolean; /** @description Whether this cadastre has any separately occupied units of type holiday home */ hasHolidayHome?: boolean; concession?: components["schemas"]["Code"]; /** @description Liability to reside on the cadastre */ zeroConcession?: boolean; /** @description Extra information you should check if cadastre is registered with zeroConcession */ zeroConcessionMessage?: string; /** @description Whether this cadastre has any buildings at all */ hasBuilding?: boolean; /** @description Whether this cadastre has a building approved for construction */ hasBuildingApprovedForConstruction?: boolean; maxCadastreLevel?: components["schemas"]["LevelCode"]; /** * Format: int32 * @description Number of plots */ numberOfPlots?: number; sourceSystem?: components["schemas"]["Code"]; currentSectioning?: components["schemas"]["CadastreSectioning"]; cityDistrict?: components["schemas"]["CityDistrict"]; /** * Format: int32 * @description A field which derives PROM for this cadastre for an external source */ promDerived?: number; promSource?: components["schemas"]["Code"]; /** @description True if owned by a cooperative */ ownedByCooperative?: boolean; /** @description True if owned by a cooperation */ ownedByCorporation?: boolean; /** @description True if owned by a housing cooperation */ ownedByHousingCorporation?: boolean; /** * Format: int64 * @description A separate id to identify a cadastre in Matrikkelen */ MatrikkelenId?: number; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; postalPlace?: components["schemas"]["PostalPlace"]; links?: components["schemas"]["CadastreLinks"]; }; CadastreConveyance: { ident: components["schemas"]["CreationOfRightIdent"]; key: string; dateRegistered?: components["schemas"]["ApiDate"]; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentType: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; priorityType?: components["schemas"]["Code"]; /** @description Text embedded on the document */ textLines?: string[]; /** * Format: int64 * @description Basis for calculation of fee */ feeBasis?: number; feeCause?: components["schemas"]["Code"]; /** * Format: int64 * @description The purchase price */ purchasePrice?: number; currency?: components["schemas"]["Code"]; /** @description Whether the purchase price was at market value */ hasMarketValue?: boolean; /** @description Whether the realty bought contains one or more buildings */ containsBuilding?: boolean; conveyanceType?: components["schemas"]["Code"]; /** * Format: int32 * @description Number of cadastres related to this conveyance */ numberOfCadastresInConveyance?: number; /** @description If this conveyance applies to entire cadastres. All ownership fractions are whole. */ appliesToEntireCadastre?: boolean; links?: components["schemas"]["CadastreConveyanceLinks"]; }; CadastreConveyanceLinks: { self?: components["schemas"]["CadastreConveyanceItemLink"]; buyers?: components["schemas"]["PersonListLink"]; sellers?: components["schemas"]["PersonListLink"]; cadastres?: components["schemas"]["CadastreListLink"]; }; CadastreEncumbranceShare: { fraction?: components["schemas"]["Fraction"]; person?: components["schemas"]["Person"]; }; CadastreExtended: { cadastre: components["schemas"]["Cadastre"]; address?: components["schemas"]["Address"]; units?: components["schemas"]["SeparatelyOccupiedUnitExtended"][]; latestConveyance?: components["schemas"]["CadastreConveyance"]; liensCalculation?: components["schemas"]["CadastreLiensCalculation"]; cadastreOwnerships?: components["schemas"]["CadastreOwnership"][]; }; CadastreHousingValueItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreHousingValueListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreLandRegistryItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreLien: { ident: components["schemas"]["CreationOfRightIdent"]; key: string; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentType: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; registeredDate?: components["schemas"]["ApiDate"]; cadastreLevel?: components["schemas"]["Code"]; /** * Format: int32 * @description A number defining the priority of this lien, lower number having higher priority */ priority?: number; /** @description Text embedded on the document */ textLines?: string[]; /** @description The current amount of the lien */ currentAmounts?: components["schemas"]["Money"][]; /** @description The original amount of the lien */ originalAmounts?: components["schemas"]["Money"][]; /** @description List of the persons holding the mortgage */ mortgagees?: components["schemas"]["Person"][]; cadastreShares?: components["schemas"]["CadastreEncumbranceShare"][]; remarks?: string[]; /** @description List of the persons suing in this enforcement case */ plaintiffs?: components["schemas"]["Person"][]; /** @description List of the persons prosecuted in this enforcement case */ defendants?: components["schemas"]["Person"][]; /** @description List of legal persons registered on the enforcement case */ legalRepresentatives?: components["schemas"]["Person"][]; attachmentDate?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; /** @description Indicates if this lien is an enforcement */ isEnforcement?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** * Format: int32 * @description The number of cadastres affected by this lien */ numberOfCadastres?: number; links?: components["schemas"]["LienLinks"]; dateRegistered?: components["schemas"]["ApiDate"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; priorityType?: components["schemas"]["Code"]; outstandingDebt?: components["schemas"]["OutstandingDebt"]; }; CadastreLiensCalculation: { ident: components["schemas"]["CadastreIdent"]; key: string; /** @description Can be interpreted */ isInterpretable?: boolean; /** @description Is in a foreign currency */ hasForeignCurrency?: boolean; /** @description List of reasons why the lien cannot be interpreted */ reasonsNotInterpretable?: components["schemas"]["Code"][]; pledge?: components["schemas"]["CadastrePledge"]; /** @description List of liens */ liens?: components["schemas"]["CadastreLien"][]; /** @description True if lien reduces owners sovereign */ hasSovereigntyLimitation?: boolean; /** @description True if this lien has a right of residence */ hasRightOfResidence?: boolean; /** @description True if this lien has an easement with a monetary encumbrance */ hasMonetaryEncumbranceEasement?: boolean; /** @description True if this lien has a preemptive right */ hasPreemptive?: boolean; /** @description True if this lien has right of use */ hasRightOfUse?: boolean; /** @description True if this lien has an easement */ hasEasement?: boolean; /** @description True if there are lease agreements */ hasLeaseAgreement?: boolean; /** @description True if there are leasehold agreements */ hasLeaseholdAgreement?: boolean; links?: components["schemas"]["CadastreLiensCalculationLinks"]; }; CadastreLiensCalculationLinks: { self: components["schemas"]["CadastreLiensCalculationItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; cadastrePDF?: components["schemas"]["PDFItemLink"]; objectScore?: components["schemas"]["CadastreScoreItemLink"]; }; CadastreLinks: { self?: components["schemas"]["CadastreItemLink"]; owners?: components["schemas"]["PersonListLink"]; buildings?: components["schemas"]["BuildingListLink"]; soilContaminations?: components["schemas"]["SoilContaminationListLink"]; complaints?: components["schemas"]["ComplaintListLink"]; sectionings?: components["schemas"]["SectioningListLink"]; sections?: components["schemas"]["CadastreListLink"]; plots?: components["schemas"]["PlotListLink"]; realtyEstateUnits?: components["schemas"]["RealtyEstateUnitListLink"]; conveyances?: components["schemas"]["CadastreConveyanceListLink"]; addresses?: components["schemas"]["AddressListLink"]; units?: components["schemas"]["SeparatelyOccupiedUnitListLink"]; shares?: components["schemas"]["ShareListLink"]; singleHeritages?: components["schemas"]["SingleHeritageListLink"]; objectScore?: components["schemas"]["CadastreScoreItemLink"]; ownedByOwnerships?: components["schemas"]["CadastreOwnershipListLink"]; ownershipsOwningThisCadastre?: components["schemas"]["CadastreOwnershipListLink"]; ownedOwnerships?: components["schemas"]["CadastreOwnershipListLink"]; ownershipsOwnedByThisCadastre?: components["schemas"]["CadastreOwnershipListLink"]; unregisteredOwnershipsOwnedByThisCadastre?: components["schemas"]["UnregisteredOwnershipListLink"]; unregisteredOwnershipsOwningThisCadastre?: components["schemas"]["UnregisteredOwnershipListLink"]; affairs?: components["schemas"]["AffairListLink"]; cadastrePDF?: components["schemas"]["PDFItemLink"]; cadastreWithPrivilegesPDF?: components["schemas"]["PDFItemLink"]; historicalCadastrePDF?: components["schemas"]["PDFItemLink"]; oldCadastrePDF?: components["schemas"]["PDFItemLink"]; technicalPDF?: components["schemas"]["PDFItemLink"]; simpleTechnicalPDF?: components["schemas"]["PDFItemLink"]; mapPDF?: components["schemas"]["PDFItemLink"]; simpleMapPDF?: components["schemas"]["PDFItemLink"]; mainCadastres?: components["schemas"]["CadastreListLink"]; liensCalculation?: components["schemas"]["CadastreLiensCalculationItemLink"]; housingValue?: components["schemas"]["CadastreHousingValueItemLink"]; surroundingHousingValues?: components["schemas"]["CadastreHousingValueListLink"]; presentationAddress?: components["schemas"]["AddressItemLink"]; accountantData?: components["schemas"]["AccountantHousingDataItemLink"]; landRegistry?: components["schemas"]["CadastreLandRegistryItemLink"]; }; CadastrePledge: { /** * Format: int64 * @description Sum pledge for the ownership in realties. Fractions are taken into account in the calculation. */ sumPledge: number; /** * Format: int32 * @description The number of pledges */ numberOfPledges?: number; /** * Format: int64 * @description The sum of the amounts on all the mortgages */ sumMortgage?: number; /** * Format: int64 * @description Sum of the calculated outstanding mortgages */ sumOutstandingMortgage?: number; /** * Format: int32 * @description The number of mortgages */ numberOfMortgages?: number; /** * Format: int64 * @description The sum of the amounts on all enforcements */ sumEnforcement?: number; /** * Format: int32 * @description The number of enforcements */ numberOfEnforcements?: number; /** @description True if a securing bond is present */ hasPledgeSecuringBond?: boolean; /** @description True if a pledging statement is present */ hasPledgingStatement?: boolean; /** @description If mortgages in this pledge have currency code <> 'NOK' */ hasMortgageWithForeignCurrency?: boolean; /** @description If enforcements in this pledge have currency code <> 'NOK' */ hasEnforcementWithForeignCurrency?: boolean; }; CadastreReference: { ident?: components["schemas"]["CadastreIdent"]; /** @description Key of cadastre */ key?: string; }; CadastreSectioning: { fraction?: components["schemas"]["Fraction"]; purpose?: components["schemas"]["Code"]; additionalPart?: components["schemas"]["Code"]; }; CityDistrict: { /** @description Key of city district */ key?: string; /** @description Name of city district */ name?: string; }; ComplaintListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; DistrictListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Extent: { se: components["schemas"]["Position"]; nw: components["schemas"]["Position"]; }; GeoJSONFeatureCollection: { type: string; /** @description Bounding box */ bbox?: number[]; features: components["schemas"]["GeoJSONFeature"][]; crs: components["schemas"]["GeoJSONCrs"]; properties?: components["schemas"]["GeoJSONProperties"]; }; HousingCooperative: { ident: components["schemas"]["HousingCooperativeIdent"]; /** @description The organization number of the cooperative */ key: string; /** @description The name of the cooperative */ housingCooperativeName: string; /** * Format: int32 * @description Amount of shares in housing cooperative */ numberOfShares?: number; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; links?: components["schemas"]["HousingCooperativeLinks"]; }; HousingCooperativeIdent: { /** * Format: int32 * @description The organization that owns the cooperative */ organizationNumber: number; }; HousingCooperativeItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; HousingCooperativeLinks: { self?: components["schemas"]["HousingCooperativeItemLink"]; owner?: components["schemas"]["PersonItemLink"]; shares?: components["schemas"]["ShareListLink"]; ownedCadastres?: components["schemas"]["CadastreListLink"]; }; LienLinks: { creationOfRightPDF?: components["schemas"]["PDFItemLink"]; }; OperatingUnitItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; PersonsOwnings: { persons?: components["schemas"]["Person"][]; responseInfo?: components["schemas"]["PersonsOwningsResponseInfo"]; ownedCadastres?: components["schemas"]["CadastreExtended"][]; ownedShares?: components["schemas"]["ShareExtended"][]; }; PersonsOwningsItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["PersonsOwnings"]; }; PersonsOwningsResponseInfo: { responseComplete: boolean; /** @description Indicates if there are any warnings to this response */ hasWarnings: boolean; warnings: components["schemas"]["PersonsOwningsWarnings"]; }; PersonsOwningsWarnings: { /** @description The requested persons had too many ownerships. The limit for the number of ownerships was exceeded. */ tooManyOwnerships: boolean; /** @description Some requested persons could not be found */ somePersonsNotFound: boolean; }; PlotListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Position: { /** * Format: double * @description The easting coordinate */ e?: number; /** * Format: double * @description The northing coordinate */ n?: number; }; PostalPlace: { /** * Format: int32 * @description The postal code */ postalCode: number; /** @description The postal code as a four character string */ postalCodeStr: string; /** @description The postal code name */ postalPlace: string; }; RealtyEstateUnitListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SectioningListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SeparatelyOccupiedUnit: { ident: components["schemas"]["SeparatelyOccupiedUnitIdent"]; /** @description The internal id */ key: string; /** @description The floor id for this unit */ floorId?: string; /** * Format: int32 * @description The floor number this unit is registered inside */ floorNumber?: number; floorLevelCode?: components["schemas"]["Code"]; /** * Format: int32 * @description The apartment number of this unit */ apartmentNumber?: number; /** @description The apartment unit number. DEPRECATED, use dwelling number */ unitNumber?: string; /** @description The apartment unit number */ dwellingNumber?: string; /** * Format: int32 * @description The internal id for SeparatelyOccupiedUnit. This id is generated and might change */ internalId?: number; /** * Format: double * @description The total area inside this unit excluding walls */ usableArea?: number; /** * Format: int32 * @description How many rooms this unit has excluding bathroom, WC and kitchen */ numberOfRooms?: number; /** * Format: int32 * @description How many bathrooms this unit has */ numberOfBathRooms?: number; /** * Format: int32 * @description How many WCs this unit has */ numberOfWCs?: number; kitchenAccessCode?: components["schemas"]["Code"]; unitType: components["schemas"]["Code"]; /** @description Whether this unit is connected to a building modification */ isBuildingChange?: boolean; buildingChangeCode?: components["schemas"]["Code"]; /** @description Whether this unit will be removed */ toBeExpired: boolean; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["SeparatelyOccupiedUnitLinks"]; }; SeparatelyOccupiedUnitExtended: { unit: components["schemas"]["SeparatelyOccupiedUnit"]; address: components["schemas"]["Address"]; building: components["schemas"]["Building"]; }; SeparatelyOccupiedUnitIdent: { /** * Format: int64 * @description An internal id for a separately occupied unit */ id: number; }; SeparatelyOccupiedUnitItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SeparatelyOccupiedUnitLinks: { self?: components["schemas"]["SeparatelyOccupiedUnitItemLink"]; building?: components["schemas"]["BuildingItemLink"]; buildingchange?: components["schemas"]["BuildingChangeItemLink"]; address?: components["schemas"]["AddressItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; share?: components["schemas"]["ShareItemLink"]; }; Share: { ident: components["schemas"]["ShareIdent"]; key: string; formattedAddress?: components["schemas"]["AddressFormatted"]; position?: components["schemas"]["GeoJSONFeature"]; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; /** @description Whether this share is active (false) or historical (true) */ isHistoricalRegisteredLand: boolean; /** @description Whether it is possible to add a mortgage to the share */ canBeMortgaged?: boolean; /** @description Whether the share is sellable */ canBeSold?: boolean; /** @description Is history for share available */ noHistoryForShare: boolean; housingCooperative: components["schemas"]["HousingCooperative"]; municipality?: components["schemas"]["MunicipalityData"]; /** @description Liability to reside on the share */ zeroConcession?: boolean; /** @description Extra information you should check if share is registered with zeroConcession */ zeroConcessionMessage?: string; maxShareLevel?: components["schemas"]["LevelCode"]; cityDistrict?: components["schemas"]["CityDistrict"]; landLot?: components["schemas"]["CadastreReference"]; postalPlace?: components["schemas"]["PostalPlace"]; /** @description The share is located outside of Norway */ shareWithForeignAddress?: boolean; links?: components["schemas"]["ShareLinks"]; }; ShareConveyance: { ident: components["schemas"]["ShareCreationOfRightIdent"]; key: string; dateRegistered?: components["schemas"]["ApiDate"]; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentType: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; priorityType?: components["schemas"]["Code"]; /** @description Text embedded on the document */ textLines?: string[]; /** * Format: int64 * @description The purchase price */ purchasePrice?: number; /** @description Whether the purchase price was at market value */ hasMarketValue?: boolean; conveyanceType?: components["schemas"]["Code"]; /** * Format: int32 * @description Number of shares related to this conveyance */ numberOfSharesInConveyance?: number; /** @description If this conveyance applies to entire shares. All ownership fractions are whole. */ appliesToEntireShare?: boolean; links?: components["schemas"]["ShareConveyanceLinks"]; }; ShareConveyanceLinks: { self?: components["schemas"]["ShareConveyanceItemLink"]; buyers?: components["schemas"]["PersonListLink"]; sellers?: components["schemas"]["PersonListLink"]; shares: components["schemas"]["ShareListLink"]; }; ShareEncumbranceShare: { fraction?: components["schemas"]["Fraction"]; person?: components["schemas"]["Person"]; }; ShareExtended: { share: components["schemas"]["Share"]; address?: components["schemas"]["Address"]; unit?: components["schemas"]["SeparatelyOccupiedUnitExtended"]; latestConveyance?: components["schemas"]["ShareConveyance"]; liensCalculation?: components["schemas"]["ShareLiensCalculation"]; shareOwnerships?: components["schemas"]["ShareOwnership"][]; }; ShareHousingValueItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareLandRegistryItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareLien: { ident: components["schemas"]["ShareCreationOfRightIdent"]; key: string; rightType: components["schemas"]["Code"]; documentCode: components["schemas"]["Code"]; documentType: components["schemas"]["Code"]; documentStatus: components["schemas"]["Code"]; registeredDate?: components["schemas"]["ApiDate"]; shareLevel?: components["schemas"]["LevelCode"]; /** @description List of the persons storing the documents */ documentHolder?: components["schemas"]["Person"][]; /** * Format: int32 * @description Priority of the lien */ priority?: number; /** @description Text embedded on the document */ textLines?: string[]; /** @description The current amounts registered on the rights */ currentAmounts?: components["schemas"]["Money"][]; /** @description The original amounts registered on the rights */ originalAmounts?: components["schemas"]["Money"][]; /** @description List of the persons holding the mortgage */ mortgagees?: components["schemas"]["Person"][]; /** @description The remarks for this lien */ remarks?: string[]; /** @description List of the persons suing in this enforcement case */ plaintiffs?: components["schemas"]["Person"][]; /** @description List of the persons prosecuted in this enforcement case */ defendants?: components["schemas"]["Person"][]; /** @description List of legal persons registered on the enforcement case */ legalRepresentatives?: components["schemas"]["Person"][]; attachmentDate?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right is active. If not its historical */ isActive: boolean; /** @description Indicates if this lien is an enforcement */ isEnforcement?: boolean; /** @description Indicates that this right is a pledging statement */ isPledgingStatement?: boolean; /** @description Whether or not a this document is a securing bond */ isPledgeSecuringBond?: boolean; /** @description The shares for this lien */ shares?: components["schemas"]["ShareEncumbranceShare"][]; /** * Format: int32 * @description The number of shares */ numberOfShares?: number; links?: components["schemas"]["LienLinks"]; dateRegistered?: components["schemas"]["ApiDate"]; timeRegistered?: components["schemas"]["ApiDateTime"]; /** @description Indicates if the right was submitted electronically */ isElectronicallySubmitted?: boolean; priorityType?: components["schemas"]["Code"]; outstandingDebt?: components["schemas"]["OutstandingDebt"]; }; ShareLiensCalculation: { ident: components["schemas"]["ShareIdent"]; key: string; /** @description Can be interpreted */ isInterpretable?: boolean; /** @description Is in a foreign currency */ hasForeignCurrency?: boolean; /** @description List of reasons why the lien cannot be interpreted */ reasonsNotInterpretable?: components["schemas"]["Code"][]; pledge?: components["schemas"]["SharePledge"]; /** @description List of liens */ liens?: components["schemas"]["ShareLien"][]; /** @description True if lien reduces owners sovereign */ hasSovereigntyLimitation?: boolean; /** @description True if this lien has an easement */ hasEasement?: boolean; /** @description True if this lien has an easement with a monetary encumbrance */ hasMonetaryEncumbranceEasement?: boolean; /** @description True if this lien has a preemptive right */ hasPreemptive?: boolean; /** @description True if this lien has a right of use */ hasRightOfUse?: boolean; links?: components["schemas"]["ShareLiensCalculationLinks"]; }; ShareLiensCalculationItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareLiensCalculationLinks: { self: components["schemas"]["ShareLiensCalculationItemLink"]; share?: components["schemas"]["ShareItemLink"]; sharePDF?: components["schemas"]["PDFItemLink"]; objectScore?: components["schemas"]["ShareScoreItemLink"]; }; ShareLinks: { self?: components["schemas"]["ShareItemLink"]; owners?: components["schemas"]["PersonListLink"]; conveyances?: components["schemas"]["ShareConveyanceListLink"]; address?: components["schemas"]["AddressItemLink"]; unit?: components["schemas"]["SeparatelyOccupiedUnitItemLink"]; building?: components["schemas"]["BuildingItemLink"]; landLot?: components["schemas"]["CadastreItemLink"]; objectScore?: components["schemas"]["ShareScoreItemLink"]; ownedByOwnerships?: components["schemas"]["ShareOwnershipListLink"]; ownershipsOwningThisShare?: components["schemas"]["ShareOwnershipListLink"]; housingCooperative?: components["schemas"]["HousingCooperativeItemLink"]; sharePDF?: components["schemas"]["PDFItemLink"]; historicalSharePDF?: components["schemas"]["PDFItemLink"]; titlePDF?: components["schemas"]["PDFItemLink"]; historicalTitlePDF?: components["schemas"]["PDFItemLink"]; mortgagePDF?: components["schemas"]["PDFItemLink"]; historicalMortgagePDF?: components["schemas"]["PDFItemLink"]; shareInfoPDF?: components["schemas"]["PDFItemLink"]; historicalShareInfoPDF?: components["schemas"]["PDFItemLink"]; liensCalculation?: components["schemas"]["ShareLiensCalculationItemLink"]; housingValue?: components["schemas"]["ShareHousingValueItemLink"]; accountantData?: components["schemas"]["AccountantHousingDataItemLink"]; landRegistry?: components["schemas"]["ShareLandRegistryItemLink"]; }; SharePledge: { /** * Format: int64 * @description Sum pledge for the ownership in realties. Fractions are taken into account in the calculation. */ sumPledge: number; /** * Format: int32 * @description The number of pledges */ numberOfPledges?: number; /** * Format: int64 * @description The sum of the amounts on all the mortgages */ sumMortgage?: number; /** * Format: int64 * @description Sum of the calculated outstanding mortgages */ sumOutstandingMortgage?: number; /** * Format: int32 * @description The number of mortgages */ numberOfMortgages?: number; /** * Format: int64 * @description The sum of the amounts on all enforcements */ sumEnforcement?: number; /** * Format: int32 * @description The number of enforcements */ numberOfEnforcements?: number; /** @description True if a securing bond is present */ hasPledgeSecuringBond?: boolean; /** @description True if a pledging statement is present */ hasPledgingStatement?: boolean; /** @description If mortgages in this pledge have currency code <> 'NOK' */ hasMortgageWithForeignCurrency?: boolean; /** @description If enforcements in this pledge have currency code <> 'NOK' */ hasEnforcementWithForeignCurrency?: boolean; /** @description True if at least one of the mortgages are listed */ hasListedMortgage?: boolean; /** @description True if at least one of the enforcements are listed */ hasListedEnforcement?: boolean; }; ShareScoreItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SoilContaminationListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Street: { ident: components["schemas"]["StreetIdent"]; /** @description The municipality and street number */ key: string; /** @description The name of the street */ streetName: string; /** * Format: int32 * @description The postal code the street is in */ postalCode: number; /** @description The postal code name */ postalPlace: string; /** @description A list of the postal places this street runs through */ postalPlaces: components["schemas"]["PostalPlace"][]; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONFeatureCollection"]; municipality?: components["schemas"]["MunicipalityData"]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["StreetLinks"]; }; StreetIdent: { /** * Format: int32 * @description The municipality the street is in */ municipalityNumber: number; /** * Format: int32 * @description The street number */ streetNumber: number; }; StreetItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; StreetLinks: { self?: components["schemas"]["StreetItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; addresses?: components["schemas"]["AddressListLink"]; districts?: components["schemas"]["DistrictListLink"]; }; StreetListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; PingResponse: { /** @description Whether realty is ok */ online: boolean; /** @description Contains all errors since last reset */ statuses?: string[]; /** * @description A status field * @enum {string} */ overall_status?: "green" | "yellow" | "orange" | "red"; /** @description Timestamp created on call */ status_time: string; /** @description Name of system */ system: string; /** @description The environment this component runs in, not in use at the moment */ env?: string; /** @description The version of this component */ version: string; /** @description Timestamp created when code was released */ release_time: string; /** @description Timestamp created when service was last started */ started_time: string; /** * Format: int64 * @description The time it took to respond in milliseconds */ latency: number; /** @description How current the land registry is (Elida) */ land_registry_ajour: string; /** @description How current the technical land registry is (Matrikkelen) */ technical_land_registry_ajour: string; /** * Format: int32 * @description Current size of local cache */ localCacheSize: number; }; Cookies: Record; HttpEntity: { knownEmpty: boolean; }; Result: { body: components["schemas"]["HttpEntity"]; flash: { [key: string]: string; }; session: { [key: string]: string; }; cookies: components["schemas"]["Cookies"]; }; StatusHeader: { body: components["schemas"]["HttpEntity"]; flash: { [key: string]: string; }; session: { [key: string]: string; }; cookies: components["schemas"]["Cookies"]; }; CoOwnerScore: { /** @description True if person can be scored */ isScorable?: boolean; overallRisk?: components["schemas"]["Code"]; /** * Format: int32 * @description The number of coowners */ numberOfCoOwners: number; /** @description The list of coowners */ coOwners?: components["schemas"]["CoOwnerWithScore"][]; }; CoOwnerWithScore: { key?: string; /** @description true if this person can be scored */ isScorable?: boolean; risk?: components["schemas"]["Code"]; }; CustomerScoreCoOwner: { ident: components["schemas"]["PersonIdent"]; /** @description The key for this resource */ key: string; /** @description The customers name */ customerName: string; /** @description Indicates if scoring for this person is possible */ isScorable: boolean; /** @description If not scorable, this string contains the reason */ reasonNotScorable?: string; overallRisk?: components["schemas"]["Code"]; /** * Format: int32 * @description The number of cadastres not mortgaged / containing no liens */ ownedCadastresWithoutPledge?: number; /** * Format: int32 * @description The number of shares not mortgaged / containing no liens */ ownedSharesWithoutPledge?: number; /** @description Collection of all possible high risks */ highRisks?: { [key: string]: components["schemas"]["Risk"]; }; /** @description Collection of all possible medium risks */ mediumRisks?: { [key: string]: components["schemas"]["Risk"]; }; /** @description Collection of all possible low risks */ lowRisks?: { [key: string]: components["schemas"]["Risk"]; }; mortgagesSummary?: components["schemas"]["CustomerScoreMortgagesSummary"]; links?: components["schemas"]["CustomerScoreLinks"]; coOwnerScore?: components["schemas"]["CoOwnerScore"]; }; CustomerScoreCoOwnerItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CustomerScoreCoOwner"]; }; HousingValueVirdi: { /** * Format: int64 * @description Calculated value */ calculatedValue?: number; /** * Format: int64 * @description Calculated value low */ calculatedValueLow?: number; /** * Format: int64 * @description Calculated value high */ calculatedValueHigh?: number; updated?: components["schemas"]["ApiDate"]; /** * Format: int64 * @description Calculated value without Joint Debt */ calculatedValueWithoutJointDebt?: number; /** * Format: int64 * @description Joint Debt */ jointDebt?: number; jointDebtUpdated?: components["schemas"]["ApiDate"]; /** @description Estimations this calculations is based on */ estimations?: components["schemas"]["VirdiEstimation"][]; }; Index: { conveyanceIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description Index value for the time the conveyance occured */ conveyanceIndexValue?: number; currentIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description The current index value */ currentIndexValue?: number; /** @description The code of index region */ indexRegion?: string; /** @description The name of index region */ indexRegionName?: string; }; ShareCalculationBasis: { conveyance?: components["schemas"]["ShareHousingValueConveyance"]; area?: components["schemas"]["ShareHousingValueArea"]; virdi?: components["schemas"]["HousingValueVirdi"]; index?: components["schemas"]["Index"]; unitType?: components["schemas"]["Code"]; preferredCalculationMethod?: components["schemas"]["Code"]; }; ShareHousingValue: { ident: components["schemas"]["ShareIdent"]; key: string; /** @description Indicates if the calculation is possible */ isCalculable?: boolean; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; indexSupplier?: components["schemas"]["Code"]; indexSupplierCode?: components["schemas"]["Code"]; /** @description Fixed text describing the calculation */ calculationText?: string; calculationBasis?: components["schemas"]["ShareCalculationBasis"]; links?: components["schemas"]["ShareHousingValueLinks"]; }; ShareHousingValueArea: { /** * Format: int32 * @description Number of separately occupied units */ numberOfUnits?: number; /** * Format: int32 * @description Number of buildings */ numberOfBuildings?: number; /** * Format: double * @description The sum of usable area used in calculation for each cadastre */ totalFloorSpace?: number; /** * Format: double * @description Price per square meter */ pricePerSquareMeter?: number; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; /** @description The code of index region */ indexRegion?: string; /** @description The name of index region */ indexRegionName?: string; }; ShareHousingValueConveyance: { dateRegistered?: components["schemas"]["ApiDate"]; documentCode?: components["schemas"]["Code"]; conveyanceType?: components["schemas"]["Code"]; usedForType?: components["schemas"]["Code"]; dwellingType?: components["schemas"]["Code"]; /** * Format: int64 * @description The purchase price of the conveyance */ purchasePrice?: number; /** * Format: int32 * @description The number of cadastres in the conveyance */ numberOfSharesInConveyance?: number; /** @description If the conveyance applies to entire cadastre */ appliesToEntireProperty?: boolean; conveyanceIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description The index value related to the time the conveyance occured */ conveyanceIndexValue?: number; currentIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description The current index value */ currentIndexValue?: number; /** @description The code of index region */ indexRegion?: string; /** @description The name of index region */ indexRegionName?: string; indexSupplier?: components["schemas"]["Code"]; indexSupplierCode?: components["schemas"]["Code"]; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; }; ShareHousingValueItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareHousingValue"]; }; ShareHousingValueLinks: { self: components["schemas"]["ShareHousingValueItemLink"]; share?: components["schemas"]["ShareItemLink"]; conveyanceInCalculationBasis?: components["schemas"]["ShareConveyanceItemLink"]; conveyances?: components["schemas"]["ShareConveyanceListLink"]; address?: components["schemas"]["AddressItemLink"]; unit?: components["schemas"]["SeparatelyOccupiedUnitItemLink"]; }; VirdiEstimation: { /** @description True if this estimation is based on a Separately Occupied Unit */ basedOnUnit: boolean; /** @description Key of Separately Occupied Unit this estimation (optionally) is based on */ unitKey?: string; /** @description The apartment unit number */ dwellingNumber?: string; /** @description Dwelling Address text */ addressText?: string; unitType?: components["schemas"]["Code"]; /** * Format: int64 * @description Calculated value */ calculatedValue: number; /** * Format: int64 * @description Calculated value low */ calculatedValueLow: number; /** * Format: int64 * @description Calculated value high */ calculatedValueHigh: number; /** * Format: int64 * @description Calculated value without Joint Debt */ calculatedValueWithoutJointDebt?: number; /** * Format: int64 * @description Joint Debt */ jointDebt?: number; jointDebtUpdated?: components["schemas"]["ApiDate"]; jointDebtSource?: components["schemas"]["Code"]; estimationMethod: components["schemas"]["Code"]; /** * Format: int32 * @description The level of uncertainty in the estimated price, integer from 1 (best/ least) to 5 (worst/ most) */ uncertaintyIndicator: number; links: components["schemas"]["VirdiSeparatelyOccupiedUnitLinks"]; }; VirdiSeparatelyOccupiedUnitLinks: { unit?: components["schemas"]["SeparatelyOccupiedUnitItemLink"]; }; Akeldo: { /** @description Deprecated. Use messagesConsumed */ messageTypes?: string[]; /** @description The types of messages this organization can receive */ messagesConsumed?: string[]; /** @description The types of messages this organization can send */ messagesProduced?: string[]; /** @description The roles an organization can have in Akeldo */ roles: string[]; }; Combination: { code?: components["schemas"]["Type"]; combinationId?: string; personRoleCombination?: components["schemas"]["SigningRole"][]; }; ErineAddress: { /** @description The first address line */ addressLine1?: string; /** @description The second address line */ addressLine2?: string; /** @description The third address line */ addressLine3?: string; postalPlace?: components["schemas"]["PostalPlace"]; }; LegalEntityRole: { role?: components["schemas"]["Code"]; electedBy?: components["schemas"]["Code"]; rolePerson?: components["schemas"]["RolePerson"]; roleOrganization?: components["schemas"]["RoleOrganization"]; }; OfficialNames: { /** @description The first official name */ officialNameLine1?: string; /** @description The second official name */ officialNameLine2?: string; /** @description The third official name */ officialNameLine3?: string; /** @description The fourth official name */ officialNameLine4?: string; /** @description The fifth official name */ officialNameLine5?: string; }; Organization: { ident: components["schemas"]["OrganizationIdent"]; /** @description The organization key */ key: string; /** @description If the organization record is active */ isActive: boolean; /** * Format: int32 * @description The organization number */ organizationNumber: number; /** @description The organization name */ name: string; officialNames?: components["schemas"]["OfficialNames"]; businessAddress?: components["schemas"]["ErineAddress"]; postalAddress?: components["schemas"]["ErineAddress"]; availability?: components["schemas"]["Code"]; /** @description The organization phone number */ phoneNumber?: string; /** @description The organization telefax number */ telefaxNumber?: string; /** @description The organization mobile phone number */ mobileNumber?: string; /** @description The organization email address */ email?: string; /** @description The organization main website */ website?: string; /** * @description If the organization han en entry in the volunteering register * @enum {string} */ volunteeringRegister?: "NO" | "YES"; /** * Format: int64 * @description The organization number of the main unit */ mainUnit?: number; businessType: components["schemas"]["Code"]; /** @description The industrial classification of this organization */ industrialClassification?: components["schemas"]["Code"][]; postalPlace?: components["schemas"]["PostalPlace"]; municipality?: components["schemas"]["MunicipalityData"]; /** @description The country this organization is placed in */ country: string; registeredDate: components["schemas"]["ApiDate"]; formedDate?: components["schemas"]["ApiDate"]; deletionDate?: components["schemas"]["ApiDate"]; akeldo?: components["schemas"]["Akeldo"]; /** @description Roles register og legal entities */ roles?: components["schemas"]["RolesRegisterOfLegalEntities"][]; signature?: components["schemas"]["Signature"]; procura?: components["schemas"]["Procura"]; supplier?: components["schemas"]["Supplier"]; links?: components["schemas"]["OrganizationLinks"]; }; OrganizationIdent: { /** * Format: int32 * @description The organization ident */ id: number; }; OrganizationItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Organization"]; }; OrganizationLinks: { self: components["schemas"]["OrganizationItemLink"]; mainUnit: components["schemas"]["OrganizationItemLink"]; root: components["schemas"]["OrganizationItemLink"]; parent: components["schemas"]["OrganizationItemLink"]; children: components["schemas"]["OrganizationListLink"]; allDescendants: components["schemas"]["OrganizationListLink"]; }; OrganizationListLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; Procura: { routineStatus?: components["schemas"]["Type"]; combinationStatus?: components["schemas"]["Type"]; ruleStatus?: components["schemas"]["Type"]; signingBasis?: components["schemas"]["SigningBasis"]; signingCombinations?: components["schemas"]["SigningCombination"]; }; RoleOrganization: { name?: string; resigned?: boolean; /** Format: int32 */ order?: number; organizationNumber?: string; businessType?: components["schemas"]["Code"]; isDeleted?: boolean; }; RolePerson: { name?: string; resigned?: boolean; /** Format: int32 */ order?: number; dateOfBirth?: components["schemas"]["ApiDate"]; givenName?: string; middleName?: string; familyName?: string; isDead?: boolean; }; RolesRegisterOfLegalEntities: { lastUpdatedDate?: components["schemas"]["ApiDate"]; roleGroup?: components["schemas"]["Code"]; roles?: components["schemas"]["LegalEntityRole"][]; }; Signature: { bankruptcy?: boolean; underLiquidation?: boolean; underForcedLiquidationOrCompulsoryDissolution?: boolean; routineStatus?: components["schemas"]["Type"]; combinationStatus?: components["schemas"]["Type"]; ruleStatus?: components["schemas"]["Type"]; signingBasis?: components["schemas"]["SigningBasis"]; signingCombinations?: components["schemas"]["SigningCombination"]; }; SignatureProcuraRoles: { freeText?: string; signingRoles?: components["schemas"]["SigningRole"][]; }; SigningBasis: { code?: components["schemas"]["Type"]; signatureProcuraRoles?: components["schemas"]["SignatureProcuraRoles"]; signingRoles?: components["schemas"]["SigningRole"][]; }; SigningCombination: { combinations?: components["schemas"]["Combination"][]; }; SigningRole: { dateOfBirth?: components["schemas"]["ApiDate"]; name?: string; role?: components["schemas"]["Type"]; }; Supplier: { /** @description Name of system that an accountant is using. Can be usbl, bblpivotal or onproperty. Only filled out for accountant resource. */ lineOfBusinessSystem?: string; /** @description Supports the Vitec Next 'Samhandling' integration with accountants. Only filled out for accountant resource. */ supportsSamhandlingAccountant?: boolean; /** @description Can supply data through Infoland */ hasIntegration?: boolean; /** @description Infoland supplier id */ supplierId?: string; supplierUpdateTime?: components["schemas"]["ApiDateTime"]; }; Type: { code?: string; description?: string; }; SimpleOrganization: { ident: components["schemas"]["OrganizationIdent"]; /** @description The organization key */ key: string; /** @description If the organization record is active */ isActive: boolean; /** * Format: int32 * @description The organization number */ organizationNumber: number; /** @description The organization name */ name: string; /** @description True if the organization is defined by Ambita (and not Brønnøysundregistrene) */ ambitaDefined: boolean; }; SimpleOrganizationListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["SimpleOrganization"][]; pagination?: components["schemas"]["Pagination"]; }; OrganizationListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Organization"][]; pagination?: components["schemas"]["Pagination"]; }; Sectioning: { ident: components["schemas"]["SectioningIdent"]; /** @description The cadastre and sectioning serial */ key: string; /** @description The numerator of the fraction of this section */ numerator: number; /** @description The denominator of the fraction of this section */ denominator: number; purposeSectioning: components["schemas"]["Code"]; links?: components["schemas"]["SectioningLinks"]; }; SectioningIdent: { cadastreIdent: components["schemas"]["CadastreIdent"]; /** * Format: int32 * @description A unique serial for the sectioning of a cadstre */ serialNumber: number; }; SectioningItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SectioningLinks: { self?: components["schemas"]["SectioningItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; }; SectioningListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Sectioning"][]; pagination?: components["schemas"]["Pagination"]; }; SectioningItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Sectioning"]; }; AddressSearch: { ident: components["schemas"]["StreetAddressIdent"]; /** @description The municipality, street, address and letter */ key: string; street?: components["schemas"]["Street"]; position?: components["schemas"]["GeoJSONFeature"]; formatted: components["schemas"]["AddressFormatted"]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; geojson?: components["schemas"]["GeoJSONObject"]; links?: components["schemas"]["AddressSearchLinks"]; }; AddressSearchLinks: { self: components["schemas"]["AddressItemLink"]; address: components["schemas"]["AddressItemLink"]; }; AddressSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["AddressSearch"][]; pagination?: components["schemas"]["Pagination"]; }; AddressListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Address"][]; pagination?: components["schemas"]["Pagination"]; }; AddressItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Address"]; }; ShareLiensCalculationItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareLiensCalculation"]; }; RightCollection: { /** @description This map contains the creation of rights by level. */ levels?: { [key: string]: components["schemas"]["RightCollectionRightsInLevel"]; }; }; RightCollectionRightsInLevel: { /** @description Heading for this level of rights */ heading: string; level: components["schemas"]["LevelCode"]; /** @description This map contains the creation of rights for this level */ rights?: { [key: string]: components["schemas"]["CreationOfRight"]; }; }; RightsItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["RightCollection"]; }; CadastreConveyanceListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CadastreConveyance"][]; pagination?: components["schemas"]["Pagination"]; }; CadastreConveyanceItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreConveyance"]; }; ShareSearch: { ident: components["schemas"]["ShareIdent"]; key: string; formattedAddress?: components["schemas"]["AddressFormatted"]; position?: components["schemas"]["GeoJSONFeature"]; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; /** @description Whether this share is active (false) or historical (true) */ isHistoricalRegisteredLand: boolean; housingCooperative: components["schemas"]["HousingCooperative"]; address: components["schemas"]["AddressSearch"]; municipality: components["schemas"]["MunicipalityData"]; links?: components["schemas"]["ShareSearchLinks"]; }; ShareSearchLinks: { self: components["schemas"]["ShareItemLink"]; share: components["schemas"]["ShareItemLink"]; owners?: components["schemas"]["PersonListLink"]; address?: components["schemas"]["AddressItemLink"]; }; ShareSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["ShareSearch"][]; pagination?: components["schemas"]["Pagination"]; }; ValidCadastresLinks: { cadastre?: components["schemas"]["CadastreItemLink"]; }; ValidateCadastre: { /** @description Tells whether the cadastre is ok */ validCadastre?: boolean; links?: components["schemas"]["ValidCadastresLinks"]; }; ValidateCadastreItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ValidateCadastre"]; }; POCGeoJSONResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; geojson?: components["schemas"]["GeoJSONFeature"]; }; POCGeoJSONResponseCollection: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; geojson?: components["schemas"]["GeoJSONFeatureCollection"]; pagination?: components["schemas"]["Pagination"]; }; CadastreOwnershipItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreOwnership"]; }; CadastreOwnershipListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CadastreOwnership"][]; pagination?: components["schemas"]["Pagination"]; }; CadastreOffice: { documentIdent: components["schemas"]["DocumentIdent"]; }; CadastreOfficeItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreOffice"]; }; DocumentIdent: { /** * Format: int32 * @description The year this document was registered */ documentYear: number; /** * Format: int32 * @description The serial number of this document */ documentNumber: number; /** * Format: int32 * @description The office number of this document */ office: number; }; Affair: { ident: components["schemas"]["AffairIdent"]; /** @description The affair key */ key: string; typeOfAffair: components["schemas"]["Code"]; landRegistryRegisteredDate: components["schemas"]["ApiDate"]; affairDocumentDate: components["schemas"]["ApiDate"]; /** @description An reference to the municipal archive */ referenceToMunicipalArchive: string; /** @description Other reference */ otherReference?: string; cadastreAffairs?: components["schemas"]["CadastreAffair"][]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["AffairLinks"]; }; AffairIdent: { /** * Format: int32 * @description The unique serialnumber of an affair */ affairSerialNumber: number; }; AffairItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; AffairLinks: { self?: components["schemas"]["AffairItemLink"]; cedingCadastres?: components["schemas"]["CadastreListLink"]; receivingCadastres?: components["schemas"]["CadastreListLink"]; affectedCadastres?: components["schemas"]["CadastreListLink"]; }; AffairListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Affair"][]; pagination?: components["schemas"]["Pagination"]; }; CadastreAffair: { cadastreIdent: components["schemas"]["CadastreIdent"]; roleInAffair: components["schemas"]["Code"]; /** * Format: double * @description The area that the cadastre has ceded, received or which has been affected by this affair */ area: number; }; AffairItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Affair"]; }; ShareExtendedItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareExtended"]; }; CadastreLiensCalculationItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreLiensCalculation"]; }; CadastreCalculationBasis: { conveyance?: components["schemas"]["CadastreHousingValueConveyance"]; area?: components["schemas"]["CadastreHousingValueArea"]; virdi?: components["schemas"]["HousingValueVirdi"]; index?: components["schemas"]["Index"]; /** * Format: int32 * @description Municipality number for the cadastre used in calculation */ municipalityNumber?: number; unitType?: components["schemas"]["Code"]; preferredCalculationMethod?: components["schemas"]["Code"]; }; CadastreHousingValue: { ident: components["schemas"]["CadastreIdent"]; key: string; /** @description Indicates if the calculation is possible */ isCalculable?: boolean; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; indexSupplier?: components["schemas"]["Code"]; indexSupplierCode?: components["schemas"]["Code"]; /** @description Fixed text describing the calculation */ calculationText?: string; calculationBasis?: components["schemas"]["CadastreCalculationBasis"]; links?: components["schemas"]["CadastreHousingValueLinks"]; }; CadastreHousingValueArea: { /** * Format: int32 * @description Number of separately occupied units */ numberOfUnits?: number; /** * Format: int32 * @description Number of buildings */ numberOfBuildings?: number; /** * Format: double * @description The sum of usable area used in calculation for each cadastre */ totalFloorSpace?: number; usedDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description Price per square meter */ pricePerSquareMeter?: number; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; /** @description The code of index region */ indexRegion?: string; /** @description The name of index region */ indexRegionName?: string; }; CadastreHousingValueConveyance: { dateRegistered?: components["schemas"]["ApiDate"]; documentCode?: components["schemas"]["Code"]; conveyanceType?: components["schemas"]["Code"]; useOfCadastre?: components["schemas"]["Code"]; dwellingType?: components["schemas"]["Code"]; /** * Format: int64 * @description The purchase price of the conveyance */ purchasePrice?: number; /** * Format: int32 * @description The number of cadastres in the conveyance */ numberOfCadastresInConveyance?: number; /** @description If the conveyance applies to entire cadastre */ appliesToEntireProperty?: boolean; conveyanceIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description The index value related to the time the conveyance occured */ conveyanceIndexValue?: number; currentIndexDate?: components["schemas"]["ApiDate"]; /** * Format: double * @description The current index value */ currentIndexValue?: number; /** @description The code of index region */ indexRegion?: string; /** @description The name of index region */ indexRegionName?: string; indexSupplier?: components["schemas"]["Code"]; indexSupplierCode?: components["schemas"]["Code"]; /** * Format: int64 * @description Calculated value */ calculatedValue?: number; }; CadastreHousingValueItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreHousingValue"]; }; CadastreHousingValueLinks: { self: components["schemas"]["CadastreHousingValueItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; conveyanceInCalculationBasis?: components["schemas"]["CadastreConveyanceItemLink"]; conveyances?: components["schemas"]["CadastreConveyanceListLink"]; addresses?: components["schemas"]["AddressListLink"]; affairs?: components["schemas"]["AffairListLink"]; buildings?: components["schemas"]["BuildingListLink"]; presentationAddress?: components["schemas"]["AddressItemLink"]; }; ConveyanceData: { dateRegistered?: components["schemas"]["ApiDate"]; documentCode?: components["schemas"]["Code"]; conveyanceType?: components["schemas"]["Code"]; useOfRealty?: components["schemas"]["Code"]; dwellingType?: components["schemas"]["Code"]; /** * Format: int64 * @description The purchase price of the conveyance */ purchasePrice?: number; /** * Format: int32 * @description The number of realties in the conveyance */ numberOfRealtiesInConveyance?: number; /** @description If the conveyance applies to entire realty */ appliesToEntireRealty?: boolean; }; HomeEquity: { ident: components["schemas"]["PersonIdent"]; /** @description The key for this resource */ key: string; /** @description The persons name */ personName: string; /** @description Indicates if the calculation is possible */ isCalculable: boolean; /** @description If not calculable, this string contains the reason */ reasonNotCalculable?: string; /** * Format: int32 * @description Number of relevant owned realties (cadastres and housing cooperative shares). Ownerships with fractions less 1/4 is not included */ ownedRealties: number; /** * Format: int32 * @description Number of owned cadastres */ ownedCadastres?: number; /** * Format: int32 * @description Number of owned housing cooperative shares */ ownedShares?: number; /** * Format: int64 * @description Calculated home equity */ calculatedHomeEquity: number; valueEstimation: components["schemas"]["ValueEstimation"]; pledge: components["schemas"]["Pledge"]; summary?: components["schemas"]["Summary"]; latestConveyance?: components["schemas"]["ConveyanceData"]; remarksOnPerson?: components["schemas"]["Risk"]; links?: components["schemas"]["HomeEquityLinks"]; }; HomeEquityItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["HomeEquity"]; }; HomeEquityLinks: { self: components["schemas"]["HomeEquityItemLink"]; person?: components["schemas"]["PersonItemLink"]; cadastreOwnerships?: components["schemas"]["CadastreOwnershipListLink"]; shareOwnerships?: components["schemas"]["ShareOwnershipListLink"]; customerScore?: components["schemas"]["CustomerScoreItemLink"]; latestConveyancePDF?: components["schemas"]["PDFItemLink"]; }; Pledge: { /** * Format: int32 * @description Number of owned realties with pledge */ ownedRealtiesWithPledge?: number; /** * Format: int32 * @description Number of owned realties without pledge */ ownedRealtiesWithoutPledge?: number; /** * Format: int64 * @description Sum pledge for the persons ownership in realties. Fractions are taken into account in the calculation. */ sumPledge: number; /** * Format: int32 * @description Number of pledges on this item */ numberOfPledges?: number; /** * Format: int64 * @description Sum of the amount on all mortgages */ sumMortgage?: number; /** * Format: int64 * @description Sum of the calculated outstanding mortgages */ sumOutstandingMortgage?: number; /** * Format: int32 * @description Number of mortgages (rights) on this item */ numberOfMortgages?: number; /** * Format: int32 * @description Number of distinct mortgagees (persons) on this item */ numberOfMortgagees?: number; /** * Format: int64 * @description Sum of the amount on all enforcements */ sumEnforcement?: number; /** * Format: int32 * @description Number or enforcements on this item */ numberOfEnforcements?: number; /** @description True if a securing bond is present */ hasPledgeSecuringBond?: boolean; /** @description True if a pledging statement is present */ hasPledgingStatement?: boolean; /** @description True if at least one mortgages is just listed */ hasListedMortgage?: boolean; /** @description True if at least one enforcement is just listed */ hasListedEnforcement?: boolean; /** @description If mortgages in this pledge have currency code <> 'NOK' */ hasMortgageWithForeignCurrency?: boolean; /** @description If enforcements in this pledge have currency code <> 'NOK' */ hasEnforcementWithForeignCurrency?: boolean; summaryCadastres?: components["schemas"]["Pledge"]; summaryShares?: components["schemas"]["Pledge"]; }; ValueEstimation: { /** * Format: int32 * @description Number of owned realties without an estimated value */ ownedRealtiesWithoutEstimatedValue: number; /** * Format: int32 * @description Number of owned realties with an estimated value */ ownedRealtiesWithEstimatedValue: number; /** * Format: int64 * @description Sum of the estimated value for the persons ownership in realties. Fractions are taken into account in the calculation. Realties without estimated value are not included. */ sumEstimatedValue: number; }; CulturalHeritage: { ident: components["schemas"]["CulturalHeritageIdent"]; /** @description The municipality, district and house serial */ key: string; /** @description The given name of the heritage */ objectName: string; siteDating?: components["schemas"]["Code"]; /** @description What function the heritage had */ originalFunction?: string; /** @description What function the heritage has, might differ from its original function */ currentFunction?: string; /** @description A description of any changes made to the heritage */ extension?: string; /** @description Whether the heritage is connected to a modification on a building, rather than the building itself */ appliesToBuildingChange?: boolean; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["CulturalHeritageLinks"]; }; CulturalHeritageIdent: { /** * Format: int32 * @description The municipality this heritage belongs to */ municipalityNumber: number; /** * Format: int32 * @description The district this heritage belongs to */ registrationDistrictNumber: number; /** * Format: int32 * @description The serial of the building heritage */ houseSerialNumber: number; }; CulturalHeritageItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CulturalHeritageLinks: { self?: components["schemas"]["CulturalHeritageItemLink"]; buildings?: components["schemas"]["BuildingListLink"]; }; CulturalHeritageListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CulturalHeritage"][]; pagination?: components["schemas"]["Pagination"]; }; CulturalHeritageItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CulturalHeritage"]; }; Municipality: { ident: components["schemas"]["MunicipalityIdent"]; /** @description The municipality name */ municipalityName: string; /** * Format: int32 * @description The region number */ regionNumber: number; /** @description The region name */ regionName: string; /** @description If this municipality is active */ isActive: boolean; links?: components["schemas"]["MunicipalityLinks"]; }; MunicipalityIdent: { /** * Format: int32 * @description A number representing a municipality */ municipalityNumber: number; }; MunicipalityItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; MunicipalityItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Municipality"]; }; MunicipalityLinks: { self?: components["schemas"]["MunicipalityItemLink"]; conveyances?: components["schemas"]["CadastreConveyanceListLink"]; }; MunicipalityListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Municipality"][]; pagination?: components["schemas"]["Pagination"]; }; ShareRisk: { /** @description Indicating whether this risk is present or not */ isPresent: boolean; /** @description A description of this risk */ description: string; /** @description A short description of this risk */ shortDescription: string; /** @description Type of object this risk is related to */ riskOnObject: string; /** @description If risk found in the Land Registry for cooperative shares, this map contains the creation of rights that is the reason for the risk. */ rights?: { [key: string]: components["schemas"]["ShareScoreRight"]; }; }; ShareScore: { ident: components["schemas"]["ShareIdent"]; /** @description The key for this resource */ key: string; /** @description Indicates if scoring for this share is possible */ isScorable?: boolean; /** @description If not scorable, this string contains the reason */ reasonNotScorable?: string; overallRisk?: components["schemas"]["Code"]; /** @description Collection of all possible high risks */ highRisks?: { [key: string]: components["schemas"]["ShareRisk"]; }; /** @description Collection of all possible medium risks */ mediumRisks?: { [key: string]: components["schemas"]["ShareRisk"]; }; /** @description Collection of all possible low risks */ lowRisks?: { [key: string]: components["schemas"]["ShareRisk"]; }; links?: components["schemas"]["ShareScoreLinks"]; }; ShareScoreItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareScore"]; }; ShareScoreLinks: { self: components["schemas"]["ShareScoreItemLinkV2"]; share?: components["schemas"]["ShareItemLink"]; liensCalculation?: components["schemas"]["ShareLiensCalculationItemLink"]; }; CoopInternal: { ident: components["schemas"]["CoopInternalIdent"]; key: string; supplierId: string; /** @description Values for this item. The label on each value depends on the format provided by the supplier */ labelValues: { [key: string]: Record; }; fixedValues: components["schemas"]["FixedValues"]; links?: components["schemas"]["CoopInternalLinks"]; }; CoopInternalIdent: { /** * Format: int32 * @description The internal id for this coop internal */ id: number; }; CoopInternalItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CoopInternalLinks: { self: components["schemas"]["CoopInternalItemLink"]; }; CoopInternalListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CoopInternal"][]; pagination?: components["schemas"]["Pagination"]; }; FixedValues: { /** * Format: int32 * @description Internal shareholder number. Can appear as Andelsnr, Kundenr or Medlemsnr in labeled values. */ internAndelshavernr?: number; /** * Format: int32 * @description Internal share number. Can appear as Andelsnummer, Bolignr, Enhet or Index in labeled values. */ internAndelsnr?: number; /** * Format: int32 * @description Internal organization number. Can appear as Klientnr, Selskapnr or Selskapsnr in labeled values. */ internOrgnr?: number; /** @description Shareholder name. Can appear as Firma or Navn in labeled values. */ andelshaverNavn?: string; /** @description Housing cooperativ name. Can appear as Klientnavn, Selskap or Selskapsnavn in labeled values. */ borettslagNavn?: string; /** @description The address. Can appear as Addresse in labeled values. */ adresse?: string; /** @description Postal number and postal place. */ postnrSted?: string; /** @description Postal number. Can appear as Postnr in labeled values. */ postnr?: string; /** @description Postal place. Can appear as Poststed in labeled values. */ poststed?: string; /** * Format: int64 * @description Public shareholder number. Can appear as IDnummer in labeled values. */ offAndelshavernr?: number; /** * Format: int32 * @description Official organization number. Can appear as Foretaknr or Organisasjonsnr in labeled values. */ offOrgnr?: number; /** @description Cadastre ident. Can appear as Matrikkel in labeled values. */ matrikkel?: string; /** @description Region ID. Can appear as Regionid in labeled values. */ regionId?: string; /** @description Has energy label (True/False). Can appear as HarEnergimerke is labeled values. */ energimerke?: string; /** @description Cadastre ident for Accountant. Can appear as EiendomsidForretningsfører in labeled values. */ eiendomsnr?: string; dokumentnr?: string; andelsnr?: string; seksjonsnr?: string; aksjeboenhetsnr?: string; selskapstype?: string; }; CoopInternalItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CoopInternal"]; }; Plot: { ident: components["schemas"]["PlotIdent"]; /** @description The internal id of the plot */ key: string; /** * Format: int32 * @description Whether this plot is active (0) or historical (1) */ eventStatus: number; /** * Format: double * @description The area of the plot */ area?: number; /** @description Notes to area */ areaNotes?: components["schemas"]["Code"][]; /** * @description If this is part of a farm commons but not registered as such * @enum {string} */ unregisteredFarmCommons?: "J" | "N"; /** * @description If it is a registered dispute for this plot * @enum {string} */ dispute?: "J" | "N"; /** * @description If this plot has a clear ownership * @enum {string} */ clarifiedOwnership?: "J" | "N"; /** * @description If this plot is connected to more than one cadastre * @enum {string} */ hasSeveralCadastreUnits?: "J" | "N"; dataCaptureDate?: components["schemas"]["ApiDate"]; position?: components["schemas"]["GeoJSONFeature"]; geojson?: components["schemas"]["GeoJSONObject"]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["PlotLinks"]; }; PlotIdent: { /** * Format: int64 * @description The internal id of the plot */ id: number; }; PlotItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; PlotLinks: { self?: components["schemas"]["PlotItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; }; PlotListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Plot"][]; pagination?: components["schemas"]["Pagination"]; }; PlotItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Plot"]; }; CadastreLandRegistry: { landRegistryUpToDate?: components["schemas"]["ApiDateTime"]; /** @description The key for the share or cadastre */ key?: string; dateConverted?: components["schemas"]["ApiDate"]; /** * @description The type of request * @enum {string} */ eventStatus?: "active" | "historical" | "active_and_historical"; formattedAddress?: components["schemas"]["AddressFormatted"]; /** @description A map with the Land Registry parts found */ parts?: { [key: string]: components["schemas"]["Part"]; }; cadastreIdent?: components["schemas"]["CadastreIdent"]; /** @description The key for the cadastre */ cadastreKey?: string; municipality?: components["schemas"]["MunicipalityData"]; links?: components["schemas"]["CadastreLandRegistryLinks"]; }; CadastreLandRegistryItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreLandRegistry"]; }; CadastreLandRegistryLinks: { self: components["schemas"]["CadastreLandRegistryItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; titles?: components["schemas"]["CadastreLandRegistryItemLink"]; encumbrances?: components["schemas"]["CadastreLandRegistryItemLink"]; monetaryEncumbrances?: components["schemas"]["CadastreLandRegistryItemLink"]; landData?: components["schemas"]["CadastreLandRegistryItemLink"]; leaseholdAgreements?: components["schemas"]["CadastreLandRegistryItemLink"]; leaseAgreements?: components["schemas"]["CadastreLandRegistryItemLink"]; easements?: components["schemas"]["CadastreLandRegistryItemLink"]; privileges?: components["schemas"]["CadastreLandRegistryItemLink"]; }; Level: { header?: string; topText?: components["schemas"]["TextLine"][]; rights: { [key: string]: components["schemas"]["CreationOfRight"]; }; }; Part: { header?: string; topText?: components["schemas"]["TextLine"][]; bottomText?: components["schemas"]["TextLine"][]; levels?: { [key: string]: components["schemas"]["Level"]; }; }; Accountant: { /** * Format: int32 * @description The organization number */ organizationNumber: number; /** @description The organization name */ name: string; /** @description The internal data suppplier id */ supplierId: string; }; AccountantHousingData: { key: string; /** * Format: int32 * @description Property number */ propertyNumber?: number; /** @description Property code */ propertyCode?: string; /** @description Property name */ propertyName?: string; /** @description Indicates if the property has an energy label */ hasEnergyLabel?: boolean; address?: components["schemas"]["HousingDataAddress"]; municipality?: components["schemas"]["HousingDataMunicipality"]; /** * @description Type of housing * @enum {string} */ housingType?: "CADASTRE" | "SHARE" | "STOCK_BOND" | "UNKNOWN"; cadastre?: components["schemas"]["HousingDataCadastre"]; share?: components["schemas"]["HousingDataShare"]; stockBond?: components["schemas"]["HousingDataShare"]; accountant?: components["schemas"]["Accountant"]; cooperative?: components["schemas"]["HousingDataCooperative"]; /** @description List of property owners */ owners?: components["schemas"]["HousingOwner"][]; links?: components["schemas"]["AccountantHousingDataLinks"]; }; AccountantHousingDataItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["AccountantHousingData"]; }; AccountantHousingDataLinks: { self: components["schemas"]["AccountantHousingDataItemLink"]; share?: components["schemas"]["ShareItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; cooperative?: components["schemas"]["OrganizationItemLink"]; }; HousingDataAddress: { /** @description Street address */ address?: string; /** @description Postal code */ postalCode?: string; /** @description Postal place */ postalPlace?: string; formatted?: components["schemas"]["AddressFormatted"]; }; HousingDataCadastre: { /** @description Unique key for the cadastre */ key: string; ident: components["schemas"]["CadastreIdent"]; }; HousingDataCooperative: { /** * Format: int32 * @description Organization number of the housing cooperative */ organizationNumber?: number; /** * Format: int32 * @description Internal ID of the housing cooperative */ internalId?: number; /** @description Name of the housing cooperative */ name?: string; /** @description Type of housing cooperative */ type?: string; /** @description Indicates if the cooperative is affiliated to a housing construction company */ isAffiliatedToHousingConstructionCompany?: boolean; /** @description Indicates if the cooperative has board approval */ hasBoardApproval?: boolean; /** @description Responsible entity for board approval */ responableBoardApproval?: string; /** @description Indicates if there is a pre-emptive right */ hasPreEmptiveRight?: boolean; /** @description Type of pre-emptive right */ typeOfPreEmptiveRight?: string; /** @description Responsible entity for clarifying pre-emptive right */ responsibleForClarififyingPreEmptiveRight?: string; }; HousingDataMunicipality: { /** * Format: int32 * @description Municipality number */ municipalityNumber?: number; /** @description Municipality name */ municipalityName?: string; }; HousingDataShare: { /** @description Share key */ key?: string; ident?: components["schemas"]["ShareIdent"]; }; HousingOwner: { /** * @description Type of housing owner * @enum {string} */ type?: "PERSON" | "ORGANIZATION" | "INTERNAL_USER"; /** @description Official number of the housing owner */ officialNumber?: string; /** @description Name of the housing owner */ name?: string; /** @description Given name of the housing owner */ givenName?: string; /** @description Family name of the housing owner */ familyName?: string; ownerType: string; }; AccountantHousingDataListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["AccountantHousingData"][]; pagination?: components["schemas"]["Pagination"]; }; ExternalLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ExternalLinkSoilContamination: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SoilContamination: { ident: components["schemas"]["SoilContaminationIdent"]; /** @description The official serial */ key: string; registeredDate: components["schemas"]["ApiDate"]; degreeOfImpactType: components["schemas"]["Code"]; /** @description A name of the location the contamination was located */ localityName: string; lastUpdatedDate: components["schemas"]["ApiDate"]; authorityType: components["schemas"]["Code"]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["SoilContaminationLinks"]; }; SoilContaminationIdent: { /** @description An official unique serial for a soil contamination */ localityNumber: string; }; SoilContaminationItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SoilContaminationLinks: { self?: components["schemas"]["SoilContaminationItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; soilContaminationWebpage?: components["schemas"]["ExternalLinkSoilContamination"]; }; SoilContaminationListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["SoilContamination"][]; pagination?: components["schemas"]["Pagination"]; }; SoilContaminationItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["SoilContamination"]; }; CadastreHousingValueListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CadastreHousingValue"][]; pagination?: components["schemas"]["Pagination"]; }; StreetListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Street"][]; pagination?: components["schemas"]["Pagination"]; }; StreetItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Street"]; }; ShareConveyanceListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["ShareConveyance"][]; pagination?: components["schemas"]["Pagination"]; }; ShareConveyanceItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareConveyance"]; }; OperatingUnit: { ident: components["schemas"]["CadastreIdent"]; key: string; municipality?: components["schemas"]["MunicipalityData"]; propertyType?: components["schemas"]["Code"]; /** * Format: int32 * @description Agricultural area in acres */ totalAgriculturalArea?: number; /** * Format: int32 * @description Area where the use is not specified in acres */ totalOtherArea?: number; /** * Format: int32 * @description Forest area in acres */ totalForestArea?: number; /** * Format: int32 * @description Full grown areas in acres */ totalFullGrownArea?: number; /** * Format: int32 * @description Cultivated area in acres */ totalCultivatedArea?: number; /** * Format: int32 * @description Pasture area in acres */ totalPastureArea?: number; /** * Format: double * @description Aggregated cadastre area for operating unit, calculated as sum of all specifiedAreas in square meters */ totalCadastreArea?: number; /** @description Organization companies connected to cadastre */ companies?: components["schemas"]["AgricultureCompany"][]; /** @description Agricultural information about this cadastre */ agriculturalUnits?: components["schemas"]["Agriculture"][]; /** @description Whether the cadastre is historical in the land registry */ isHistoricalRegisteredLand?: boolean; /** @description Whether the cadastre is historical in the technical land registry */ isHistoricalTechnicalRegisteredLand?: boolean; industryGroup?: components["schemas"]["Code"]; maxCadastreLevel?: components["schemas"]["LevelCode"]; links?: components["schemas"]["OperatingUnitLinks"]; }; OperatingUnitItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["OperatingUnit"]; }; OperatingUnitLinks: { self?: components["schemas"]["OperatingUnitItemLink"]; cadastre?: components["schemas"]["CadastreItemLink"]; }; CadastreDocumentCopyExistenceLinks: { self?: components["schemas"]["CadastreDocumentCopyExistenceItemLink"]; }; CreationOfRightCopyExistence: { ident: components["schemas"]["CreationOfRightIdent"]; key: string; exists: boolean; reasonNotExists: string; documentType: string; documentName: string; links?: components["schemas"]["CadastreDocumentCopyExistenceLinks"]; }; ShareDocumentCopyExistence: { ident: components["schemas"]["ShareDocumentIdent"]; key: string; exists: boolean; reasonNotExists: string; rights?: components["schemas"]["CreationOfRightCopyExistence"][]; links?: components["schemas"]["ShareDocumentCopyExistenceLinks"]; }; ShareDocumentCopyExistenceItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareDocumentCopyExistenceItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareDocumentCopyExistence"]; }; ShareDocumentCopyExistenceLinks: { self?: components["schemas"]["ShareDocumentCopyExistenceItemLink"]; }; ShareDocumentIdent: { /** * Format: int32 * @description The document year */ documentYear: number; /** * Format: int32 * @description The document number */ documentNumber: number; /** * Format: int32 * @description The office this document was registered in */ office?: number; }; ExternalLinkSingleHeritage: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SingleHeritage: { ident: components["schemas"]["SingleHeritageIdent"]; /** @description The unique heritage serial */ key: string; /** * Format: int32 * @description Whether this heritage is active (0) or historical (1) */ eventStatus: number; registeredDate: components["schemas"]["ApiDate"]; lastUpdatedDate: components["schemas"]["ApiDate"]; categoryCode: components["schemas"]["Code"]; heritageType: components["schemas"]["Code"]; preservationTypeCode: components["schemas"]["Code"]; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["SingleHeritageLinks"]; }; SingleHeritageIdent: { /** @description An official unique serial for a single heritage */ localityNumber: string; }; SingleHeritageItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; SingleHeritageLinks: { self?: components["schemas"]["SingleHeritageItemLink"]; buildings?: components["schemas"]["BuildingListLink"]; cadastres?: components["schemas"]["CadastreListLink"]; singleHeritageWebpage: components["schemas"]["ExternalLinkSingleHeritage"]; }; SingleHeritageListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["SingleHeritage"][]; pagination?: components["schemas"]["Pagination"]; }; SingleHeritageItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["SingleHeritage"]; }; UnregisteredOwnership: { ident: components["schemas"]["UnregisteredOwnershipIdent"]; key: string; cadastreLevel?: components["schemas"]["LevelCode"]; fraction?: components["schemas"]["Fraction"]; ownedCadastre?: components["schemas"]["CadastreReference"]; ownerType?: components["schemas"]["Code"]; owningPerson?: components["schemas"]["Person"]; owningCadastre?: components["schemas"]["CadastreReference"]; links?: components["schemas"]["UnregisteredOwnershipLinks"]; }; UnregisteredOwnershipIdent: { cadastreIdent: components["schemas"]["CadastreIdent"]; /** * Format: int32 * @description A serial for all owners of the same cadastre */ ownershipNumber: number; /** @description A string that specifies what part of the cadastre the ownership is connected to */ cadastreLevel?: string; }; UnregisteredOwnershipItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; UnregisteredOwnershipLinks: { self?: components["schemas"]["UnregisteredOwnershipItemLink"]; ownedCadastre?: components["schemas"]["CadastreItemLink"]; owningPerson?: components["schemas"]["PersonItemLink"]; owningCadastre?: components["schemas"]["CadastreItemLink"]; }; UnregisteredOwnershipListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["UnregisteredOwnership"][]; pagination?: components["schemas"]["Pagination"]; }; UnregisteredOwnershipItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["UnregisteredOwnership"]; }; CadastreSearch: { ident: components["schemas"]["CadastreIdent"]; key: string; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; /** @description Whether the cadastre is historical in the land registry */ isRegisteredLand?: boolean; /** @description Whether the cadastre is historical in the land registry */ isHistoricalRegisteredLand?: boolean; /** @description Whether the cadastre is historical in the technical land registry */ isHistoricalTechnicalRegisteredLand?: boolean; /** @description Whether the cadastre is registered in the technical land registry */ isTechnicalRegisteredLand?: boolean; /** * Format: int64 * @description A separate id to identify a cadastre in Matrikkelen */ MatrikkelenId?: number; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["CadastreSearchLinks"]; }; CadastreSearchLinks: { self: components["schemas"]["CadastreItemLink"]; cadastre: components["schemas"]["CadastreItemLink"]; owners?: components["schemas"]["PersonListLink"]; addresses?: components["schemas"]["AddressListLink"]; }; CadastreSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["CadastreSearch"][]; pagination?: components["schemas"]["Pagination"]; }; Place: { ident: components["schemas"]["PlaceIdent"]; /** @description The internal ident as string */ key: string; /** @description The name of the place */ placeName: string; /** @description The type of the place */ placeType: string; /** @description The municipality this place is located in */ municipality?: string; position?: components["schemas"]["GeoJSONFeature"]; geojson?: components["schemas"]["GeoJSONFeatureCollection"]; }; PlaceIdent: { /** @description UUID for a place, municipality and spelling */ uuid: string; /** * Format: int64 * @description Kartverkets id for this place */ id: number; }; PlaceSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Place"][]; pagination?: components["schemas"]["Pagination"]; }; Dictionary: { /** @description A map containing key/value pairs of the dictionary */ dictionary: { [key: string]: string; }; /** @description The language used in keys */ fromLanguage: string; /** @description The language used in values */ toLanguage: string; }; CadastreDocumentCopyExistence: { ident: components["schemas"]["DocumentIdent"]; key: string; exists: boolean; reasonNotExists: string; rights?: components["schemas"]["CreationOfRightCopyExistence"][]; links?: components["schemas"]["CadastreDocumentCopyExistenceLinks"]; }; CadastreDocumentCopyExistenceItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; CadastreDocumentCopyExistenceItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreDocumentCopyExistence"]; }; ShareRiskV2: { /** @description Indicating whether this risk is present or not */ isPresent: boolean; /** @description A description of this risk */ description: string; /** @description A short description of this risk */ shortDescription: string; /** @description Type of object this risk is related to */ riskOnObject: string; /** @description If risk found in the Land Registry for cooperative shares, this map contains the creation of rights that is the reason for the risk. */ levels?: { [key: string]: components["schemas"]["ShareRiskV2RightsInLevel"]; }; }; ShareRiskV2RightsInLevel: { shareLevel: components["schemas"]["LevelCode"]; rights: { [key: string]: components["schemas"]["ShareScoreRight"]; }; }; ShareScoreItemLinkV2: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ShareScoreItemResponseV2: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareScoreV2"]; }; ShareScoreV2: { ident: components["schemas"]["ShareIdent"]; /** @description The key for this resource */ key: string; /** @description Indicates if scoring for this share is possible */ isScorable?: boolean; /** @description If not scorable, this string contains the reason */ reasonNotScorable?: string; overallRisk?: components["schemas"]["Code"]; /** @description Collection of all possible high risks */ highRisks?: { [key: string]: components["schemas"]["ShareRiskV2"]; }; /** @description Collection of all possible medium risks */ mediumRisks?: { [key: string]: components["schemas"]["ShareRiskV2"]; }; /** @description Collection of all possible low risks */ lowRisks?: { [key: string]: components["schemas"]["ShareRiskV2"]; }; links: components["schemas"]["ShareScoreLinks"]; }; FloorListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Floor"][]; pagination?: components["schemas"]["Pagination"]; }; FloorItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Floor"]; }; HousingCooperativeItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["HousingCooperative"]; }; SeparatelyOccupiedUnitListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["SeparatelyOccupiedUnit"][]; pagination?: components["schemas"]["Pagination"]; }; SeparatelyOccupiedUnitItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["SeparatelyOccupiedUnit"]; }; POCItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; }; POCListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; pagination?: components["schemas"]["Pagination"]; }; Mortgagees: { /** @description The mortgagees of the right */ mortgagees?: components["schemas"]["Person"][]; /** @description The submitters of the right */ receivers?: components["schemas"]["Person"][]; /** @description The defendants of the right */ defendants?: components["schemas"]["Person"][]; /** @description The plaintiffs of the right */ plaintiffs?: components["schemas"]["Person"][]; /** @description The legal representatives of the right */ legalRepresentatives?: components["schemas"]["Person"][]; }; MortgageesItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Mortgagees"]; }; PersonListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Person"][]; pagination?: components["schemas"]["Pagination"]; }; PersonItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Person"]; }; RealtyEstateUnit: { ident: components["schemas"]["RealtyEstateUnitIdent"]; /** @description The internal id */ key: string; registeredDate?: components["schemas"]["ApiDate"]; /** @description A reference to the estate unit */ reference?: string; /** @description UUID to uniquely identify any object in Matrikkelen */ MatrikkelenUUID?: string; links?: components["schemas"]["RealtyEstateUnitLinks"]; }; RealtyEstateUnitIdent: { /** * Format: int64 * @description An internal id for a realty estate unit */ id: number; }; RealtyEstateUnitItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; RealtyEstateUnitLinks: { self?: components["schemas"]["RealtyEstateUnitItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; }; RealtyEstateUnitListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["RealtyEstateUnit"][]; pagination?: components["schemas"]["Pagination"]; }; RealtyEstateUnitItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["RealtyEstateUnit"]; }; ShareLandRegistry: { landRegistryUpToDate?: components["schemas"]["ApiDateTime"]; /** @description The key for the share or cadastre */ key?: string; dateConverted?: components["schemas"]["ApiDate"]; /** * @description The type of request * @enum {string} */ eventStatus?: "active" | "historical" | "active_and_historical"; formattedAddress?: components["schemas"]["AddressFormatted"]; /** @description A map with the Land Registry parts found */ parts?: { [key: string]: components["schemas"]["Part"]; }; shareIdent?: components["schemas"]["ShareIdent"]; /** @description The key for the cadastre */ shareKey?: string; housingCooperative?: components["schemas"]["HousingCooperative"]; links?: components["schemas"]["ShareLandRegistryLinks"]; }; ShareLandRegistryItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["ShareLandRegistry"]; }; ShareLandRegistryLinks: { self: components["schemas"]["ShareLandRegistryItemLink"]; share?: components["schemas"]["ShareItemLink"]; titles?: components["schemas"]["ShareLandRegistryItemLink"]; encumbrances?: components["schemas"]["ShareLandRegistryItemLink"]; shareInformation?: components["schemas"]["ShareLandRegistryItemLink"]; }; StreetSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Street"][]; pagination?: components["schemas"]["Pagination"]; }; ShareListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Share"][]; pagination?: components["schemas"]["Pagination"]; }; ShareItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Share"]; }; District: { ident: components["schemas"]["DistrictIdent"]; /** @description The district number, code and municipality */ key: string; /** * Format: int32 * @description Whether this district is active (0) or historical (1) */ eventStatus: number; municipality?: components["schemas"]["MunicipalityData"]; /** @description The name of the district */ districtName: string; links?: components["schemas"]["DistrictLinks"]; }; DistrictIdent: { /** * Format: int32 * @description The district number */ districtNumber: number; districtCode: components["schemas"]["Code"]; /** * Format: int32 * @description The municipality the district is contained in */ municipalityNumber: number; }; DistrictItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; DistrictLinks: { self?: components["schemas"]["DistrictItemLink"]; addresses?: components["schemas"]["AddressListLink"]; }; DistrictListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["District"][]; pagination?: components["schemas"]["Pagination"]; }; DistrictItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["District"]; }; CadastreExtendedItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["CadastreExtended"]; }; HousingCooperativeSearch: { ident: components["schemas"]["HousingCooperativeIdent"]; /** @description The organization number of the cooperative */ key: string; /** @description The name of the cooperative */ housingCooperativeName: string; extent?: components["schemas"]["Extent"]; geojson?: components["schemas"]["GeoJSONObject"]; links?: components["schemas"]["HousingCooperativeSearchLinks"]; }; HousingCooperativeSearchLinks: { self: components["schemas"]["HousingCooperativeItemLink"]; housingcooperative: components["schemas"]["HousingCooperativeItemLink"]; shares: components["schemas"]["ShareListLink"]; ownedCadastres: components["schemas"]["CadastreListLink"]; }; HousingCooperativeSearchListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["HousingCooperativeSearch"][]; pagination?: components["schemas"]["Pagination"]; }; CadastreListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Cadastre"][]; pagination?: components["schemas"]["Pagination"]; }; CadastreItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Cadastre"]; }; BuildingChange: { ident: components["schemas"]["BuildingChangeIdent"]; /** @description The building number and serial for a building change */ key: string; updatedDate?: components["schemas"]["ApiDate"]; /** * Format: int32 * @description The municipality number */ municipalityNumber: number; municipality?: components["schemas"]["MunicipalityData"]; /** * Format: int32 * @description The number of occupied units in this building change */ numberOfUnits: number; /** @description If the building has a registered elevator */ hasElevator: boolean; /** * Format: int32 * @description The number of floors in the building */ numberOfFloors: number; /** * Format: double * @description The total usable area inside the building change */ totalFloorSpace?: number; /** * Format: double * @description The total living area inside the building change */ totalAreaOfPrimarySpace?: number; /** * Format: double * @description The total area not used for living inside the building change */ areaOfSecondarySpace?: number; /** @description Whether the area is measured fully or not */ incompleteArea?: boolean; /** * Format: double * @description Area that is built on */ builtUpArea?: number; /** * Format: double * @description The total area of the building change, including walls */ totalArea?: number; /** * Format: double * @description The total area of the building change used for living */ totalAreaHousing?: number; /** * Format: double * @description The total area of the building change not used for living */ totalAlternateArea?: number; position?: components["schemas"]["GeoJSONFeature"]; buildingStatus?: components["schemas"]["Code"]; typeOfBuilding?: components["schemas"]["Code"]; industryGroup?: components["schemas"]["Code"]; waterSupplyType?: components["schemas"]["Code"]; dischargeType?: components["schemas"]["Code"]; originType?: components["schemas"]["Code"]; buildingChangeCode: components["schemas"]["Code"]; /** @description The type of heating this building primarily uses */ heatingType?: components["schemas"]["Code"][]; /** @description The type of energy source this building primarily uses */ energySourceType?: components["schemas"]["Code"][]; approvedDate?: components["schemas"]["ApiDate"]; registeredApprovedDate?: components["schemas"]["ApiDate"]; startedDate?: components["schemas"]["ApiDate"]; registeredStartedDate?: components["schemas"]["ApiDate"]; usedDate?: components["schemas"]["ApiDate"]; registeredUsedDate?: components["schemas"]["ApiDate"]; /** @description The registered floor information for this building. */ floors?: components["schemas"]["Floor"][]; /** @description The building change status history */ buildingStatusHistory?: components["schemas"]["BuildingStatusHistory"][]; links?: components["schemas"]["BuildingChangeLinks"]; }; BuildingChangeIdent: { /** * Format: int32 * @description A unique number that identifies a building */ buildingNumber: number; /** * Format: int32 * @description A serial incremented once for each building change */ buildingSerialNumber: number; buildingIdent: components["schemas"]["BuildingIdent"]; }; BuildingChangeLinks: { self?: components["schemas"]["BuildingChangeItemLink"]; building?: components["schemas"]["BuildingItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; addresses?: components["schemas"]["AddressListLink"]; units?: components["schemas"]["SeparatelyOccupiedUnitListLink"]; contacts?: components["schemas"]["PersonListLink"]; developers?: components["schemas"]["PersonListLink"]; }; BuildingChangeListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["BuildingChange"][]; pagination?: components["schemas"]["Pagination"]; }; BuildingChangeItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["BuildingChange"]; }; Complaint: { ident: components["schemas"]["ComplaintIdent"]; /** @description The internal complaint id */ key: string; /** @description A reference to a complaint document */ reference: string; /** @description A short description on what the complaint is about */ complaintConcerns: string; registeredDate: components["schemas"]["ApiDate"]; /** @description The cadastres this complaint applies to */ cadastres: components["schemas"]["CadastreReference"][]; links?: components["schemas"]["ComplaintLinks"]; }; ComplaintIdent: { /** * Format: int32 * @description The internal id of the complaint */ id: number; }; ComplaintItemLink: { /** @description The type of object you can expect when consuming this link */ rel: string; /** @description The http reference to this link */ href: string; /** @description A nickname for this link, used in the UI */ nickname?: string; /** @description The key used in this link */ key?: string; }; ComplaintLinks: { self?: components["schemas"]["ComplaintItemLink"]; cadastres?: components["schemas"]["CadastreListLink"]; }; ComplaintListResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; /** @description Contains the items you've searched for */ items?: components["schemas"]["Complaint"][]; pagination?: components["schemas"]["Pagination"]; }; ComplaintItemResponse: { error?: components["schemas"]["Error"]; info?: components["schemas"]["Info"]; item?: components["schemas"]["Complaint"]; }; Scope: { name: string; description: string; controllers: string[]; }; ScopeAccess: { /** @description A list of the resources a scope yields */ scopes: components["schemas"]["Scope"][]; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { status: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["Result"]; }; }; }; }; getCodeField: { parameters: { query?: { /** @description The language form of the content */ languageForm?: "B" | "N"; /** @description The required state of each code */ state?: "active" | "historical" | "active_and_historical"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns the codefield for the provided codefield key */ codefieldKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CodeFieldItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCodeFields: { parameters: { query?: { /** @description The language form of the content */ languageForm?: "B" | "N"; /** @description The required state of each code */ state?: "active" | "historical" | "active_and_historical"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CodeFieldListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getRight: { parameters: { query?: { /** @description Include details about this CreationOfRight */ includeDetails?: boolean; /** @description Include formatted data for this CreationOfRight */ includeFormatted?: boolean; /** @description Include relatedRights for this CreationOfRight */ includeRelatedRights?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Creation of right key */ rightKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CreationOfRightItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listRightsByDocument: { parameters: { query?: { /** @description Include details about this CreationOfRight */ includeDetails?: boolean; /** @description Include formatted data for this CreationOfRight */ includeFormatted?: boolean; /** @description Include relatedRights for this CreationOfRight */ includeRelatedRights?: boolean; /** @description Filter on the state of the rights */ state?: "active" | "historical" | "active_and_historical"; /** @description Mixed csv-list of document types (eg. OB_OBL), document codes (eg. OBL) or right types (eg. OB). Example 'OB_OBL, AH, ERK' */ documentTypes?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Document key */ documentKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CreationOfRightsListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingsByCadastre: { parameters: { query?: { /** @description Include sections */ includeSections?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingsByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingsBySingleHeritage: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Single heritage key */ singleHeritageKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuildingByUnit: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Separately occupied unit key */ unitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingsByCulturalHeritage: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cultural heritage key */ culturalHeritageKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuildingByBuildingChange: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuildingByShare: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuilding: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns building for provided official id */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildings: { parameters: { query?: { /** @description Returns buildings for provided single heritage key */ singleHeritageKey?: string; /** @description Returns buildings for provided cadastre key */ cadastreKey?: string; /** @description Returns buildings for provided cultural heritage key */ culturalHeritageKey?: string; /** @description Returns buildings for provided separately occupied unit key */ unitKey?: string; /** @description DEPRECATED. Returns buildings for provided address id */ addressId?: string; /** @description Returns buildings for provided address key */ addressKey?: string; /** @description Returns buildings for provided floor id */ floorId?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForPersonsV2: { parameters: { query: { /** @description Free text search */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** * @description Filter by postal code * @example 0010 */ postalCode?: string; /** @description Returns persons for provided type (F - Official person, L - Unofficial person, S - Organization) */ byType?: "F" | "L" | "S"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Filter out persons without a property (not filtered if false) */ hasProperty?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShareOwnershipsByShare: { parameters: { query?: { /** @description Returns ownerships having the max share level */ onlyMaxShareLevel?: boolean; /** @description Filter on state */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShareOwnershipsByPerson: { parameters: { query?: { /** @description Returns ownerships having the max share level */ onlyMaxShareLevel?: boolean; /** @description Filter on state */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Person key, can be both anonymous person id, personal number and organization number */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareOwnership: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns ownership for provided official id */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareOwnershipItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getLoggedInUser: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UserItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreObjectScore: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns cadastre score for provided official id
Example of official id for cadastre '1201-10-650-0-0' */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreScoreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHistoricalTitleSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHistoricalMortgageSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHistoricalShareInfoPDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPersonsOwnings: { parameters: { query?: { /** @description Only include ownerships with maximum cadastre/share level */ onlyMaxLevel?: boolean; /** @description Include persons in response */ includePersons?: boolean; /** @description Ignore interpretation faults */ ignoreInterpretationFaults?: boolean; /** @description The minimum ownership percentage to be included (0-100) */ minimumOwnershipPct?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns persons ownings for supplied personKeys */ personKeys: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonsOwningsItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCustomerScoreCoOwner: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns coowner for supplied personKey */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CustomerScoreCoOwnerItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareHousingValue: { parameters: { query?: { /** @description Round estimated value to nearest thousand */ roundEstimates?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareHousingValueItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantOrganizationForCooperative: { parameters: { query?: { /** @description Include information from Brønnøysund */ includeBrreg?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official organization key for Housing Cooperative/ Corporation */ organizationKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantOrganizationForCadastre: { parameters: { query?: { /** @description Include information from Brønnøysund */ includeBrreg?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantOrganizationForShare: { parameters: { query?: { /** @description Include information from Brønnøysund */ includeBrreg?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; simplelistOrganizations: { parameters: { query?: { /** @description The organization industry code(s) separated by ',' */ industryCode?: string; /** @description Include the sub unit */ includeSubUnits?: "true"; /** @description Specify sub unit types. exclude to get all. Including this sets includeSubUnits to true. */ subUnitTypes?: "ORGL" | "BEDR"; /** @description Filter on the state of the organizations */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SimpleOrganizationListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOrganization: { parameters: { query?: { /** @description Include information from Brønnøysund */ includeBrreg?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official organization key */ organizationKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOrganizations: { parameters: { query?: { /** @description Will return all children of given organization. You cannot set industry code at the same time. */ parentOrganizationKey?: string; /** @description Include all descendants or just one level of children */ includeAllDescendants?: "false" | "true"; /** @description The organization industry code(s) separated by ',' */ industryCode?: string; /** @description Include the sub unit */ includeSubUnits?: "true"; /** @description Specify sub unit types. exclude to get all. Including this sets includeSubUnits to true. */ subUnitTypes?: "ORGL" | "BEDR"; /** @description Include information from Brønnøysund */ includeBrreg?: "true"; /** @description Filter on the state of the organizations */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getRootOrganization: { parameters: { query?: { /** @description Include information from Brønnøysund */ includeBrreg?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official organization key */ organizationKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OrganizationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSectioningsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SectioningListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSectioning: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns sectioning for provided official id */ sectioningKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SectioningItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSectionings: { parameters: { query?: { /** @description Returns sectionings for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SectioningListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForAddressesV: { parameters: { query: { /** @description Free text search */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Optional parameter to search addresses by street key */ streetKey?: string; /** @description Optional parameter to search only by exact address number (if not exact matches found, partial results will be returned) */ exactAddressNumber?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesByBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesByBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building Change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesByStreet: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Street key */ streetKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesByDistrict: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Street key */ districtKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAddressByUnit: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Separately occupied unit key */ unitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddressesNearPosition: { parameters: { query?: { /** @description Max distance */ maxDistance?: number; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; /** @description Geodetic datum in response. If not provided the inputDatum will be the default. */ datum?: "UTM33" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description X/ easting */ x: number; /** @description Y/ northing */ y: number; /** @description The positions geodetic datum */ inputDatum: "UTM33" | "WGS84"; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPresentationAddressByCadastre: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAddressByShare: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Housing cooperative share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAddress: { parameters: { query?: { /** @description The provided id is interpreted as a database id */ searchByDatabaseId?: boolean; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns address for provided official id or database id */ addressId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAddresses: { parameters: { query?: { /** @description Returns addresses for provided cadastre key */ cadastreKey?: string; /** @description Returns addresses for provided share key */ shareKey?: string; /** @description Returns addresses for provided building key */ buildingKey?: string; /** @description Returns addresses for provided building change key */ buildingChangeKey?: string; /** @description Returns addresses for provided separately occupied unit key */ unitKey?: string; /** @description Returns addresses for provided district key */ districtKey?: string; /** @description Returns addresses for provided street key */ streetKey?: string; /** @description Returns addresses for provided street number */ streetNumber?: string; /** @description Returns addresses for provided street name */ streetName?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AddressListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareLiensCalculation: { parameters: { query?: { /** @description Returns liens calculation having the max share level */ onlyMaxShareLevel?: boolean; /** @description Ignore interpretation faults */ ignoreInterpretationFaults?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareLiensCalculationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getRightsForShare: { parameters: { query: { /** @description What group of rights to filter on */ group: "avtaler" | "heftelser" | "hjemmel" | "uraadigheter"; /** @description Filter on the share's max share-level */ onlyMaxShareLevel?: boolean; /** @description Include details for each right */ includeDetails?: boolean; /** @description Include formatted data for each right */ includeFormatted?: boolean; /** @description Include relatedRights for each right */ includeRelatedRights?: boolean; /** @description Filter on the state of the rights */ state?: "active" | "historical" | "active_and_historical"; /** @description Keep only rights registered or remarked after provided time. Format 1: ISO 8601 with offset 2020-12-09T22:00:43.259+02 Format 2: ISO 8601 in UTC 2020-12-09T22:00:43.259Z Format 3: Local datetime in CET timezone 2020-12-09T22:00:43.259 */ registeredOrRemarkedAfterTime?: string; /** @description Which statuses to include. All are included by default */ includeDocumentStatuses?: "IK" | "KO" | "UK" | "FJ" | "NE" | "NP" | "RE"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["RightsItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastreConveyancesByCadastre: { parameters: { query?: { /** @description Returns conveyances for a cadastre with max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns conveyances from free market only */ freeMarketOnly?: boolean; /** @description Sort results by date in descending order */ sortByDateDescending?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreConveyanceListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastreConveyancesByPoc: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns conveyances from free market only */ freeMarketOnly?: boolean; /** @description Sort results by date in descending order */ sortByDateDescending?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Poc key */ pocKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreConveyanceListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreConveyance: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns conveyance for provided conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreConveyanceItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForShares: { parameters: { query: { /** @description Free text search
Example for housing cooperative shares 'SMIBERG 7' - finds housing cooperative shares starting with provided name and share number */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; validateCadastre: { parameters: { query?: { /** @description Include info messages like previous cadastre */ includeInfo?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ValidateCadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPlotPolygonsByPosition: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description X/ easting */ x: number; /** @description Y/ northing */ y: number; /** @description Geodetic datum */ datum: "UTM33" | "WGS84"; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["Result"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPolygonsByCadastre: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["Result"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPocGeoJSON: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns POC for provided POC id */ pocId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["POCGeoJSONResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPocsGeoJSON: { parameters: { query: { /** @description Minimum easting for provided extent */ eastingMin: number; /** @description Minimum northing for provided extent */ northingMin: number; /** @description Maximum easting for provided extent */ eastingMax: number; /** @description Maximum northing for provided extent */ northingMax: number; /** @description From date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD) */ fromDate?: string; /** @description To date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD) */ toDate?: string; /** @description Usage of ground
Use a combination of three characters: 'B' for residential or 'F' for recreational or 'A' for other */ groundUsage?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns conveyances from free market only */ freeMarketOnly?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["POCGeoJSONResponseCollection"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreOffice: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns documentIdent for provided document key */ cadastreDocumentKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreOfficeItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAffairsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AffairListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAffair: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns affair for provided official id */ affairKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AffairItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listAffairs: { parameters: { query?: { /** @description Returns affairs for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AffairListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareExtended: { parameters: { query?: { /** @description Only include ownerships with maximum share level */ onlyMaxShareLevel?: boolean; /** @description Ignore interpretation faults */ ignoreInterpretationFaults?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Get extended information about a share */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareExtendedItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreLiensCalculation: { parameters: { query?: { /** @description Filter on the cadastre's max cadastre-level */ onlyMaxCadastreLevel?: boolean; /** @description Ignore interpretation faults */ ignoreInterpretationFaults?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreLiensCalculationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHomeEquityByPerson: { parameters: { query?: { /** @description Round estimated value to nearest thousand */ roundEstimates?: boolean; /** @description Fetch ownerships with state */ includeOwnershipCountWithState?: "active" | "historical" | "active_and_historical"; /** @description Returns ownerships for a cadastre with max cadastre level */ onlyMaxCadastreLevel?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9 */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["HomeEquityItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCulturalHeritagesByBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CulturalHeritageListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCulturalHeritage: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns cultural heritage for provided official id */ culturalHeritageKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CulturalHeritageItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCulturalHeritages: { parameters: { query?: { /** @description Returns cultural heritages for provided building key */ buildingKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CulturalHeritageListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getMunicipality: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns municipality for provided official id */ municipalityKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["MunicipalityItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMunicipalities: { parameters: { query?: { /** @description Returns municipalities for provided region name */ municipalityName?: string; /** @description Returns municipalities for provided region number */ regionNumber?: string; /** @description Filter on the state of the municipalities */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["MunicipalityListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareObjectScore: { parameters: { query?: { /** @description Returns share score having the max share level */ onlyMaxShareLevel?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns share score for provided official id
Example of official id for share '948946645-2' */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareScoreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCoopInternalsForCadastre: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CoopInternalListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCoopInternalsForShare: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CoopInternalListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCoopInternal: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns coop internal for provided official id */ coopInternalKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CoopInternalItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCoopInternals: { parameters: { query?: { /** @description Returns coop internals related to an owner with the provided official number (personalNumber or organizationNumber) */ ownerOfficialNumber?: string; /** @description Returns coop internals related to an owner with provided internal person key */ ownerKey?: string; /** @description Returns coop internals related to the cooperative holder with the provided key (organizationNumber) */ cooperativeKey?: string; /** @description Returns coop internals related to the cooperative holder with the provided share number */ shareNumber?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CoopInternalListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreRight: { parameters: { query: { /** @description What group of rights to filter on */ group: "leieavtaler" | "grunndata" | "heftelser" | "hjemmel" | "paategning_paa_eiere" | "uraadigheter" | "frivillig_pant" | "tvangsforretninger" | "rettigheter" | "festeavtaler" | "servitutter"; /** @description Filter on the share's max cadastre-level */ onlyMaxCadastreLevel?: boolean; /** @description Include details for each right */ includeDetails?: boolean; /** @description Include formatted data for each right */ includeFormatted?: boolean; /** @description Include relatedRights for each right */ includeRelatedRights?: boolean; /** @description Filter on the state of the rights */ state?: "active" | "historical" | "active_and_historical"; /** @description Keep only rights registered or remarked after provided time. Format 1: ISO 8601 with offset 2020-12-09T22:00:43.259+02 Format 2: ISO 8601 in UTC 2020-12-09T22:00:43.259Z Format 3: Local datetime in CET timezone 2020-12-09T22:00:43.259 */ registeredOrRemarkedAfterTime?: string; /** @description Which statuses to include. All are included by default */ includeDocumentStatuses?: "IK" | "KO" | "UK" | "FJ" | "NE" | "NP" | "RE"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["RightsItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlotsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PlotListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPlot: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns plot for provided official id */ plotKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PlotItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlots: { parameters: { query?: { /** @description Returns plots for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PlotItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreLandRegistry: { parameters: { query: { /** @description Comma separated list of which parts of the Land Registy report should be included. If parameter is not supplied, a complete report will be generated */ parts: "grunndata" | "heftelser" | "hjemmel" | "festeavtaler" | "leieavtaler" | "pengeheftelser" | "rettigheter" | "servitutter" | "alle" | "alle_med_rettigheter"; /** @description Filter on the state of the rights in report */ state?: "active" | "historical" | "active_and_historical"; /** @description Include details for each right */ includeDetails?: boolean; /** @description Include formatted data for each right */ includeFormatted?: boolean; /** @description Include formatted address */ includeAddress?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreLandRegistryItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantHousingDataByCadastre: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key identifying the housing - Cadastre key (4601-12-123-0-1) */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AccountantHousingDataItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantHousingDataByShare: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key identifying the housing - Share key (987654321-12) */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AccountantHousingDataItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantHousingDataOfficialKey: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key identifying the housing - Cadastre key (4601-12-123-0-1), Share key (987654321-12) or Stock bond key (123456789-12) */ housingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AccountantHousingDataItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getAccountantHousingData: { parameters: { query?: { /** @description Internal key for the owning person/ organization */ ownerKey?: string; /** @description Personal number/ organization number for the owning person/ organization */ ownerOfficialNumber?: string; /** @description Organization number for the cooperative */ cooperativeOrganizationNumber?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["AccountantHousingDataListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSoilContaminationsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SoilContaminationListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSoilcontamination: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns soil contamination for provided official id */ soilContaminationKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SoilContaminationItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSoilContaminations: { parameters: { query?: { /** @description Returns soil contamination items for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SoilContaminationListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSurroundingCadastreHousingValues: { parameters: { query?: { /** @description Radius */ radius?: number; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreHousingValueListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreHousingValue: { parameters: { query?: { /** @description Round estimated value to nearest thousand */ roundEstimates?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreHousingValueItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listStreetsByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["StreetListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listStreetsByDistrict: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description District key */ districtKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["StreetListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getStreet: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns street for provided official id */ streetKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["StreetItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listStreets: { parameters: { query?: { /** @description Returns streets for provided district key */ districtKey?: string; /** @description Returns street for provided address key */ addressKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["StreetListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOwnershipsByCadastre: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Filter on state */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOwnershipsOwnedByThisCadastre: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Filter on state */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Owned by this cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOwnershipsByPerson: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Filter on state */ state?: "active" | "historical" | "active_and_historical"; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Person key, can be both anonymous person id, personal number and organization number */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Request entity too large */ 413: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreOwnership: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns ownership for provided official id */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreOwnershipItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShareConveyancesByPoc: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Conveyances from free market only */ freeMarketOnly?: boolean; /** @description Sort by date in descending order */ sortByDateDescending?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Poc key */ pocKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareConveyanceListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShareConveyancesByShare: { parameters: { query?: { /** @description Returns conveyances having the max share level */ onlyMaxShareLevel?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Conveyances from free market only */ freeMarketOnly?: boolean; /** @description Sort by date in descending order */ sortByDateDescending?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareConveyanceListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareConveyance: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns conveyance for provided conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareConveyanceItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOperatingUnitByCadastre: { parameters: { query?: { /** @description The required state of each code */ state?: "active" | "historical" | "active_and_historical"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns operating unit by provided any cadastre id */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OperatingUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOperatingUnit: { parameters: { query?: { /** @description The required state of each code */ state?: "active" | "historical" | "active_and_historical"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns operating unit by provided main cadastre id */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["OperatingUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareDocumentCopyExistence: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns document copy existence for provided document year and document number (document year - document number) */ shareDocumentKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareDocumentCopyExistenceItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSingleHeritagesByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SingleHeritageListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSingleHeritagesByBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SingleHeritageListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSingleHeritage: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns single heritage for provided official id */ singleHeritageKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SingleHeritageItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSingleHeritages: { parameters: { query?: { /** @description Returns single heritages for provided building key */ buildingKey?: string; /** @description Returns single heritages for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SingleHeritageListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnregisteredOwnershipsByCadastre: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Include tax roles */ includeTaxRoles?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; callback?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UnregisteredOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnregisteredOwnershipsOwnedByCadastre: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Include tax roles */ includeTaxRoles?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; callback?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Owned by this cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UnregisteredOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnregisteredOwnershipsByPerson: { parameters: { query?: { /** @description Returns ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Include tax roles */ includeTaxRoles?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; callback?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Person key */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UnregisteredOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getUnregisteredOwnership: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns unregistered ownership for provided official id */ unregisteredOwnershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UnregisteredOwnershipItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnregisteredOwnerships: { parameters: { query?: { /** @description Returns unregistered ownerships owned by provided cadastre key */ ownedByCadastreKey?: string; /** @description Returns unregistered ownerships for provided cadastre key */ ownedCadastreKey?: string; /** @description Returns unregistered ownerships for provided person key */ personKey?: string; /** @description Returns unregistered ownerships having the max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Include tax roles */ includeTaxRoles?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["UnregisteredOwnershipListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastrePDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastrePDFByCadastreWithPrivileges: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastrePDFByCadastreWithLeaseholdOwners: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForCadastres: { parameters: { query: { /** @description Free text search
Example for cadastre '4601 10 3' - finds cadastres starting with provided official id (matrikkel id) */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForPlacesV2: { parameters: { query: { /** @description Free text search */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PlaceSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; dictionary: { parameters: { query: { /** @description Select the language to be used as keys in the dictionary map */ languageFrom: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["Dictionary"]; }; }; }; }; getCadastreDocumentCopyExistence: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns document copy existence for office number or municipality number - document year - document number '200-2010-650' or 'K4601-2010-650' */ cadastreDocumentKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreDocumentCopyExistenceItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareObjectScoreV2: { parameters: { query?: { /** @description Returns share score having the max share level */ onlyMaxShareLevel?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns share score for provided official id
Example of official id for share '948946645-2' */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareScoreItemResponseV2"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listFloorsByBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["FloorListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listFloorsByBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["FloorListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getFloor: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns floor for provided official id */ floorKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["FloorItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listFloors: { parameters: { query?: { /** @description Returns floors for provided building key */ buildingKey?: string; /** @description Returns floors for provided building change key */ buildingChangeKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["FloorListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHousingCooperative: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns housing cooperative for provided official id */ housingCooperativeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["HousingCooperativeItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listRightsForPerson: { parameters: { query: { /** @description What group of rights to filter on */ group: "hjemmel" | "heftelser"; /** @description Filter on the state of the rights */ state?: "active" | "historical" | "active_and_historical"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Person key */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CreationOfRightsListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnitsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnitsByBuilding: { parameters: { query: { /** @description Cadastre key */ cadastreKey: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnitsByBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnitsByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getUnitByShare: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getUnit: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns separately occupied unit for provided official id */ separatelyOccupiedUnitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listUnits: { parameters: { query?: { /** @description Returns separately occupied units for provided building key */ buildingKey?: string; /** @description Returns separately occupied units for provided building change key */ buildingChangeKey?: string; /** @description Returns separately occupied units for provided cadastre key */ cadastreKey?: string; /** @description Returns separately occupied units for provided share key */ shareKey?: string; /** @description DEPRECATED. Returns separately occupied units for provided address id */ addressId?: string; /** @description Returns separately occupied units for provided address key */ addressKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["SeparatelyOccupiedUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPoc: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns POC for provided POC id */ pocId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["POCItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPocs: { parameters: { query: { /** @description Minimum easting for provided extent */ eastingMin: number; /** @description Minimum northing for provided extent */ northingMin: number; /** @description Maximum easting for provided extent */ eastingMax: number; /** @description Maximum northing for provided extent */ northingMax: number; /** @description From date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD) */ fromDate?: string; /** @description To date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD) */ toDate?: string; /** @description Usage of ground
Use a combination of three characters: 'B' for residential or 'F' for recreational or 'A' for other */ groundUsage?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns conveyances from free market only */ freeMarketOnly?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["POCListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCurrentMortgagees: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Creation of right key */ rightKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["MortgageesItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listResidentsOfAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOwnersOfCadastre: { parameters: { query?: { /** @description Returns persons who owns the cadastre with max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listOwnersOfShare: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuyersOfConveyanceOfCadastres: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSellersOfConveyanceOfCadastres: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuyersOfConveyanceOfShares: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSellersOfConveyanceOfShares: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDevelopersOfBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactsOfBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDevelopersOfBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactsOfBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOwnerOfOwnershipOnCadastres: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Ownership key */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOwnerOfOwnershipOnShares: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Ownership key */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getPerson: { parameters: { query?: { /** @description Filter person without a property (not filtered if false) */ hasProperty?: boolean; /** @description Fetch ownerships with state */ includeOwnershipCountWithState?: "active" | "historical" | "active_and_historical"; /** @description Returns ownerships for a cadastre with max cadastre level */ onlyMaxCadastreLevel?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9 */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPersons: { parameters: { query?: { /** @description Returns persons who owns the cadastre for provided cadastre key, for example (1201-10-1-0-0) */ ownsCadastreKey?: string; /** @description Returns persons who owns the share for provided share key, for example (948946645-1) */ ownsShareKey?: string; /** @description Returns persons who participated in a conveyance of cadastre for provided conveyance key */ conveyanceOfCadastreKey?: string; /** @description Returns persons who participated in a conveyance of share for provided conveyance key */ conveyanceOfShareKey?: string; /** @description Returns persons who participated in building construction for provided building key */ buildingKey?: string; /** @description Returns persons who participated in building construction for provided building change key */ buildingChangeKey?: string; /** @description Returns persons of specified role who participated in a conveyance (seller, purchaser) or building construction (constructor, developer) */ role?: string; /** @description Returns persons who owns the cadastre with max cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["PersonListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listRealtyEstateUnitsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["RealtyEstateUnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getRealtyEstateUnit: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns realty estate unit for provided official id */ realtyEstateUnitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["RealtyEstateUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getRealtyEstateUnitByCadastre: { parameters: { query?: { /** @description Returns realty estate units for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["RealtyEstateUnitItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getLandRegistryForShare: { parameters: { query?: { /** @description Comma separated list of which parts of the Land Registy report should be included. */ parts?: "hjemmel" | "heftelser" | "andelsopplysninger"; /** @description Filter on the state of the rights in report */ state?: "active" | "historical" | "active_and_historical"; /** @description Include details for each right */ includeDetails?: boolean; /** @description Include formatted data for each right */ includeFormatted?: boolean; /** @description Include formatted address */ includeAddress?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareLandRegistryItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCustomerScore: { parameters: { query?: { /** @description Only retrieve data for given number of years */ yearsOfHistory?: number; /** @description What to focus on */ focus?: "person" | "object"; /** @description Filter on state */ state?: "active" | "active_and_historical"; /** @description Evaluate score as of date (yyyy-MM-dd). Defaults to today if omitted */ toDate?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9 */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CustomerScoreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSimpleMapPDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getMapPDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForStreetsV2: { parameters: { query: { /** @description Free text search */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum (currently not in use) */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["StreetSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesByPoc: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns shares from free market only */ freeMarketOnly?: boolean; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Poc key */ pocKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesByConveyance: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShareByOwningPerson: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Owned by person key */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareByUnit: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Separately occupied unit key */ unitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesByCooperative: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cooperative key */ cooperativeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareByOwnership: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Ownership key */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSharesNearbyPosition: { parameters: { query?: { /** @description Max distance */ maxDistance?: number; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Geodetic datum in response. If not provided the inputDatum will be the default. */ datum?: "UTM33" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description X/ easting */ x: number; /** @description Y/ northing */ y: number; /** @description The positions geodetic datum */ inputDatum: "UTM33" | "WGS84"; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShare: { parameters: { query?: { /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns share for provided official id
Example of official id for housing cooperative share '948946645-2' */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listShares: { parameters: { query?: { /** @description Returns shares owned by person for provided person key */ ownedByPersonKey?: string; /** @description DEPRECATED. Returns shares for provided address id */ addressId?: string; /** @description Returns shares for provided address key */ addressKey?: string; /** @description Returns shares for provided poc id */ pocId?: string; /** @description Returns shares for provided conveyance key */ conveyanceKey?: string; /** @description Returns shares for provided cooperative key */ cooperativeKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns shares from free market only */ freeMarketOnly?: boolean; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ShareListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDistrictsByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["DistrictListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDistrictsByStreet: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Street key */ streetKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["DistrictListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getDistrict: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns district for provided official id */ districtKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["DistrictItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDistricts: { parameters: { query?: { /** @description DEPRECATED. Returns districts for provided address id */ addressId?: string; /** @description Returns districts for provided address key */ addressKey?: string; /** @description Returns districts for provided street key */ streetKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["DistrictListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreExtended: { parameters: { query?: { /** @description Only include ownerships with maximum cadastre level */ onlyMaxCadastreLevel?: boolean; /** @description Ignore interpretation faults */ ignoreInterpretationFaults?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Get extended information about a cadastre */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreExtendedItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHistoricalCadastrePDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getHistoricalSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOldCadastrePDFByCadastre: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchForHousingCooperatives: { parameters: { query: { /** @description Free text search
Search using housing cooperative name or organization number */ query: string; /** * @description Filter by municipality number * @example 4601 */ municipalityKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include positions in the result */ positions?: boolean; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["HousingCooperativeSearchListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastreCoordinates: { parameters: { query?: { /** @description Include interiors */ includeInteriors?: boolean; /** @description Return file format */ format?: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns cadastre for provided official id
Example of official id for cadastre '1201-10-650-0-0' */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["Result"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getTitleSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getMortgageSharePDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareInfoPDFByShare: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getShareRightPDFByRight: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Right key */ shareRightKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreRightPDFByRight: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Right key */ cadastreRightKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getTechnicalPDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getSimpleTechnicalPDFByCadastre: { parameters: { query: { /** @description Infoland order key */ infolandOrderKey: string; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string[]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByPoc: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns cadastres from free market only */ freeMarketOnly?: boolean; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Poc key */ pocKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByBuilding: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByBuildingChange: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building change key */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByAddress: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Address key */ addressKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByStreet: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Street key */ streetKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByConveyance: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Conveyance key */ conveyanceKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByOwningPerson: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Person key */ personKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresBySingleHeritage: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Single heritage key */ singleHeritageKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMainCadastresBySection: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre section key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresBySoilContamination: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Soil contamination key */ soilContaminationKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByComplaint: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Complaint key */ complaintKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresBySectioning: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Sectioning key */ sectioningKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByPlot: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Plot key */ plotKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByRealtyEstateUnit: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Realty estate unit key */ realtyEstateUnitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByAffair: { parameters: { query: { /** @description The cadastres role in provided affair */ roleInAffair: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Affair key */ affairKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreByUnit: { parameters: { query?: { /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Separately occupied unit key */ unitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastreByLandLotForShare: { parameters: { query?: { /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Share key */ shareKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOwnedCadastreByOwnership: { parameters: { query?: { /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Ownership key */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getOwningCadastreByOwnership: { parameters: { query?: { /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Ownership key */ ownershipKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastresByPosition: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Geodetic datum in response. If not provided the inputDatum will be the default. */ datum?: "UTM33" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description X/ easting */ x: number; /** @description Y/ northing */ y: number; /** @description Geodetic datum */ inputDatum: "UTM33" | "WGS84"; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastreSectionsForCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns cadastre for provided official id, only works for cadastres that can be sectioned
Example of official id for cadastre '1201-10-650-0-0' */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getCadastre: { parameters: { query?: { /** @description Set the geodetic datum */ datum?: "UTM" | "WGS84"; /** @description Include extra fields */ includeExtraFields?: true | false; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns cadastre for provided official id
Example of official id for cadastre '4601-10-650-0-0'. Also supports using id and uuid. */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listCadastres: { parameters: { query?: { /** @description Returns cadastres owned by person for provided person key */ ownedByPersonKey?: string; /** @description DEPRECATED. Returns cadastres for provided address id */ addressId?: string; /** @description Returns cadastres for provided address key */ addressKey?: string; /** @description Returns cadastres for provided poc id */ pocId?: string; /** @description Returns cadastres for provided conveyance key */ conveyanceKey?: string; /** @description Returns cadastres for provided building key */ buildingKey?: string; /** @description Returns cadastres for provided building change key */ buildingChangeKey?: string; /** @description Returns cadastres for provided single heritage key */ singleHeritageKey?: string; /** @description Returns cadastres for provided soil contamination id */ soilContaminationId?: string; /** @description Returns cadastres for provided complaint key */ complaintKey?: string; /** @description Returns cadastres for provided sectioning id */ sectioningId?: string; /** @description Returns cadastres for provided plot key */ plotKey?: string; /** @description Returns cadastres for provided realty estate unit key */ realtyEstateUnitKey?: string; /** @description Returns cadastres for provided affair key */ affairKey?: string; /** @description Returns cadastres for provided street key */ streetKey?: string; /** @description Returns main-cadastres for the provided cadastre-section key */ mainCadastresBySectionKey?: string; /** @description Returns cadastres for specified role who participated in provided affair */ roleInAffair?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; /** @description Returns cadastres from free market only */ freeMarketOnly?: boolean; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["CadastreListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingChangesByCadastre: { parameters: { query?: { /** @description Only include changes under construction */ onlyIncludeUnderConstruction?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingChangesByBuilding: { parameters: { query?: { /** @description Only include changes under construction */ onlyIncludeUnderConstruction?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description building key */ buildingKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuildingChangeByUnit: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Separately occupied unit key */ unitKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deprecatedGetBuildingChange: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Building key */ buildingKey: string; /** @description Returns building change for provided building version */ version: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getBuildingChange: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns building change for provided official id */ buildingChangeKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBuildingChanges: { parameters: { query?: { /** @description Returns building changes for provided building key */ buildingKey?: string; /** @description Returns building changes for provided cadastre key */ cadastreKey?: string; /** @description Only include changes under construction */ onlyIncludeUnderConstruction?: boolean; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["BuildingChangeListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listComplaintsByCadastre: { parameters: { query?: { /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Cadastre key */ cadastreKey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ComplaintListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getComplaint: { parameters: { query?: never; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path: { /** @description Returns complaint for provided official id */ complaintKey: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ComplaintItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listComplaints: { parameters: { query?: { /** @description Returns complaints for provided cadastre key */ cadastreKey?: string; /** @description Start from page */ page?: number; /** @description Number of rows per page */ pagesize?: number; }; header?: { /** @description Token for logged in user. */ Authorization?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ComplaintListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; scope: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ScopeAccess"]; }; }; }; }; }