{
"swagger" : "2.0",
"info" : {
"description" : "API for EDR REST service",
"version" : "1.0",
"title" : "Realty",
"contact" : {
"name" : "info@ambita.com"
},
"license" : {
"name" : "",
"url" : "http://licenseUrl"
}
},
"host" : "api.ambita.com",
"basePath" : "/realty/",
"tags" : [ {
"name" : "Persons"
}, {
"name" : "Accountant Housing Data"
}, {
"name" : "PDF Orders"
}, {
"name" : "Cadastre Liens Calculations"
}, {
"name" : "Addresses"
}, {
"name" : "Customer Scores"
}, {
"name" : "Deprecated"
}, {
"name" : "Affairs"
}, {
"name" : "CadastreExtended"
}, {
"name" : "CustomerScoreCoOwner"
}, {
"name" : "Coop Internals"
}, {
"name" : "Geometries"
}, {
"name" : "Building Changes"
}, {
"name" : "Shares"
}, {
"name" : "PersonsOwnings"
}, {
"name" : "ShareExtended"
}, {
"name" : "Housing Cooperatives Search"
}, {
"name" : "Systemping"
}, {
"name" : "Addresses Search"
}, {
"name" : "Persons Search"
}, {
"name" : "Cadastre Land Registry"
}, {
"name" : "Municipalities"
}, {
"name" : "Realty Estate Units"
}, {
"name" : "Share Document Copy Existence"
}, {
"name" : "Cadastre Document Copy Existence"
}, {
"name" : "Places Search"
}, {
"name" : "Operating Units"
}, {
"name" : "Points of Conveyances"
}, {
"name" : "Cultural Heritages"
}, {
"name" : "Single Heritages"
}, {
"name" : "Floors"
}, {
"name" : "Scope"
}, {
"name" : "Share Scores"
}, {
"name" : "Cadastres Search"
}, {
"name" : "Districts"
}, {
"name" : "Housing Cooperatives"
}, {
"name" : "Share Liens Calculations"
}, {
"name" : "Reports"
}, {
"name" : "Share Land Registry"
}, {
"name" : "ConglomerateOwnerships"
}, {
"name" : "Streets Search"
}, {
"name" : "Creation Of Rights"
}, {
"name" : "Complaints"
}, {
"name" : "Cadastres"
}, {
"name" : "Users"
}, {
"name" : "Cadastre Scores"
}, {
"name" : "Organization"
}, {
"name" : "Code Fields"
}, {
"name" : "Buildings"
}, {
"name" : "AccountantData"
}, {
"name" : "Shares Search"
}, {
"name" : "PersonScore"
}, {
"name" : "Sectionings"
}, {
"name" : "Soil Contaminations"
}, {
"name" : "Separately Occupied Units"
}, {
"name" : "Unregistered Ownerships"
}, {
"name" : "Dictionary"
}, {
"name" : "Offices"
}, {
"name" : "Cadastre Housing Values"
}, {
"name" : "Cadastre Conveyances"
}, {
"name" : "Share Ownerships"
}, {
"name" : "Validate Cadastre Land Registry"
}, {
"name" : "Share Housing Values"
}, {
"name" : "Share Conveyances"
}, {
"name" : "Streets"
}, {
"name" : "Cadastre Ownerships"
}, {
"name" : "Plots"
}, {
"name" : "Coordinates"
}, {
"name" : "Home Equities"
} ],
"paths" : {
"/v1/creationofrights/{rightKey}/currentmortgagees/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get current mortgagees of a right",
"description" : "",
"operationId" : "getCurrentMortgagees",
"parameters" : [ {
"name" : "rightKey",
"in" : "path",
"description" : "Creation of right key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/MortgageesItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/residents/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the residents of an address",
"description" : "",
"operationId" : "listResidentsOfAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/owners/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the owners of a cadastre",
"description" : "",
"operationId" : "listOwnersOfCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns persons who owns the cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/owners/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the owners of a share",
"description" : "",
"operationId" : "listOwnersOfShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "share key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/conveyances/{conveyanceKey}/buyers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the buyers participating in a conveyance of cadastres",
"description" : "",
"operationId" : "listBuyersOfConveyanceOfCadastres",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/conveyances/{conveyanceKey}/sellers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the sellers participating in a conveyance of cadastres",
"description" : "",
"operationId" : "listSellersOfConveyanceOfCadastres",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/conveyances/{conveyanceKey}/buyers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the buyers participating in a conveyance of shares",
"description" : "",
"operationId" : "listBuyersOfConveyanceOfShares",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/conveyances/{conveyanceKey}/sellers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the sellers participating in a conveyance of shares",
"description" : "",
"operationId" : "listSellersOfConveyanceOfShares",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/developers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get persons with a role as developer of a building",
"description" : "",
"operationId" : "listDevelopersOfBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/contacts/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get persons with the role as contact person of a building",
"description" : "",
"operationId" : "listContactsOfBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/developers/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get persons with a role as developer of a building change",
"description" : "",
"operationId" : "listDevelopersOfBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "building change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/contacts/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get persons with the role as contact person of a building change",
"description" : "",
"operationId" : "listContactsOfBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "building change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/ownerships/{ownershipKey}/owningperson/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the owning person for a cadastre ownership",
"description" : "",
"operationId" : "getOwnerOfOwnershipOnCadastres",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Ownership key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/ownerships/{ownershipKey}/owningperson/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get the owning person for a share ownership",
"description" : "",
"operationId" : "getOwnerOfOwnershipOnShares",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Ownership key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get person",
"description" : "Get person",
"operationId" : "getPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9",
"required" : true,
"type" : "string"
}, {
"name" : "hasProperty",
"in" : "query",
"description" : "Filter person without a property (not filtered if false)",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeOwnershipCountWithState",
"in" : "query",
"description" : "Fetch ownerships with state",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships for a cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/" : {
"get" : {
"tags" : [ "Persons" ],
"summary" : "Get persons",
"description" : "Returns persons",
"operationId" : "listPersons",
"parameters" : [ {
"name" : "ownsCadastreKey",
"in" : "query",
"description" : "Returns persons who owns the cadastre for provided cadastre key, for example (1201-10-1-0-0)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownsShareKey",
"in" : "query",
"description" : "Returns persons who owns the share for provided share key, for example (948946645-1)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "conveyanceOfCadastreKey",
"in" : "query",
"description" : "Returns persons who participated in a conveyance of cadastre for provided conveyance key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "conveyanceOfShareKey",
"in" : "query",
"description" : "Returns persons who participated in a conveyance of share for provided conveyance key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns persons who participated in building construction for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingChangeKey",
"in" : "query",
"description" : "Returns persons who participated in building construction for provided building change key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "role",
"in" : "query",
"description" : "Returns persons of specified role who participated in a conveyance (seller, purchaser) or building construction (constructor, developer)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns persons who owns the cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/accountantdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data by cadastre",
"description" : "Returns an Accountant Housing Data for specified cadastre",
"operationId" : "getAccountantHousingDataByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Official key identifying the housing - Cadastre key (4601-12-123-0-1)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/accountantdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data by share",
"description" : "Returns an Accountant Housing Data for specified share",
"operationId" : "getAccountantHousingDataByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Official key identifying the housing - Share key (987654321-12)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/accountants/housingdata/{housingKey}" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data",
"description" : "Returns an Accountant Housing Data for specified key",
"operationId" : "getAccountantHousingDataOfficialKey",
"parameters" : [ {
"name" : "housingKey",
"in" : "path",
"description" : "Official key identifying the housing - Cadastre key (4601-12-123-0-1), Share key (987654321-12) or Stock bond key (123456789-12)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/accountants/housingdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Find Accountant Housing Data",
"description" : "Returns a list of Accountant Housing Data for specified parameters",
"operationId" : "getAccountantHousingData",
"parameters" : [ {
"name" : "ownerKey",
"in" : "query",
"description" : "Internal key for the owning person/ organization",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownerOfficialNumber",
"in" : "query",
"description" : "Personal number/ organization number for the owning person/ organization",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cooperativeOrganizationNumber",
"in" : "query",
"description" : "Organization number for the cooperative",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "dwellingUnitUuid",
"in" : "query",
"description" : "Dwelling unit UUID from Matrikkelen",
"required" : false,
"type" : "string",
"default" : "null",
"format" : "uuid"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/historicalcadastrepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Historical Cadastre PDF by cadastre",
"description" : "",
"operationId" : "getHistoricalCadastrePDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/historicalcadastre/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Historical Cadastre PDF by cadastre",
"description" : "",
"operationId" : "getHistoricalCadastrePDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/historicalsharepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Historical Share PDF by share",
"description" : "",
"operationId" : "getHistoricalSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/historicalshare/{shareKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Historical Share PDF by share",
"description" : "",
"operationId" : "getHistoricalSharePDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/lienscalculation/" : {
"get" : {
"tags" : [ "Cadastre Liens Calculations" ],
"summary" : "Get liens calculation for cadastre",
"description" : "",
"operationId" : "getCadastreLiensCalculation",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Filter on the cadastre's max cadastre-level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreLiensCalculationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses related to a cadastre",
"description" : "",
"operationId" : "listAddressesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses related to a building",
"description" : "",
"operationId" : "listAddressesByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses related to a building change",
"description" : "",
"operationId" : "listAddressesByBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Building Change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/{streetKey}/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses in a street",
"description" : "",
"operationId" : "listAddressesByStreet",
"parameters" : [ {
"name" : "streetKey",
"in" : "path",
"description" : "Street key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/districts/{districtKey}/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses in a district",
"description" : "",
"operationId" : "listAddressesByDistrict",
"parameters" : [ {
"name" : "districtKey",
"in" : "path",
"description" : "Street key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{unitKey}/address/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get the address for a separately occupied unit",
"description" : "The address for the unit is not always present",
"operationId" : "getAddressByUnit",
"parameters" : [ {
"name" : "unitKey",
"in" : "path",
"description" : "Separately occupied unit key",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/positions/{x},{y},{inputDatum}/nearbyaddresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses near position",
"description" : "The list is sorted by distance",
"operationId" : "listAddressesNearPosition",
"parameters" : [ {
"name" : "x",
"in" : "path",
"description" : "X/ easting",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "y",
"in" : "path",
"description" : "Y/ northing",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "inputDatum",
"in" : "path",
"description" : "The positions geodetic datum",
"required" : true,
"type" : "string",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "maxDistance",
"in" : "query",
"description" : "Max distance",
"required" : false,
"type" : "integer",
"default" : 50,
"format" : "int32"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum in response. If not provided the inputDatum will be the default.",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/address/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get the address for a housing cooperative share",
"description" : "The address for the share is not always present",
"operationId" : "getAddressByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Housing cooperative share key",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/presentationaddress/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get the presentation address for a cadastre",
"description" : "The presentation address for the cadastre is not always present",
"operationId" : "getPresentationAddressByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressId}" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get a unique address",
"description" : "Returns address",
"operationId" : "getAddress",
"parameters" : [ {
"name" : "addressId",
"in" : "path",
"description" : "Returns address for provided official id or database id",
"required" : true,
"type" : "string"
}, {
"name" : "searchByDatabaseId",
"in" : "query",
"description" : "The provided id is interpreted as a database id",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/" : {
"get" : {
"tags" : [ "Addresses" ],
"summary" : "Get addresses by other keys",
"description" : "Returns addresses",
"operationId" : "listAddresses",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns addresses for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareKey",
"in" : "query",
"description" : "Returns addresses for provided share key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns addresses for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingChangeKey",
"in" : "query",
"description" : "Returns addresses for provided building change key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "unitKey",
"in" : "query",
"description" : "Returns addresses for provided separately occupied unit key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "districtKey",
"in" : "query",
"description" : "Returns addresses for provided district key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "streetKey",
"in" : "query",
"description" : "Returns addresses for provided street key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "streetNumber",
"in" : "query",
"description" : "Returns addresses for provided street number",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "streetName",
"in" : "query",
"description" : "Returns addresses for provided street name",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/customerscore/" : {
"get" : {
"tags" : [ "Customer Scores" ],
"summary" : "Get customerscore by person",
"description" : "",
"operationId" : "getCustomerScore",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9",
"required" : true,
"type" : "string"
}, {
"name" : "yearsOfHistory",
"in" : "query",
"description" : "Only retrieve data for given number of years",
"required" : false,
"type" : "integer",
"default" : -1,
"format" : "int32"
}, {
"name" : "focus",
"in" : "query",
"description" : "What to focus on",
"required" : false,
"type" : "string",
"default" : "person",
"enum" : [ "person", "object" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active_and_historical",
"enum" : [ "active", "active_and_historical" ]
}, {
"name" : "toDate",
"in" : "query",
"description" : "Evaluate score as of date (yyyy-MM-dd). Defaults to today if omitted",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CustomerScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/property/lienscalculations/{cadastreKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get liens calculation",
"description" : "DEPRECATED: see Cadastre Liens Calculations",
"operationId" : "deprecatedGetCadastreLiensCalculation",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns liens calculation for cadastre for provided official id
Example of official id for cadastre '1201-10-650-0-0'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Filter on the cadastre's max cadastre-level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreLiensCalculationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/affairs/" : {
"get" : {
"tags" : [ "Affairs" ],
"summary" : "Get affairs for a cadastre",
"description" : "",
"operationId" : "listAffairsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AffairListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/affairs/{affairKey}" : {
"get" : {
"tags" : [ "Affairs" ],
"summary" : "Get affair",
"description" : "Returns affair",
"operationId" : "getAffair",
"parameters" : [ {
"name" : "affairKey",
"in" : "path",
"description" : "Returns affair for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AffairItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/affairs/" : {
"get" : {
"tags" : [ "Affairs" ],
"summary" : "Get affairs",
"description" : "Returns affairs",
"operationId" : "listAffairs",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns affairs for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AffairListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/cadastreextended/{cadastreKey}" : {
"get" : {
"tags" : [ "CadastreExtended" ],
"summary" : "Get extended information about a cadastre",
"description" : "",
"operationId" : "getCadastreExtended",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Get extended information about a cadastre",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Only include ownerships with maximum cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreExtendedItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/customerscorecoowner/{personKey}" : {
"get" : {
"tags" : [ "CustomerScoreCoOwner" ],
"summary" : "Get customerscore coowner",
"description" : "Returns customerscore coowner",
"operationId" : "getCustomerScoreCoOwner",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Returns coowner for supplied personKey",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CustomerScoreCoOwnerItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/coopinternals/" : {
"get" : {
"tags" : [ "Coop Internals" ],
"summary" : "Get coop internals for a cadastre",
"description" : "",
"operationId" : "listCoopInternalsForCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CoopInternalListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/coopinternals/" : {
"get" : {
"tags" : [ "Coop Internals" ],
"summary" : "Get coop internals for a share",
"description" : "",
"operationId" : "listCoopInternalsForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "share key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CoopInternalListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/coopinternals/{coopInternalKey}" : {
"get" : {
"tags" : [ "Coop Internals" ],
"summary" : "Get coop internal",
"description" : "Returns coop internal - Internal index-data for housing cooperative holders",
"operationId" : "getCoopInternal",
"parameters" : [ {
"name" : "coopInternalKey",
"in" : "path",
"description" : "Returns coop internal for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CoopInternalItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/coopinternals/" : {
"get" : {
"tags" : [ "Coop Internals" ],
"summary" : "Get coop internals",
"description" : "Returns coop internals - Internal index-data for housing cooperative holders",
"operationId" : "listCoopInternals",
"parameters" : [ {
"name" : "ownerOfficialNumber",
"in" : "query",
"description" : "Returns coop internals related to an owner with the provided official number (personalNumber or organizationNumber)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownerKey",
"in" : "query",
"description" : "Returns coop internals related to an owner with provided internal person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cooperativeKey",
"in" : "query",
"description" : "Returns coop internals related to the cooperative holder with the provided key (organizationNumber)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareNumber",
"in" : "query",
"description" : "Returns coop internals related to the cooperative holder with the provided share number",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CoopInternalListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/property/housingvalues/{cadastreKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get housing value for a cadastre",
"description" : "DEPRECATED: see Cadastre Housing Values",
"operationId" : "deprecatedGetHousingValueForCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreHousingValueItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v2/cadastres/{cadastreKey}/accountantdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data by cadastre",
"description" : "Returns Accountant Housing Data for specified cadastre",
"operationId" : "getAccountantHousingDataByCadastreV2",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Official key identifying the housing - Cadastre key (4601-12-123-0-1)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v2/shares/{shareKey}/accountantdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data by share",
"description" : "Returns Accountant Housing Data for specified share",
"operationId" : "getAccountantHousingDataByShareV2",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Official key identifying the housing - Share key (987654321-12)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v2/accountants/housingdata/{housingKey}" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Get Accountant Housing Data",
"description" : "Returns Accountant Housing Data for specified key",
"operationId" : "getAccountantHousingDataOfficialKeyV2",
"parameters" : [ {
"name" : "housingKey",
"in" : "path",
"description" : "Official key identifying the housing - Cadastre key (4601-12-123-0-1) or Share key (987654321-12)",
"required" : true,
"type" : "string"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v2/accountants/housingdata/" : {
"get" : {
"tags" : [ "Accountant Housing Data" ],
"summary" : "Find Accountant Housing Data",
"description" : "Returns a list of Accountant Housing Data for specified parameters",
"operationId" : "searchAccountantHousingDataV2",
"parameters" : [ {
"name" : "ownerKey",
"in" : "query",
"description" : "Internal key for the owning person/ organization",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownerOfficialNumber",
"in" : "query",
"description" : "Personal number/ organization number for the owning person/ organization",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cooperativeOrganizationNumber",
"in" : "query",
"description" : "Organization number for the cooperative",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "dwellingUnitUuid",
"in" : "query",
"description" : "Dwelling unit UUID from Matrikkelen",
"required" : false,
"type" : "string",
"default" : "null",
"format" : "uuid"
}, {
"name" : "useTemp",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AccountantHousingDataListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/positions/{x},{y},{datum}/plot/polygon/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get plot-polygons by position",
"description" : "Returns polygons as geojson",
"operationId" : "getPlotPolygonsByPosition",
"parameters" : [ {
"name" : "x",
"in" : "path",
"description" : "X/ easting",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "y",
"in" : "path",
"description" : "Y/ northing",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "datum",
"in" : "path",
"description" : "Geodetic datum",
"required" : true,
"type" : "string",
"default" : "WGS84",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/polygon/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get polygons for cadastre",
"description" : "Returns polygons as geojson",
"operationId" : "getPolygonsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/position/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get position for cadastre",
"description" : "Returns position as geojson point",
"operationId" : "getPositionByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/{streetKey}/linestring/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get linestring for a street",
"description" : "Returns linestring as geojson",
"operationId" : "getLineStringByStreet",
"parameters" : [ {
"name" : "streetKey",
"in" : "path",
"description" : "Street key",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum",
"required" : false,
"type" : "string",
"default" : "WGS84",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/plots/{plotKey}/polygon/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get polygon for plot",
"description" : "Returns polygon as geojson",
"operationId" : "getPolygonByPlot",
"parameters" : [ {
"name" : "plotKey",
"in" : "path",
"description" : "Plot key (Matrikkelen ID)",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/buildingchanges/" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get building changes for a cadastre",
"description" : "",
"operationId" : "listBuildingChangesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyIncludeUnderConstruction",
"in" : "query",
"description" : "Only include changes under construction",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/changes/" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get building changes for building",
"description" : "",
"operationId" : "listBuildingChangesByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "building key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyIncludeUnderConstruction",
"in" : "query",
"description" : "Only include changes under construction",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{unitKey}/buildingchange/" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get the building change for a separately occupied unit",
"description" : "",
"operationId" : "getBuildingChangeByUnit",
"parameters" : [ {
"name" : "unitKey",
"in" : "path",
"description" : "Separately occupied unit key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/changes/{version}" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get building change",
"description" : "Returns building change",
"operationId" : "deprecatedGetBuildingChange",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "version",
"in" : "path",
"description" : "Returns building change for provided building version",
"required" : true,
"type" : "integer",
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get building change",
"description" : "Returns building change",
"operationId" : "getBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Returns building change for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/" : {
"get" : {
"tags" : [ "Building Changes" ],
"summary" : "Get building changes",
"description" : "Returns building changes",
"operationId" : "listBuildingChanges",
"parameters" : [ {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns building changes for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns building changes for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyIncludeUnderConstruction",
"in" : "query",
"description" : "Only include changes under construction",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingChangeListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares for a cadastre",
"description" : "",
"operationId" : "listSharesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pocs/{pocKey}/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares for a pocId",
"description" : "",
"operationId" : "listSharesByPoc",
"parameters" : [ {
"name" : "pocKey",
"in" : "path",
"description" : "Poc key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns shares from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares for a address",
"description" : "",
"operationId" : "listSharesByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/conveyances/{conveyanceKey}/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares for a conveyance",
"description" : "",
"operationId" : "listSharesByConveyance",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "Conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/ownedshares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares owned by a person",
"description" : "",
"operationId" : "listShareByOwningPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Owned by person key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{unitKey}/share/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get the share for a separately occupied unit",
"description" : "",
"operationId" : "getShareByUnit",
"parameters" : [ {
"name" : "unitKey",
"in" : "path",
"description" : "Separately occupied unit key",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/housingcooperatives/{cooperativeKey}/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares for a cooperative",
"description" : "",
"operationId" : "listSharesByCooperative",
"parameters" : [ {
"name" : "cooperativeKey",
"in" : "path",
"description" : "Cooperative key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/ownerships/{ownershipKey}/ownedshare/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get the owned share for an ownership",
"description" : "",
"operationId" : "getShareByOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Ownership key",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/positions/{x},{y},{inputDatum}/nearbyshares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares near position",
"description" : "The list is sorted by distance",
"operationId" : "listSharesNearbyPosition",
"parameters" : [ {
"name" : "x",
"in" : "path",
"description" : "X/ easting",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "y",
"in" : "path",
"description" : "Y/ northing",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "inputDatum",
"in" : "path",
"description" : "The positions geodetic datum",
"required" : true,
"type" : "string",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "maxDistance",
"in" : "query",
"description" : "Max distance",
"required" : false,
"type" : "integer",
"default" : 50,
"format" : "int32"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum in response. If not provided the inputDatum will be the default.",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get share",
"description" : "Returns share",
"operationId" : "getShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Returns share for provided official id
Example of official id for housing cooperative share '948946645-2'",
"required" : true,
"type" : "string"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/" : {
"get" : {
"tags" : [ "Shares" ],
"summary" : "Get shares",
"description" : "Returns shares",
"operationId" : "listShares",
"parameters" : [ {
"name" : "ownedByPersonKey",
"in" : "query",
"description" : "Returns shares owned by person for provided person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressId",
"in" : "query",
"description" : "DEPRECATED. Returns shares for provided address id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns shares for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "pocId",
"in" : "query",
"description" : "Returns shares for provided poc id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "conveyanceKey",
"in" : "query",
"description" : "Returns shares for provided conveyance key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cooperativeKey",
"in" : "query",
"description" : "Returns shares for provided cooperative key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns shares from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/personsownings/{personKeys}" : {
"get" : {
"tags" : [ "PersonsOwnings" ],
"summary" : "Get persons ownings",
"description" : "Returns persons ownings for supplied person keys.",
"operationId" : "getPersonsOwnings",
"parameters" : [ {
"name" : "personKeys",
"in" : "path",
"description" : "Returns persons ownings for supplied personKeys",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "onlyMaxLevel",
"in" : "query",
"description" : "Only include ownerships with maximum cadastre/share level",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includePersons",
"in" : "query",
"description" : "Include persons in response",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "minimumOwnershipPct",
"in" : "query",
"description" : "The minimum ownership percentage to be included (0-100)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonsOwningsItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/property/conveyances/{conveyanceKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get conveyance",
"description" : "DEPRECATED: see Cadastre Conveyances",
"operationId" : "deprecatedlistCadastreConveyances",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreConveyanceItemResponse"
}
}
}
}
},
"/v1/property/conveyances/" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get conveyances",
"description" : "DEPRECATED: see Cadastre Conveyances",
"operationId" : "deprecatedListCadastreConveyancesByParam",
"parameters" : [ {
"name" : "pocId",
"in" : "query",
"description" : "Returns conveyances for provided poc id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns conveyances for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalities",
"in" : "query",
"description" : "Returns conveyances for provided list of municipality numbers",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns conveyances for a cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort results by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "registeredAfterTime",
"in" : "query",
"description" : "Returns conveyances with registered after time",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/objectscores/{cadastreKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get object score for a cadastre",
"description" : "DEPRECATED: see Cadastre Scores",
"operationId" : "depecatedGetCadastreCustomerScore",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns cadastre score for provided official id
Example of official id for cadastre '1201-10-650-0-0'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CustomerScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/shareextended/{shareKey}" : {
"get" : {
"tags" : [ "ShareExtended" ],
"summary" : "Get extended information about a share",
"description" : "",
"operationId" : "getShareExtended",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Get extended information about a share",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Only include ownerships with maximum share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareExtendedItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/housingcooperatives/" : {
"get" : {
"tags" : [ "Housing Cooperatives Search" ],
"summary" : "Get housing cooperatives",
"description" : "Search for housing cooperatives",
"operationId" : "searchForHousingCooperatives",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search
Search using housing cooperative name or organization number",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/HousingCooperativeSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/systemping/" : {
"get" : {
"tags" : [ "Systemping" ],
"summary" : "System ping",
"description" : "Returns comprehensive status data about the Realty application including version information, system health, database status, and performance metrics. This endpoint is used for health checks and monitoring.",
"operationId" : "getSystemPing",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PingResponse"
}
},
"503" : {
"description" : "System is not operational - one or more critical services are unavailable",
"schema" : {
"$ref" : "#/definitions/PingResponse"
}
}
}
}
},
"/v1/search/addresses/" : {
"get" : {
"tags" : [ "Addresses Search" ],
"summary" : "Get addresses",
"description" : "Search for addresses",
"operationId" : "searchForAddressesV",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "streetKey",
"in" : "query",
"description" : "Optional parameter to search addresses by street key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "exactAddressNumber",
"in" : "query",
"description" : "Optional parameter to search only by exact address number (if not exact matches found, partial results will be returned)",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AddressSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/persons/" : {
"get" : {
"tags" : [ "Persons Search" ],
"summary" : "Get persons",
"description" : "Search for persons. Requires at least one letter in query string to do search.",
"operationId" : "searchForPersonsV2",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number. For byType=S the municipality is the one registered in Enhetsregisteret, so organizations that are not registered there are not returned. Not supported for byType=L.",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "postalCode",
"in" : "query",
"description" : "Filter by postal code. Matches the residence address for byType=F and the business address for byType=S. Not supported for byType=L.",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "0010"
}, {
"name" : "byType",
"in" : "query",
"description" : "Returns persons for provided type (F - Official person, L - Unofficial person, S - Organization)",
"required" : false,
"type" : "string",
"default" : "F",
"enum" : [ "F", "L", "S" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 200,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "hasProperty",
"in" : "query",
"description" : "Filter out persons without a property (not filtered if false)",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/titlepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get title for Share PDF by share",
"description" : "",
"operationId" : "getTitleSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/mortgagepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get mortgage for Share PDF by share",
"description" : "",
"operationId" : "getMortgageSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/shareinfopdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get share info PDF by share",
"description" : "",
"operationId" : "getShareInfoPDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/creationofrights/{shareRightKey}/pdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get CreationOfRight for share PDF by rightKey",
"description" : "",
"operationId" : "getShareRightPDFByRight",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareRightKey",
"in" : "path",
"description" : "Right key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/creationofrights/{cadastreRightKey}/pdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get CreationOfRight for cadastre PDF by rightKey",
"description" : "",
"operationId" : "getCadastreRightPDFByRight",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreRightKey",
"in" : "path",
"description" : "Right key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/homeequities/{personKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get home equity",
"description" : "DEPRECATED: see Home Equities",
"operationId" : "deprecatedGetHomeEquity",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/HomeEquityItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/landregistry/" : {
"get" : {
"tags" : [ "Cadastre Land Registry" ],
"summary" : "Generates a Land Registry report for the cadastre",
"description" : "",
"operationId" : "getCadastreLandRegistry",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "parts",
"in" : "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",
"required" : true,
"type" : "string",
"default" : "alle",
"enum" : [ "grunndata", "heftelser", "hjemmel", "festeavtaler", "leieavtaler", "pengeheftelser", "rettigheter", "servitutter", "alle", "alle_med_rettigheter" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights in report",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for each right",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includeAddress",
"in" : "query",
"description" : "Include formatted address",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeTitleOnMainCadastre",
"in" : "query",
"description" : "Include title (hjemmel) from the main cadastre when the requested cadastre is a leasehold (festenummer)",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreLandRegistryItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/municipalities/{municipalityKey}" : {
"get" : {
"tags" : [ "Municipalities" ],
"summary" : "Get municipality",
"description" : "Returns municipality",
"operationId" : "getMunicipality",
"parameters" : [ {
"name" : "municipalityKey",
"in" : "path",
"description" : "Returns municipality for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/MunicipalityItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/municipalities/" : {
"get" : {
"tags" : [ "Municipalities" ],
"summary" : "Get municipalities",
"description" : "Returns municipalities",
"operationId" : "listMunicipalities",
"parameters" : [ {
"name" : "municipalityName",
"in" : "query",
"description" : "Returns municipalities for provided region name",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "regionNumber",
"in" : "query",
"description" : "Returns municipalities for provided region number",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the municipalities",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/MunicipalityListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/realtyestateunits/" : {
"get" : {
"tags" : [ "Realty Estate Units" ],
"summary" : "Get realty estate units for a cadastre",
"description" : "",
"operationId" : "listRealtyEstateUnitsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RealtyEstateUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/realtyestateunits/{realtyEstateUnitKey}" : {
"get" : {
"tags" : [ "Realty Estate Units" ],
"summary" : "Get realty estate unit",
"description" : "Returns realty estate unit",
"operationId" : "getRealtyEstateUnit",
"parameters" : [ {
"name" : "realtyEstateUnitKey",
"in" : "path",
"description" : "Returns realty estate unit for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RealtyEstateUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/realtyestateunits/" : {
"get" : {
"tags" : [ "Realty Estate Units" ],
"summary" : "Get realty estate unit",
"description" : "Returns realty estate unit",
"operationId" : "getRealtyEstateUnitByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns realty estate units for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RealtyEstateUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/documentcopyexistence/{shareDocumentKey}" : {
"get" : {
"tags" : [ "Share Document Copy Existence" ],
"summary" : "Get document copy existences",
"description" : "Returns document copy existences",
"operationId" : "getShareDocumentCopyExistence",
"parameters" : [ {
"name" : "shareDocumentKey",
"in" : "path",
"description" : "Returns document copy existence for provided document year and document number (document year - document number) ",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareDocumentCopyExistenceItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/oldcadastrepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Old Cadastre PDF ByCadastre",
"description" : "",
"operationId" : "getOldCadastrePDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/oldcadastre/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Old Cadastre PDF by cadastre",
"description" : "",
"operationId" : "getOldCadastrePDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/documentcopyexistence/{cadastreDocumentKey}" : {
"get" : {
"tags" : [ "Cadastre Document Copy Existence" ],
"summary" : "Get document copy existence",
"description" : "Returns document copy existence for property",
"operationId" : "getCadastreDocumentCopyExistence",
"parameters" : [ {
"name" : "cadastreDocumentKey",
"in" : "path",
"description" : "Returns document copy existence for office number or municipality number - document year - document number '200-2010-650' or 'K4601-2010-650'",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreDocumentCopyExistenceItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/places/" : {
"get" : {
"tags" : [ "Places Search" ],
"summary" : "Get places",
"description" : "Search for places",
"operationId" : "searchForPlacesV2",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PlaceSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/operatingunit/" : {
"get" : {
"tags" : [ "Operating Units" ],
"summary" : "Get operating unit by any unit",
"description" : "Find operating unit by any unit",
"operationId" : "getOperatingUnitByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns operating unit by provided any cadastre id",
"required" : true,
"type" : "string"
}, {
"name" : "state",
"in" : "query",
"description" : "The required state of each code",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OperatingUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/operatingunits/{cadastreKey}" : {
"get" : {
"tags" : [ "Operating Units" ],
"summary" : "Get operating unit",
"description" : "Find operating unit",
"operationId" : "getOperatingUnit",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns operating unit by provided main cadastre id",
"required" : true,
"type" : "string"
}, {
"name" : "state",
"in" : "query",
"description" : "The required state of each code",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OperatingUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pocs/{pocId}" : {
"get" : {
"tags" : [ "Points of Conveyances" ],
"summary" : "Get POC",
"description" : "Returns POC",
"operationId" : "getPoc",
"parameters" : [ {
"name" : "pocId",
"in" : "path",
"description" : "Returns POC for provided POC id",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/POCItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pocs/" : {
"get" : {
"tags" : [ "Points of Conveyances" ],
"summary" : "Get POCs",
"description" : "Returns POCs",
"operationId" : "listPocs",
"parameters" : [ {
"name" : "eastingMin",
"in" : "query",
"description" : "Minimum easting for provided extent",
"required" : true,
"type" : "number",
"default" : -59448.67,
"format" : "double"
}, {
"name" : "northingMin",
"in" : "query",
"description" : "Minimum northing for provided extent",
"required" : true,
"type" : "number",
"default" : 6779504.82,
"format" : "double"
}, {
"name" : "eastingMax",
"in" : "query",
"description" : "Maximum easting for provided extent",
"required" : true,
"type" : "number",
"default" : -57557.26,
"format" : "double"
}, {
"name" : "northingMax",
"in" : "query",
"description" : "Maximum northing for provided extent",
"required" : true,
"type" : "number",
"default" : 6782860.09,
"format" : "double"
}, {
"name" : "fromDate",
"in" : "query",
"description" : "From date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD)",
"required" : false,
"type" : "string",
"default" : "2010"
}, {
"name" : "toDate",
"in" : "query",
"description" : "To date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD)",
"required" : false,
"type" : "string",
"default" : "2019"
}, {
"name" : "groundUsage",
"in" : "query",
"description" : "Usage of ground
Use a combination of three characters: 'B' for residential or 'F' for recreational or 'A' for other",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/POCListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/culturalheritages/" : {
"get" : {
"tags" : [ "Cultural Heritages" ],
"summary" : "Get cultural heritages related to a building",
"description" : "",
"operationId" : "listCulturalHeritagesByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CulturalHeritageListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/culturalheritages/{culturalHeritageKey}" : {
"get" : {
"tags" : [ "Cultural Heritages" ],
"summary" : "Get cultural heritage",
"description" : "Returns cultural heritage",
"operationId" : "getCulturalHeritage",
"parameters" : [ {
"name" : "culturalHeritageKey",
"in" : "path",
"description" : "Returns cultural heritage for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CulturalHeritageItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/culturalheritages/" : {
"get" : {
"tags" : [ "Cultural Heritages" ],
"summary" : "Get cultural heritages",
"description" : "Returns cultural heritages",
"operationId" : "listCulturalHeritages",
"parameters" : [ {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns cultural heritages for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CulturalHeritageListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/singleheritages/" : {
"get" : {
"tags" : [ "Single Heritages" ],
"summary" : "Get single heritages related to a cadastre",
"description" : "",
"operationId" : "listSingleHeritagesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SingleHeritageListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/singleheritages/" : {
"get" : {
"tags" : [ "Single Heritages" ],
"summary" : "Get single heritages related to a building",
"description" : "",
"operationId" : "listSingleHeritagesByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SingleHeritageListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/singleheritages/{singleHeritageKey}" : {
"get" : {
"tags" : [ "Single Heritages" ],
"summary" : "Get single heritage",
"description" : "Returns single heritage",
"operationId" : "getSingleHeritage",
"parameters" : [ {
"name" : "singleHeritageKey",
"in" : "path",
"description" : "Returns single heritage for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SingleHeritageItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/singleheritages/" : {
"get" : {
"tags" : [ "Single Heritages" ],
"summary" : "Get single heritages",
"description" : "Returns single heritages",
"operationId" : "listSingleHeritages",
"parameters" : [ {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns single heritages for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns single heritages for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SingleHeritageListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/floors/" : {
"get" : {
"tags" : [ "Floors" ],
"summary" : "Get floors related to a building",
"description" : "",
"operationId" : "listFloorsByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/FloorListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/floors/" : {
"get" : {
"tags" : [ "Floors" ],
"summary" : "Get floors related to a buildingchange",
"description" : "",
"operationId" : "listFloorsByBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Building change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/FloorListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/floors/{floorKey}" : {
"get" : {
"tags" : [ "Floors" ],
"summary" : "Get floor",
"description" : "Returns floor",
"operationId" : "getFloor",
"parameters" : [ {
"name" : "floorKey",
"in" : "path",
"description" : "Returns floor for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/FloorItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/floors/" : {
"get" : {
"tags" : [ "Floors" ],
"summary" : "Get floors",
"description" : "Returns floors",
"operationId" : "listFloors",
"parameters" : [ {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns floors for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingChangeKey",
"in" : "query",
"description" : "Returns floors for provided building change key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/FloorListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cooperative/objectscores/{shareKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get object score for a share",
"description" : "DEPRECATED: see Share Scores",
"operationId" : "deprecatedGetShareCustomerScore",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Returns share for provided official id
Example of official id for housing cooperative share '948946645-2'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns share score having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CustomerScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/scopes/" : {
"get" : {
"tags" : [ "Scope" ],
"summary" : "Get scope list",
"description" : "Returns scope list",
"operationId" : "scope",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ScopeAccess"
}
}
}
}
},
"/v2/shares/{shareKey}/objectscore/" : {
"get" : {
"tags" : [ "Share Scores" ],
"summary" : "Get object score for a share",
"description" : "",
"operationId" : "getShareObjectScoreV2",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Returns share score for provided official id
Example of official id for share '948946645-2'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns share score having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareScoreItemResponseV2"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/mapfeatures/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get cadastral map features for a cadastre",
"description" : "Returns plot polygons, border lines, border points and the cadastre representation point as a single GeoJSON FeatureCollection. Each feature carries a featureType property: plot, borderline, borderpoint or cadastrePoint. Geometry is in the requested datum, while northing/easting on border points are in the plot's original UTM zone (see coordinateSystem on each plot) because cadastral coordinate lists are published in that zone. A cadastre with no representation point and no plots returns an empty collection without a bbox.",
"operationId" : "getMapFeaturesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM33",
"enum" : [ "UTM32", "UTM33", "UTM35", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/mapfeatures/" : {
"get" : {
"tags" : [ "Geometries" ],
"summary" : "Get cadastral map features within an extent",
"description" : "Returns plot polygons, border lines, border points, cadastre representation points and buildings within a bounding box, as a single GeoJSON FeatureCollection. This is what a map view or a map page draws from: it includes neighbouring features, not just one cadastre. Pass cadastreKey to flag the features belonging to that cadastre with isSubject, so a consumer can draw the selected property styled by accuracy and everything else as grey context from a single call. Pick layers to match the scale - borderpoint and building are the heaviest, and an extent holding more than 50000 features of the selected layers is rejected. Use simplify to drop detail the consumer cannot draw anyway - it is the single biggest lever on response size, since neighbouring border lines dominate a map extent.",
"operationId" : "getMapFeaturesByExtent",
"parameters" : [ {
"name" : "bbox",
"in" : "query",
"description" : "Extent as minEasting,minNorthing,maxEasting,maxNorthing in the given datum",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM33",
"enum" : [ "UTM32", "UTM33", "UTM35", "WGS84" ]
}, {
"name" : "layers",
"in" : "query",
"description" : "Comma separated feature types to include",
"required" : false,
"type" : "string",
"default" : "plot,borderline",
"enum" : [ "plot", "borderline", "borderpoint", "cadastrePoint", "building" ]
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Optional cadastre to flag with isSubject",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "simplify",
"in" : "query",
"description" : "Simplification tolerance in the units of the datum, metres for UTM. Zero or absent returns the geometry as registered. A positive value runs lines and polygons through ST_SimplifyPreserveTopology, dropping vertices closer together than the tolerance; points are unaffected. For drawing, the metres one pixel covers is a sensible value.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/cadastres/" : {
"get" : {
"tags" : [ "Cadastres Search" ],
"summary" : "Get cadastres",
"description" : "Search for cadastres",
"operationId" : "searchForCadastres",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search
Example for cadastre '4601 10 3' - finds cadastres starting with provided official id (matrikkel id)",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/districts/" : {
"get" : {
"tags" : [ "Districts" ],
"summary" : "Get districts related to a address",
"description" : "",
"operationId" : "listDistrictsByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DistrictListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/{streetKey}/districts/" : {
"get" : {
"tags" : [ "Districts" ],
"summary" : "Get districts related to a street",
"description" : "",
"operationId" : "listDistrictsByStreet",
"parameters" : [ {
"name" : "streetKey",
"in" : "path",
"description" : "Street key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DistrictListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/districts/{districtKey}" : {
"get" : {
"tags" : [ "Districts" ],
"summary" : "Get district",
"description" : "Returns district",
"operationId" : "getDistrict",
"parameters" : [ {
"name" : "districtKey",
"in" : "path",
"description" : "Returns district for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DistrictItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/districts/" : {
"get" : {
"tags" : [ "Districts" ],
"summary" : "Get districts",
"description" : "Returns districts",
"operationId" : "listDistricts",
"parameters" : [ {
"name" : "addressId",
"in" : "query",
"description" : "DEPRECATED. Returns districts for provided address id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns districts for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "streetKey",
"in" : "query",
"description" : "Returns districts for provided street key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DistrictListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/housingcooperatives/{housingCooperativeKey}" : {
"get" : {
"tags" : [ "Housing Cooperatives" ],
"summary" : "Get housing cooperative",
"description" : "Search for housing cooperative",
"operationId" : "getHousingCooperative",
"parameters" : [ {
"name" : "housingCooperativeKey",
"in" : "path",
"description" : "Returns housing cooperative for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/HousingCooperativeItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cooperative/lienscalculations/{shareKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get liens calculation",
"description" : "DEPRECATED: see Share Liens Calculations",
"operationId" : "deprecatedGetShareLiensCalculation",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Returns liens calculation for share for provided official id
Example of official id for housing cooperative share '948946645-2'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns liens calculation having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareLiensCalculationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/lienscalculation/" : {
"get" : {
"tags" : [ "Share Liens Calculations" ],
"summary" : "Get liens calculation for a share",
"description" : "",
"operationId" : "getShareLiensCalculation",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns liens calculation having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "ignoreInterpretationFaults",
"in" : "query",
"description" : "Ignore interpretation faults",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareLiensCalculationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/reports" : {
"get" : {
"tags" : [ "Reports" ],
"summary" : "Get compound report",
"description" : "Returns a property report of the requested type. The reportName parameter selects which report is generated. cadastreKey is required for: adresseopplysninger, bygningsopplysninger, eiendomsopplysninger, matrikkelutskrift, grunnbokfasteiendom. shareKey is required for: grunnbokborett. rightKey is required for: rettsstiftelse. parts, state, includeAddress and includeTitleOnMainCadastre only apply to land registry reports (grunnbokfasteiendom, grunnbokborett).",
"operationId" : "getReport",
"parameters" : [ {
"name" : "reportName",
"in" : "query",
"description" : "Name of the report to generate",
"required" : true,
"type" : "string",
"enum" : [ "adresseopplysninger", "bygningsopplysninger", "eiendomsopplysninger", "matrikkelutskrift", "grunnbokfasteiendom", "grunnbokborett", "rettsstiftelse" ]
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Cadastre key (required for most reports)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareKey",
"in" : "query",
"description" : "Share key (required for grunnbokborett)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "rightKey",
"in" : "query",
"description" : "Right key (required for rettsstiftelse)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "parts",
"in" : "query",
"description" : "Which parts to include (land registry reports only)",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "alle", "alle_med_rettigheter" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Ownership state filter (land registry reports only)",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "active", "active_and_historical" ]
}, {
"name" : "includeAddress",
"in" : "query",
"description" : "Include address in response (land registry reports only)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeTitleOnMainCadastre",
"in" : "query",
"description" : "Include title on main cadastre (land registry reports only)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ExternalResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/customerscores/{personKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get customerscore",
"description" : "DEPRECATED: see Customer Scores",
"operationId" : "deprecatedGetCustomerScore",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CustomerScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/landregistry/" : {
"get" : {
"tags" : [ "Share Land Registry" ],
"summary" : "Generates a Land Registry report for the share",
"description" : "",
"operationId" : "getLandRegistryForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "parts",
"in" : "query",
"description" : "Comma separated list of which parts of the Land Registy report should be included.",
"required" : false,
"type" : "string",
"enum" : [ "hjemmel", "heftelser", "andelsopplysninger" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights in report",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for each right",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includeAddress",
"in" : "query",
"description" : "Include formatted address",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareLandRegistryItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/conglomerateownerships/{organizationKey}" : {
"get" : {
"tags" : [ "ConglomerateOwnerships" ],
"summary" : "Get conglomerate ownerships",
"description" : "Returns aggregated ownership information across an organization and all related sub-organizations.",
"operationId" : "getConglomerateOwnerships",
"parameters" : [ {
"name" : "organizationKey",
"in" : "path",
"description" : "Organization key",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Only include ownerships with maximum cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ExternalResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/streets/" : {
"get" : {
"tags" : [ "Streets Search" ],
"summary" : "Get streets",
"description" : "Search for streets",
"operationId" : "searchForStreetsV2",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "postalCode",
"in" : "query",
"description" : "Filter by postal code",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "0010"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum (currently not in use)",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StreetSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/historicaltitlepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get historical title for Share PDF by share",
"description" : "",
"operationId" : "getHistoricalTitleSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/historicalmortgagepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get historical mortgage for Share PDF by share",
"description" : "",
"operationId" : "getHistoricalMortgageSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/historicalshareinfopdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get historical share info PDF by share",
"description" : "",
"operationId" : "getHistoricalShareInfoPDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/creationofrights/" : {
"get" : {
"tags" : [ "Creation Of Rights" ],
"summary" : "Get creation of rights for a person",
"description" : "",
"operationId" : "listRightsForPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Person key",
"required" : true,
"type" : "string"
}, {
"name" : "group",
"in" : "query",
"description" : "What group of rights to filter on",
"required" : true,
"type" : "string",
"enum" : [ "hjemmel", "heftelser" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CreationOfRightsListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/complaints/" : {
"get" : {
"tags" : [ "Complaints" ],
"summary" : "Get complaints for a cadastre",
"description" : "",
"operationId" : "listComplaintsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ComplaintListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/complaints/{complaintKey}" : {
"get" : {
"tags" : [ "Complaints" ],
"summary" : "Get complaint",
"description" : "Returns complaint",
"operationId" : "getComplaint",
"parameters" : [ {
"name" : "complaintKey",
"in" : "path",
"description" : "Returns complaint for provided official id",
"required" : true,
"type" : "integer",
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ComplaintItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/complaints/" : {
"get" : {
"tags" : [ "Complaints" ],
"summary" : "Get complaints",
"description" : "Returns complaints",
"operationId" : "listComplaints",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns complaints for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ComplaintListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cooperative/conveyances/{conveyanceKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get conveyance",
"description" : "DEPRECATED: see Share Conveyances",
"operationId" : "deprecatedListShareConveyances",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareConveyanceItemResponse"
}
}
}
}
},
"/v1/cooperative/conveyances/" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get conveyances",
"description" : "DEPRECATED: see Share Conveyances",
"operationId" : "deprecatedListShareConveyancesByParam",
"parameters" : [ {
"name" : "pocId",
"in" : "query",
"description" : "Returns conveyances for provided poc id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareKey",
"in" : "query",
"description" : "Returns conveyances for provided share key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns conveyances having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "municipalities",
"in" : "query",
"description" : "Returns conveyances for provided list of municipality numbers",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "registeredAfterTime",
"in" : "query",
"description" : "Returns conveyances with registered after time",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/sections/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get all sections for any given cadastre",
"description" : "",
"operationId" : "listCadastreSectionsForCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "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'",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pocs/{pocKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres with conveyance related to the location(address or plot) of the provided POC(Point of Conveyance)",
"description" : "",
"operationId" : "listCadastresByPoc",
"parameters" : [ {
"name" : "pocKey",
"in" : "path",
"description" : "Poc key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns cadastres from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres related to a building",
"description" : "",
"operationId" : "listCadastresByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres related to a building change",
"description" : "",
"operationId" : "listCadastresByBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Building change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres related to an address",
"description" : "",
"operationId" : "listCadastresByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/{streetKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres related to a street",
"description" : "",
"operationId" : "listCadastresByStreet",
"parameters" : [ {
"name" : "streetKey",
"in" : "path",
"description" : "Street key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/conveyances/{conveyanceKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres that are part of the conveyance",
"description" : "",
"operationId" : "listCadastresByConveyance",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "Conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/ownedcadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres that are part of the conveyance",
"description" : "",
"operationId" : "listCadastresByOwningPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Person key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/singleheritages/{singleHeritageKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres related to a single heritage",
"description" : "",
"operationId" : "listCadastresBySingleHeritage",
"parameters" : [ {
"name" : "singleHeritageKey",
"in" : "path",
"description" : "Single heritage key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/maincadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get main cadastres for a section",
"description" : "",
"operationId" : "listMainCadastresBySection",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre section key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/soilcontaminations/{soilContaminationKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for a soil contamination",
"description" : "",
"operationId" : "listCadastresBySoilContamination",
"parameters" : [ {
"name" : "soilContaminationKey",
"in" : "path",
"description" : "Soil contamination key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/complaints/{complaintKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for a complaint",
"description" : "",
"operationId" : "listCadastresByComplaint",
"parameters" : [ {
"name" : "complaintKey",
"in" : "path",
"description" : "Complaint key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/sectionings/{sectioningKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for a sectioning",
"description" : "",
"operationId" : "listCadastresBySectioning",
"parameters" : [ {
"name" : "sectioningKey",
"in" : "path",
"description" : "Sectioning key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/plots/{plotKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for a plot",
"description" : "",
"operationId" : "listCadastresByPlot",
"parameters" : [ {
"name" : "plotKey",
"in" : "path",
"description" : "Plot key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/realtyestateunits/{realtyEstateUnitKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for a realty estate unit",
"description" : "",
"operationId" : "listCadastresByRealtyEstateUnit",
"parameters" : [ {
"name" : "realtyEstateUnitKey",
"in" : "path",
"description" : "Realty estate unit key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/affairs/{affairKey}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres for an affair",
"description" : "",
"operationId" : "listCadastresByAffair",
"parameters" : [ {
"name" : "affairKey",
"in" : "path",
"description" : "Affair key",
"required" : true,
"type" : "string"
}, {
"name" : "roleInAffair",
"in" : "query",
"description" : "The cadastres role in provided affair",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{unitKey}/cadastre/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get the cadastre for a separately occupied unit",
"description" : "",
"operationId" : "getCadastreByUnit",
"parameters" : [ {
"name" : "unitKey",
"in" : "path",
"description" : "Separately occupied unit key",
"required" : true,
"type" : "string"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/landlot/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get the land lot (cadastre) for a housing cooperative share",
"description" : "",
"operationId" : "getCadastreByLandLotForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/ownerships/{ownershipKey}/ownedcadastre/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get the owned cadastre for an ownership",
"description" : "",
"operationId" : "getOwnedCadastreByOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Ownership key",
"required" : true,
"type" : "string"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/ownerships/{ownershipKey}/owningcadastre/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get the owning cadastre for an ownership",
"description" : "",
"operationId" : "getOwningCadastreByOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Ownership key",
"required" : true,
"type" : "string"
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/positions/{x},{y},{inputDatum}/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres by position",
"description" : "Returns cadastres at position",
"operationId" : "listCadastresByPosition",
"parameters" : [ {
"name" : "x",
"in" : "path",
"description" : "X/ easting",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "y",
"in" : "path",
"description" : "Y/ northing",
"required" : true,
"type" : "number",
"format" : "double"
}, {
"name" : "inputDatum",
"in" : "path",
"description" : "Geodetic datum",
"required" : true,
"type" : "string",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Geodetic datum in response. If not provided the inputDatum will be the default.",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "UTM33", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastre",
"description" : "Returns cadastre",
"operationId" : "getCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "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.",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "includeExtraFields",
"in" : "query",
"description" : "Include extra fields",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "true", "false" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/" : {
"get" : {
"tags" : [ "Cadastres" ],
"summary" : "Get cadastres",
"description" : "Returns cadastres",
"operationId" : "listCadastres",
"parameters" : [ {
"name" : "ownedByPersonKey",
"in" : "query",
"description" : "Returns cadastres owned by person for provided person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressId",
"in" : "query",
"description" : "DEPRECATED. Returns cadastres for provided address id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns cadastres for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "pocId",
"in" : "query",
"description" : "Returns cadastres for provided poc id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "conveyanceKey",
"in" : "query",
"description" : "Returns cadastres for provided conveyance key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns cadastres for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingChangeKey",
"in" : "query",
"description" : "Returns cadastres for provided building change key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "singleHeritageKey",
"in" : "query",
"description" : "Returns cadastres for provided single heritage key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "soilContaminationId",
"in" : "query",
"description" : "Returns cadastres for provided soil contamination id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "complaintKey",
"in" : "query",
"description" : "Returns cadastres for provided complaint key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "sectioningId",
"in" : "query",
"description" : "Returns cadastres for provided sectioning id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "plotKey",
"in" : "query",
"description" : "Returns cadastres for provided plot key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "realtyEstateUnitKey",
"in" : "query",
"description" : "Returns cadastres for provided realty estate unit key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "affairKey",
"in" : "query",
"description" : "Returns cadastres for provided affair key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "streetKey",
"in" : "query",
"description" : "Returns cadastres for provided street key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "mainCadastresBySectionKey",
"in" : "query",
"description" : "Returns main-cadastres for the provided cadastre-section key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "roleInAffair",
"in" : "query",
"description" : "Returns cadastres for specified role who participated in provided affair",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns cadastres from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/user" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Get logged in user",
"description" : "Returns logged in user",
"operationId" : "getLoggedInUser",
"parameters" : [ {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UserItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/objectscore/" : {
"get" : {
"tags" : [ "Cadastre Scores" ],
"summary" : "Get object score for a cadastre",
"description" : "",
"operationId" : "getCadastreObjectScore",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns cadastre score for provided official id
Example of official id for cadastre '1201-10-650-0-0'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/geojson/pocs/{pocId}" : {
"get" : {
"tags" : [ "Points of Conveyances" ],
"summary" : "Get POC GeoJSON",
"description" : "Returns POC GeoJSON",
"operationId" : "getPocGeoJSON",
"parameters" : [ {
"name" : "pocId",
"in" : "path",
"description" : "Returns POC for provided POC id",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/POCGeoJSONResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/geojson/pocs/" : {
"get" : {
"tags" : [ "Points of Conveyances" ],
"summary" : "Get POCs GeoJSON",
"description" : "Returns POCs GeoJSON",
"operationId" : "listPocsGeoJSON",
"parameters" : [ {
"name" : "eastingMin",
"in" : "query",
"description" : "Minimum easting for provided extent",
"required" : true,
"type" : "number",
"default" : -59448.67,
"format" : "double"
}, {
"name" : "northingMin",
"in" : "query",
"description" : "Minimum northing for provided extent",
"required" : true,
"type" : "number",
"default" : 6779504.82,
"format" : "double"
}, {
"name" : "eastingMax",
"in" : "query",
"description" : "Maximum easting for provided extent",
"required" : true,
"type" : "number",
"default" : -57557.26,
"format" : "double"
}, {
"name" : "northingMax",
"in" : "query",
"description" : "Maximum northing for provided extent",
"required" : true,
"type" : "number",
"default" : 6782860.09,
"format" : "double"
}, {
"name" : "fromDate",
"in" : "query",
"description" : "From date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD)",
"required" : false,
"type" : "string",
"default" : "2010"
}, {
"name" : "toDate",
"in" : "query",
"description" : "To date
Use the ISO 8601 date format (YYYY-MM-DD or YYYYMMDD)",
"required" : false,
"type" : "string",
"default" : "2019"
}, {
"name" : "groundUsage",
"in" : "query",
"description" : "Usage of ground
Use a combination of three characters: 'B' for residential or 'F' for recreational or 'A' for other",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/POCGeoJSONResponseCollection"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/organizations/{organizationKey}/accountant/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get accountant organization for a Housing Cooperative/ Corporation",
"description" : "",
"operationId" : "getAccountantOrganizationForCooperative",
"parameters" : [ {
"name" : "organizationKey",
"in" : "path",
"description" : "Official organization key for Housing Cooperative/ Corporation",
"required" : true,
"type" : "string"
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/accountant/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get accountant organization for a cadastre",
"description" : "",
"operationId" : "getAccountantOrganizationForCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/accountant/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get accountant organization for a cooperative share",
"description" : "",
"operationId" : "getAccountantOrganizationForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/simpleorganizations/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get organizations as simple list",
"description" : "Returns organizations by industry code as simple list",
"operationId" : "simplelistOrganizations",
"parameters" : [ {
"name" : "industryCode",
"in" : "query",
"description" : "The organization industry code(s) separated by ','",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeSubUnits",
"in" : "query",
"description" : "Include the sub unit",
"required" : false,
"type" : "string",
"default" : "false",
"enum" : [ "true" ]
}, {
"name" : "subUnitTypes",
"in" : "query",
"description" : "Specify sub unit types. exclude to get all. Including this sets includeSubUnits to true.",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "ORGL", "BEDR" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the organizations",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SimpleOrganizationListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/organizations/{organizationKey}" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get organization",
"description" : "Returns organization",
"operationId" : "getOrganization",
"parameters" : [ {
"name" : "organizationKey",
"in" : "path",
"description" : "Official organization key",
"required" : true,
"type" : "string"
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/organizations/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get organizations",
"description" : "Returns organizations by industry code or parent",
"operationId" : "listOrganizations",
"parameters" : [ {
"name" : "parentOrganizationKey",
"in" : "query",
"description" : "Will return all children of given organization. You cannot set industry code at the same time.",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeAllDescendants",
"in" : "query",
"description" : "Include all descendants or just one level of children",
"required" : false,
"type" : "string",
"default" : "false",
"enum" : [ "false", "true" ]
}, {
"name" : "industryCode",
"in" : "query",
"description" : "The organization industry code(s) separated by ','",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeSubUnits",
"in" : "query",
"description" : "Include the sub unit",
"required" : false,
"type" : "string",
"default" : "false",
"enum" : [ "false", "true" ]
}, {
"name" : "subUnitTypes",
"in" : "query",
"description" : "Specify sub unit types. exclude to get all. Including this sets includeSubUnits to true.",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "ORGL", "BEDR" ]
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "false", "true" ]
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the organizations",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/organizations/{organizationKey}/root/" : {
"get" : {
"tags" : [ "Organization" ],
"summary" : "Get root level organization",
"description" : "Returns root in conglomerate",
"operationId" : "getRootOrganization",
"parameters" : [ {
"name" : "organizationKey",
"in" : "path",
"description" : "Official organization key",
"required" : true,
"type" : "string"
}, {
"name" : "includeBrreg",
"in" : "query",
"description" : "Include information from Brønnøysund",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/OrganizationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/codefields/{codefieldKey}" : {
"get" : {
"tags" : [ "Code Fields" ],
"summary" : "Get codefield",
"description" : "Returns codefield",
"operationId" : "getCodeField",
"parameters" : [ {
"name" : "codefieldKey",
"in" : "path",
"description" : "Returns the codefield for the provided codefield key",
"required" : true,
"type" : "string"
}, {
"name" : "languageForm",
"in" : "query",
"description" : "The language form of the content",
"required" : false,
"type" : "string",
"default" : "B",
"enum" : [ "B", "N" ]
}, {
"name" : "state",
"in" : "query",
"description" : "The required state of each code",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CodeFieldItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/codefields/" : {
"get" : {
"tags" : [ "Code Fields" ],
"summary" : "Get all codefields",
"description" : "Returns all codefields",
"operationId" : "listCodeFields",
"parameters" : [ {
"name" : "languageForm",
"in" : "query",
"description" : "The language form of the content",
"required" : false,
"type" : "string",
"default" : "B",
"enum" : [ "B", "N" ]
}, {
"name" : "state",
"in" : "query",
"description" : "The required state of each code",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CodeFieldListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/buildings/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get buildings for a cadastre",
"description" : "",
"operationId" : "listBuildingsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "includeSections",
"in" : "query",
"description" : "Include sections",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/buildings/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get buildings for an address",
"description" : "",
"operationId" : "listBuildingsByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/singleheritages/{singleHeritageKey}/buildings/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get buildings for a single heritage",
"description" : "",
"operationId" : "listBuildingsBySingleHeritage",
"parameters" : [ {
"name" : "singleHeritageKey",
"in" : "path",
"description" : "Single heritage key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{unitKey}/building/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get the building for a separately occupied unit",
"description" : "",
"operationId" : "getBuildingByUnit",
"parameters" : [ {
"name" : "unitKey",
"in" : "path",
"description" : "Separately occupied unit key",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/building/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get the building for a share",
"description" : "",
"operationId" : "getBuildingByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/culturalheritages/{culturalHeritageKey}/buildings/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get buildings for a cultural heritage",
"description" : "",
"operationId" : "listBuildingsByCulturalHeritage",
"parameters" : [ {
"name" : "culturalHeritageKey",
"in" : "path",
"description" : "Cultural heritage key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/building/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get the building for a building change",
"description" : "",
"operationId" : "getBuildingByBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Building change key",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get building",
"description" : "Returns building",
"operationId" : "getBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Returns building for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/" : {
"get" : {
"tags" : [ "Buildings" ],
"summary" : "Get buildings",
"description" : "Returns buildings",
"operationId" : "listBuildings",
"parameters" : [ {
"name" : "singleHeritageKey",
"in" : "query",
"description" : "Returns buildings for provided single heritage key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns buildings for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "culturalHeritageKey",
"in" : "query",
"description" : "Returns buildings for provided cultural heritage key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "unitKey",
"in" : "query",
"description" : "Returns buildings for provided separately occupied unit key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressId",
"in" : "query",
"description" : "DEPRECATED. Returns buildings for provided address id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns buildings for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "floorId",
"in" : "query",
"description" : "Returns buildings for provided floor id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/BuildingListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/creationofrights/{rightKey}" : {
"get" : {
"tags" : [ "Creation Of Rights" ],
"summary" : "Get creation of right",
"description" : "",
"operationId" : "getRight",
"parameters" : [ {
"name" : "rightKey",
"in" : "path",
"description" : "Creation of right key",
"required" : true,
"type" : "string"
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details about this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includeRelatedRights",
"in" : "query",
"description" : "Include relatedRights for this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CreationOfRightItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/documents/{documentKey}/creationofrights/" : {
"get" : {
"tags" : [ "Creation Of Rights" ],
"summary" : "Get creation of rights by document key",
"description" : "",
"operationId" : "listRightsByDocument",
"parameters" : [ {
"name" : "documentKey",
"in" : "path",
"description" : "Document key",
"required" : true,
"type" : "string"
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details about this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeRelatedRights",
"in" : "query",
"description" : "Include relatedRights for this CreationOfRight",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "documentTypes",
"in" : "query",
"description" : "Mixed csv-list of document types (eg. OB_OBL), document codes (eg. OBL) or right types (eg. OB). Example 'OB_OBL, AH, ERK'",
"required" : false,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CreationOfRightsListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/accountantdata" : {
"get" : {
"tags" : [ "AccountantData" ],
"summary" : "Get accountant data",
"description" : "Returns aggregated housing and cooperative data for accountants. Exactly one of ownerOfficialNumber, cadastreKey, shareKey, or ownerKey must be provided.",
"operationId" : "getAccountantData",
"parameters" : [ {
"name" : "ownerOfficialNumber",
"in" : "query",
"description" : "Owner official number (provide exactly one search parameter)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Cadastre key (provide exactly one search parameter)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareKey",
"in" : "query",
"description" : "Share key (provide exactly one search parameter)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownerKey",
"in" : "query",
"description" : "Owner key (provide exactly one search parameter)",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cooperativeOrganizationNumber",
"in" : "query",
"description" : "Filter results by cooperative organization number",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ForretningsforerDataItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/search/shares/" : {
"get" : {
"tags" : [ "Shares Search" ],
"summary" : "Get shares",
"description" : "Search for shares",
"operationId" : "searchForShares",
"parameters" : [ {
"name" : "query",
"in" : "query",
"description" : "Free text search
Example for housing cooperative shares 'SMIBERG 7' - finds housing cooperative shares starting with provided name and share number",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "municipalityKey",
"in" : "query",
"description" : "Filter by municipality number",
"required" : false,
"type" : "string",
"default" : "null",
"x-example" : "4601"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "positions",
"in" : "query",
"description" : "Include positions in the result",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "datum",
"in" : "query",
"description" : "Set the geodetic datum",
"required" : false,
"type" : "string",
"default" : "UTM",
"enum" : [ "UTM", "WGS84" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareSearchListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/compound/personscore/{socialSecurityNumber}" : {
"get" : {
"tags" : [ "PersonScore" ],
"summary" : "Get person score",
"description" : "Returns a person score including customer score and home equity for the supplied social security number.",
"operationId" : "getPersonScore",
"parameters" : [ {
"name" : "socialSecurityNumber",
"in" : "path",
"description" : "Social security number of the person",
"required" : true,
"type" : "string"
}, {
"name" : "contentType",
"in" : "query",
"description" : "Response content type",
"required" : false,
"type" : "string",
"default" : "html",
"enum" : [ "json", "html", "pdf" ]
}, {
"name" : "yearsOfHistory",
"in" : "query",
"description" : "Number of years of history to include",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "state",
"in" : "query",
"description" : "Ownership state filter",
"required" : false,
"type" : "string",
"default" : "active_and_historical",
"enum" : [ "active", "active_and_historical" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PersonScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/sectionings/" : {
"get" : {
"tags" : [ "Sectionings" ],
"summary" : "Get sectionings for a cadastre",
"description" : "",
"operationId" : "listSectioningsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SectioningListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/sectionings/{sectioningKey}" : {
"get" : {
"tags" : [ "Sectionings" ],
"summary" : "Get sectioning",
"description" : "Returns sectioning",
"operationId" : "getSectioning",
"parameters" : [ {
"name" : "sectioningKey",
"in" : "path",
"description" : "Returns sectioning for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SectioningItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/sectionings/" : {
"get" : {
"tags" : [ "Sectionings" ],
"summary" : "Get sectionings",
"description" : "Returns sectionings",
"operationId" : "listSectionings",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns sectionings for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SectioningListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/soilcontaminations/" : {
"get" : {
"tags" : [ "Soil Contaminations" ],
"summary" : "Get soil contamination items for a cadastre",
"description" : "",
"operationId" : "listSoilContaminationsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SoilContaminationListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/soilcontaminations/{soilContaminationKey}" : {
"get" : {
"tags" : [ "Soil Contaminations" ],
"summary" : "Get soil contamination",
"description" : "Returns soil contamination",
"operationId" : "getSoilcontamination",
"parameters" : [ {
"name" : "soilContaminationKey",
"in" : "path",
"description" : "Returns soil contamination for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SoilContaminationItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/soilcontaminations/" : {
"get" : {
"tags" : [ "Soil Contaminations" ],
"summary" : "Get soil contamination items",
"description" : "Returns soil contamination items",
"operationId" : "listSoilContaminations",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns soil contamination items for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SoilContaminationListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/objectscore/" : {
"get" : {
"tags" : [ "Share Scores" ],
"summary" : "Get object score for a share",
"description" : "",
"operationId" : "getShareObjectScore",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Returns share score for provided official id
Example of official id for share '948946645-2'",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns share score having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareScoreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/separatelyoccupiedunits/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied units for a cadastre",
"description" : "",
"operationId" : "listUnitsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildings/{buildingKey}/separatelyoccupiedunits/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied units for a building",
"description" : "",
"operationId" : "listUnitsByBuilding",
"parameters" : [ {
"name" : "buildingKey",
"in" : "path",
"description" : "Building key",
"required" : true,
"type" : "string"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Cadastre key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/buildingchanges/{buildingChangeKey}/separatelyoccupiedunits/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get the building for a building change",
"description" : "",
"operationId" : "listUnitsByBuildingChange",
"parameters" : [ {
"name" : "buildingChangeKey",
"in" : "path",
"description" : "Building change key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/separatelyoccupiedunits/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied units for an address",
"description" : "",
"operationId" : "listUnitsByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/separatelyoccupiedunit/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied unit for a share",
"description" : "",
"operationId" : "getUnitByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/{separatelyOccupiedUnitKey}" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied unit",
"description" : "Returns separately occupied unit",
"operationId" : "getUnit",
"parameters" : [ {
"name" : "separatelyOccupiedUnitKey",
"in" : "path",
"description" : "Returns separately occupied unit for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/separatelyoccupiedunits/" : {
"get" : {
"tags" : [ "Separately Occupied Units" ],
"summary" : "Get separately occupied units",
"description" : "Returns separately occupied units",
"operationId" : "listUnits",
"parameters" : [ {
"name" : "buildingKey",
"in" : "query",
"description" : "Returns separately occupied units for provided building key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "buildingChangeKey",
"in" : "query",
"description" : "Returns separately occupied units for provided building change key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns separately occupied units for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "shareKey",
"in" : "query",
"description" : "Returns separately occupied units for provided share key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressId",
"in" : "query",
"description" : "DEPRECATED. Returns separately occupied units for provided address id",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns separately occupied units for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/unregisteredownershipsowningthiscadastre/" : {
"get" : {
"tags" : [ "Unregistered Ownerships" ],
"summary" : "Get unregistered ownerships by cadastre",
"description" : "",
"operationId" : "listUnregisteredOwnershipsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeTaxRoles",
"in" : "query",
"description" : "Include tax roles",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UnregisteredOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/unregisteredownershipsownedbythiscadastre/" : {
"get" : {
"tags" : [ "Unregistered Ownerships" ],
"summary" : "Get unregistered ownerships owned by this cadastre",
"description" : "",
"operationId" : "listUnregisteredOwnershipsOwnedByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Owned by this cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeTaxRoles",
"in" : "query",
"description" : "Include tax roles",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UnregisteredOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/unregisteredcadastreownerships/" : {
"get" : {
"tags" : [ "Unregistered Ownerships" ],
"summary" : "Get unregistered ownerships by person",
"description" : "",
"operationId" : "listUnregisteredOwnershipsByPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Person key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeTaxRoles",
"in" : "query",
"description" : "Include tax roles",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UnregisteredOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/unregisteredownerships/{unregisteredOwnershipKey}" : {
"get" : {
"tags" : [ "Unregistered Ownerships" ],
"summary" : "Get unregistered ownership",
"description" : "Returns unregistered ownership",
"operationId" : "getUnregisteredOwnership",
"parameters" : [ {
"name" : "unregisteredOwnershipKey",
"in" : "path",
"description" : "Returns unregistered ownership for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UnregisteredOwnershipItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/unregisteredownerships/" : {
"get" : {
"tags" : [ "Unregistered Ownerships" ],
"summary" : "Get unregistered ownerships",
"description" : "Returns unregistered ownerships",
"operationId" : "listUnregisteredOwnerships",
"parameters" : [ {
"name" : "ownedByCadastreKey",
"in" : "query",
"description" : "Returns unregistered ownerships owned by provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownedCadastreKey",
"in" : "query",
"description" : "Returns unregistered ownerships for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "personKey",
"in" : "query",
"description" : "Returns unregistered ownerships for provided person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns unregistered ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeTaxRoles",
"in" : "query",
"description" : "Include tax roles",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UnregisteredOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cooperative/ownerships/{ownershipKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get ownership",
"description" : "DEPRECATED: see Share Ownerships",
"operationId" : "deprecatedListShareOwnerships",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareOwnershipItemResponse"
}
}
}
}
},
"/v1/cooperative/ownerships/" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get ownerships",
"description" : "DEPRECATED: see Share Ownerships",
"operationId" : "deprecatedListShareOwnershipsByParam",
"parameters" : [ {
"name" : "shareKey",
"in" : "query",
"description" : "Returns ownership for provided share key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "personKey",
"in" : "query",
"description" : "Returns ownership for provided person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns ownership having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/dictionary/" : {
"get" : {
"tags" : [ "Dictionary" ],
"summary" : "Get dictionary",
"description" : "Returns dictionary",
"operationId" : "dictionary",
"parameters" : [ {
"name" : "languageFrom",
"in" : "query",
"description" : "Select the language to be used as keys in the dictionary map",
"required" : true,
"type" : "string",
"default" : "null"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Dictionary"
}
}
}
}
},
"/v1/cadastre/offices/{cadastreDocumentKey}" : {
"get" : {
"tags" : [ "Offices" ],
"summary" : "Get document ident based on key",
"description" : "Returns document ident based on key",
"operationId" : "getCadastreOffice",
"parameters" : [ {
"name" : "cadastreDocumentKey",
"in" : "path",
"description" : "Returns documentIdent for provided document key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOfficeItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/surroundinghousingvalues/" : {
"get" : {
"tags" : [ "Cadastre Housing Values" ],
"summary" : "Get surrounding housing values for a cadastre",
"description" : "Returns housing values",
"operationId" : "listSurroundingCadastreHousingValues",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "radius",
"in" : "query",
"description" : "Radius",
"required" : false,
"type" : "integer",
"default" : 2000,
"format" : "int32"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreHousingValueListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/housingvalue/" : {
"get" : {
"tags" : [ "Cadastre Housing Values" ],
"summary" : "Get housing value for a cadastre",
"description" : "",
"operationId" : "getCadastreHousingValue",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreHousingValueItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/property/ownerships/{ownershipKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get ownership",
"description" : "DEPRECATED",
"operationId" : "deprecatedGetCadastreOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "callback",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "null"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipItemResponse"
}
}
}
}
},
"/v1/property/ownerships/" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get ownerships",
"description" : "DEPRECATED: see Cadastre Ownerships",
"operationId" : "deprecatedListCadastreOwnerships",
"parameters" : [ {
"name" : "ownedByCadastreKey",
"in" : "query",
"description" : "Returns ownerships owned by provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "ownedCadastreKey",
"in" : "query",
"description" : "Returns ownerships for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "personKey",
"in" : "query",
"description" : "Returns ownerships for provided person key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/conveyances/" : {
"get" : {
"tags" : [ "Cadastre Conveyances" ],
"summary" : "Get conveyances for a cadastre",
"description" : "",
"operationId" : "listCadastreConveyancesByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns conveyances for a cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort results by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pocs/{pocKey}/cadastreconveyances/" : {
"get" : {
"tags" : [ "Cadastre Conveyances" ],
"summary" : "Get conveyances for a poc",
"description" : "",
"operationId" : "listCadastreConveyancesByPoc",
"parameters" : [ {
"name" : "pocKey",
"in" : "path",
"description" : "Poc key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Returns conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort results by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastre/conveyances/{conveyanceKey}" : {
"get" : {
"tags" : [ "Cadastre Conveyances" ],
"summary" : "Get conveyance",
"description" : "Returns conveyance",
"operationId" : "getCadastreConveyance",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "Returns conveyance for provided conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreConveyanceItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/ownershipsowningthisshare/" : {
"get" : {
"tags" : [ "Share Ownerships" ],
"summary" : "Get ownerships by share",
"description" : "",
"operationId" : "listShareOwnershipsByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns ownerships having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/shareownerships/" : {
"get" : {
"tags" : [ "Share Ownerships" ],
"summary" : "Get ownerships by person",
"description" : "",
"operationId" : "listShareOwnershipsByPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Person key, can be both anonymous person id, personal number and organization number",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns ownerships having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/ownerships/{ownershipKey}" : {
"get" : {
"tags" : [ "Share Ownerships" ],
"summary" : "Get ownership",
"description" : "Returns ownership",
"operationId" : "getShareOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Returns ownership for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareOwnershipItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/creationofrights/" : {
"get" : {
"tags" : [ "Creation Of Rights" ],
"summary" : "Get creation of rights related to a share",
"description" : "",
"operationId" : "getRightsForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "group",
"in" : "query",
"description" : "What group of rights to filter on",
"required" : true,
"type" : "string",
"enum" : [ "avtaler", "heftelser", "hjemmel", "uraadigheter" ]
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Filter on the share's max share-level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeRelatedRights",
"in" : "query",
"description" : "Include relatedRights for each right",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "registeredOrRemarkedAfterTime",
"in" : "query",
"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",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeDocumentStatuses",
"in" : "query",
"description" : "Which statuses to include. All are included by default",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "IK", "KO", "UK", "FJ", "NE", "NP", "RE" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RightsItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/creationofrights/" : {
"get" : {
"tags" : [ "Creation Of Rights" ],
"summary" : "Get creation of rights related to a cadastre",
"description" : "",
"operationId" : "getCadastreRight",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "group",
"in" : "query",
"description" : "What group of rights to filter on",
"required" : true,
"type" : "string",
"enum" : [ "leieavtaler", "grunndata", "heftelser", "hjemmel", "paategning_paa_eiere", "uraadigheter", "frivillig_pant", "tvangsforretninger", "rettigheter", "festeavtaler", "servitutter" ]
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Filter on the share's max cadastre-level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeDetails",
"in" : "query",
"description" : "Include details for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeFormatted",
"in" : "query",
"description" : "Include formatted data for each right",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeRelatedRights",
"in" : "query",
"description" : "Include relatedRights for each right",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on the state of the rights",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "registeredOrRemarkedAfterTime",
"in" : "query",
"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",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "includeDocumentStatuses",
"in" : "query",
"description" : "Which statuses to include. All are included by default",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "IK", "KO", "UK", "FJ", "NE", "NP", "RE" ]
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RightsItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/validation/" : {
"get" : {
"tags" : [ "Validate Cadastre Land Registry" ],
"summary" : "Validate the cadastre",
"description" : "",
"operationId" : "validateCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "includeInfo",
"in" : "query",
"description" : "Include info messages like previous cadastre",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ValidateCadastreItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/housingvalue/" : {
"get" : {
"tags" : [ "Share Housing Values" ],
"summary" : "Get housing value for a share",
"description" : "",
"operationId" : "getShareHousingValue",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareHousingValueItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/poc/{pocKey}/shareconveyances/" : {
"get" : {
"tags" : [ "Share Conveyances" ],
"summary" : "Get conveyances for a poc",
"description" : "",
"operationId" : "listShareConveyancesByPoc",
"parameters" : [ {
"name" : "pocKey",
"in" : "path",
"description" : "Poc key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/conveyances/" : {
"get" : {
"tags" : [ "Share Conveyances" ],
"summary" : "Get conveyances for a share",
"description" : "",
"operationId" : "listShareConveyancesByShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxShareLevel",
"in" : "query",
"description" : "Returns conveyances having the max share level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "freeMarketOnly",
"in" : "query",
"description" : "Conveyances from free market only",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "sortByDateDescending",
"in" : "query",
"description" : "Sort by date in descending order",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareConveyanceListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/share/conveyances/{conveyanceKey}" : {
"get" : {
"tags" : [ "Share Conveyances" ],
"summary" : "Get conveyance",
"description" : "Returns conveyance",
"operationId" : "getShareConveyance",
"parameters" : [ {
"name" : "conveyanceKey",
"in" : "path",
"description" : "Returns conveyance for provided conveyance key",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareConveyanceItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/addresses/{addressKey}/streets/" : {
"get" : {
"tags" : [ "Streets" ],
"summary" : "Get streets for an address",
"description" : "",
"operationId" : "listStreetsByAddress",
"parameters" : [ {
"name" : "addressKey",
"in" : "path",
"description" : "Address key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StreetListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/districts/{districtKey}/streets/" : {
"get" : {
"tags" : [ "Streets" ],
"summary" : "Get streets for a district",
"description" : "",
"operationId" : "listStreetsByDistrict",
"parameters" : [ {
"name" : "districtKey",
"in" : "path",
"description" : "District key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StreetListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/{streetKey}" : {
"get" : {
"tags" : [ "Streets" ],
"summary" : "Get street",
"description" : "Returns street",
"operationId" : "getStreet",
"parameters" : [ {
"name" : "streetKey",
"in" : "path",
"description" : "Returns street for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StreetItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/streets/" : {
"get" : {
"tags" : [ "Streets" ],
"summary" : "Get streets",
"description" : "Returns streets",
"operationId" : "listStreets",
"parameters" : [ {
"name" : "districtKey",
"in" : "query",
"description" : "Returns streets for provided district key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "addressKey",
"in" : "query",
"description" : "Returns street for provided address key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StreetListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/cadastrepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Cadastre PDF by cadastre",
"description" : "",
"operationId" : "getCadastrePDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/cadastre/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Cadastre PDF by cadastre",
"description" : "",
"operationId" : "getCadastrePDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/cadastrewithprivilegespdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Cadastre PDF by cadastre with privileges",
"description" : "",
"operationId" : "getCadastrePDFByCadastreWithPrivileges",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/cadastrewithprivileges/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Cadastre PDF by cadastre with privileges",
"description" : "",
"operationId" : "getCadastrePDFWithPrivileges",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/cadastrewithleaseholdowners/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Cadastre PDF by cadastre with leasehold owners",
"description" : "",
"operationId" : "getCadastrePDFByCadastreWithLeaseholdOwners",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/shares/{shareKey}/sharepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Share PDF by share",
"description" : "",
"operationId" : "getSharePDFByShare",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/share/{shareKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Share PDF by share",
"description" : "",
"operationId" : "getSharePDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/technicalcadastrepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Technical PDF by cadastre",
"description" : "",
"operationId" : "getTechnicalPDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/technical/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Technical PDF by cadastre",
"description" : "",
"operationId" : "getTechnicalPDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/simpletechnicalcadastrepdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Simple Technical PDF by cadastre",
"description" : "",
"operationId" : "getSimpleTechnicalPDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/pdfs/simpletechnical/{cadastreKey}" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Simple Technical PDF by cadastre",
"description" : "",
"operationId" : "getSimpleTechnicalPDF",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/ownershipsowningthiscadastre/" : {
"get" : {
"tags" : [ "Cadastre Ownerships" ],
"summary" : "Get ownerships by cadastre",
"description" : "",
"operationId" : "listOwnershipsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/ownershipsownedbythiscadastre/" : {
"get" : {
"tags" : [ "Cadastre Ownerships" ],
"summary" : "Get ownerships owned by this cadastre",
"description" : "",
"operationId" : "listOwnershipsOwnedByThisCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Owned by this cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/cadastreownerships/" : {
"get" : {
"tags" : [ "Cadastre Ownerships" ],
"summary" : "Get ownerships by person",
"description" : "",
"operationId" : "listOwnershipsByPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Person key, can be both anonymous person id, personal number and organization number",
"required" : true,
"type" : "string"
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships having the max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "state",
"in" : "query",
"description" : "Filter on state",
"required" : false,
"type" : "string",
"default" : "active",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
},
"413" : {
"description" : "Request entity too large"
}
}
}
},
"/v1/cadastre/ownerships/{ownershipKey}" : {
"get" : {
"tags" : [ "Cadastre Ownerships" ],
"summary" : "Get ownership",
"description" : "Returns ownership",
"operationId" : "getCadastreOwnership",
"parameters" : [ {
"name" : "ownershipKey",
"in" : "path",
"description" : "Returns ownership for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CadastreOwnershipItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/plots/" : {
"get" : {
"tags" : [ "Plots" ],
"summary" : "Get plots for a cadastre",
"description" : "",
"operationId" : "listPlotsByCadastre",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PlotListResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/plots/{plotKey}" : {
"get" : {
"tags" : [ "Plots" ],
"summary" : "Get plot",
"description" : "Returns plot",
"operationId" : "getPlot",
"parameters" : [ {
"name" : "plotKey",
"in" : "path",
"description" : "Returns plot for provided official id",
"required" : true,
"type" : "string"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PlotItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/plots/" : {
"get" : {
"tags" : [ "Plots" ],
"summary" : "Get plot",
"description" : "Returns plot",
"operationId" : "listPlots",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "query",
"description" : "Returns plots for provided cadastre key",
"required" : false,
"type" : "string",
"default" : "null"
}, {
"name" : "page",
"in" : "query",
"description" : "Start from page",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
}, {
"name" : "pagesize",
"in" : "query",
"description" : "Number of rows per page",
"required" : false,
"type" : "integer",
"default" : 10,
"format" : "int32"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/PlotItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/coordinates/" : {
"get" : {
"tags" : [ "Coordinates" ],
"summary" : "Get coordinates for cadastre",
"description" : "Returns coordinates for a given cadastre",
"operationId" : "listCadastreCoordinates",
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Returns cadastre for provided official id
Example of official id for cadastre '1201-10-650-0-0'",
"required" : true,
"type" : "string"
}, {
"name" : "includeInteriors",
"in" : "query",
"description" : "Include interiors",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "format",
"in" : "query",
"description" : "Return file format",
"required" : false,
"type" : "string",
"default" : "KOF"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/simplemappdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Simple Technical PDF by cadastre",
"description" : "",
"operationId" : "getSimpleMapPDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cadastres/{cadastreKey}/mappdf/" : {
"get" : {
"tags" : [ "PDF Orders" ],
"summary" : "Get Technical PDF by cadastre",
"description" : "",
"operationId" : "getMapPDFByCadastre",
"produces" : [ "application/pdf" ],
"parameters" : [ {
"name" : "cadastreKey",
"in" : "path",
"description" : "Cadastre key",
"required" : true,
"type" : "string"
}, {
"name" : "infolandOrderKey",
"in" : "query",
"description" : "Infoland order key",
"required" : true,
"type" : "string",
"default" : "null"
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/cooperative/housingvalues/{shareKey}" : {
"get" : {
"tags" : [ "Deprecated" ],
"summary" : "Get housing value for a share",
"description" : "DEPRECATED: see Share Housing Values",
"operationId" : "deprecatedGetHousingValueForShare",
"parameters" : [ {
"name" : "shareKey",
"in" : "path",
"description" : "Share key",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"deprecated" : true,
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ShareHousingValueItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
},
"/v1/persons/{personKey}/homeequity/" : {
"get" : {
"tags" : [ "Home Equities" ],
"summary" : "Get home equity by person",
"description" : "",
"operationId" : "getHomeEquityByPerson",
"parameters" : [ {
"name" : "personKey",
"in" : "path",
"description" : "Official key
Example of official key for a person - length 11
Example of official id for organization '948946645 S' - length 9",
"required" : true,
"type" : "string"
}, {
"name" : "roundEstimates",
"in" : "query",
"description" : "Round estimated value to nearest thousand",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "includeOwnershipCountWithState",
"in" : "query",
"description" : "Fetch ownerships with state",
"required" : false,
"type" : "string",
"default" : "null",
"enum" : [ "active", "historical", "active_and_historical" ]
}, {
"name" : "onlyMaxCadastreLevel",
"in" : "query",
"description" : "Returns ownerships for a cadastre with max cadastre level",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "Authorization",
"in" : "header",
"description" : "Token for logged in user.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/HomeEquityItemResponse"
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"404" : {
"description" : "Not found"
},
"500" : {
"description" : "Server error"
}
}
}
}
},
"definitions" : {
"AddressFormatted" : {
"type" : "object",
"required" : [ "line1", "line2" ],
"properties" : {
"line1" : {
"type" : "string",
"description" : "Street / Cadastral number"
},
"line2" : {
"type" : "string",
"description" : "Postal address"
},
"streetNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Street number"
},
"cityDistrict" : {
"description" : "City district with number, name and districtnumber",
"$ref" : "#/definitions/CityDistrict"
}
}
},
"AddressIdent" : {
"type" : "object",
"required" : [ "identType", "municipalityNumber" ],
"discriminator" : "identType",
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"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."
},
"identType" : {
"type" : "string",
"description" : "Is ident CadastralAddress or StreetAddress",
"enum" : [ "CadastralAddressIdent", "StreetAddressIdent" ]
}
}
},
"AddressItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ApiDate" : {
"type" : "object",
"required" : [ "ddmmyyyy", "isoDate", "isoDateTime", "timestamp" ],
"properties" : {
"timestamp" : {
"type" : "string",
"format" : "date",
"description" : "The date as yyyy-MM-dd"
},
"ddmmyyyy" : {
"type" : "string",
"description" : "The date as dd/MM-yyyy"
},
"isoDateTime" : {
"type" : "string",
"description" : "Datetime formatted following ISO-8601 with offset formatting rules"
},
"isoDate" : {
"type" : "string",
"description" : "Date formatted following ISO-8601 - without timepart - yyyy-MM-dd"
}
}
},
"CadastralAddressIdent" : {
"allOf" : [ {
"$ref" : "#/definitions/AddressIdent"
}, {
"type" : "object",
"properties" : {
"cadastralUnitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A cadastral unit represents the area of a farm. Filled out for Cadastral Addresses"
},
"unitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A unit represents a separate part of the farm area. Filled out for Cadastral Addresses"
},
"leaseholdUnitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A leasehold is a contract for the lease of some land. Filled out for Cadastral Addresses"
},
"subNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A subnumbering is a serial for separating cadastrals. Filled out for Cadastral Addresses"
}
}
} ]
},
"CadastreConveyanceListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreOwnershipListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CityDistrict" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"description" : "Key of city district"
},
"name" : {
"type" : "string",
"description" : "Name of city district"
},
"districtNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of district"
}
}
},
"Code" : {
"type" : "object",
"required" : [ "code" ],
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"text" : {
"type" : "string",
"description" : "The code description"
},
"active" : {
"type" : "boolean",
"description" : "true if the code is active, false if it is historical"
},
"links" : {
"$ref" : "#/definitions/CodeLinks"
}
}
},
"CodeFieldItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CodeLinks" : {
"type" : "object",
"properties" : {
"codeField" : {
"description" : "A link to the codefield with which the code is associated",
"$ref" : "#/definitions/CodeFieldItemLink"
}
}
},
"CustomerScoreItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Error" : {
"type" : "object",
"properties" : {
"returnCode" : {
"type" : "integer",
"format" : "int32",
"description" : "A predefined error code number, uses HTTP error codes",
"minimum" : 400,
"maximum" : 505
},
"message" : {
"type" : "string",
"description" : "Describes the error situation in detail"
}
}
},
"GeoJSONCrs" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"properties" : {
"$ref" : "#/definitions/GeoJSONProperties"
}
}
},
"GeoJSONFeature" : {
"type" : "object",
"required" : [ "crs", "type" ],
"properties" : {
"type" : {
"type" : "string"
},
"geometry" : {
"$ref" : "#/definitions/Geometry"
},
"bbox" : {
"type" : "array",
"description" : "Bounding box",
"items" : {
"type" : "number",
"format" : "double"
}
},
"properties" : {
"description" : "GeoJson properties",
"$ref" : "#/definitions/GeoJSONProperties"
},
"crs" : {
"$ref" : "#/definitions/GeoJSONCrs"
}
}
},
"GeoJSONObject" : {
"type" : "object",
"properties" : {
"bbox" : {
"type" : "array",
"description" : "Bounding box",
"items" : {
"type" : "number",
"format" : "double"
}
},
"properties" : {
"description" : "GeoJson properties",
"$ref" : "#/definitions/GeoJSONProperties"
}
}
},
"GeoJSONProperties" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"sourceOfPosition" : {
"type" : "string"
},
"realtyType" : {
"$ref" : "#/definitions/Code"
},
"links" : {
"$ref" : "#/definitions/POCLinks"
}
}
},
"Geometry" : {
"type" : "object",
"required" : [ "type" ],
"properties" : {
"bbox" : {
"type" : "array",
"description" : "Bounding box",
"items" : {
"type" : "number",
"format" : "double"
}
},
"properties" : {
"description" : "GeoJson properties",
"$ref" : "#/definitions/GeoJSONProperties"
},
"type" : {
"type" : "string"
}
}
},
"HomeEquityItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Info" : {
"type" : "object",
"properties" : {
"realtyCode" : {
"type" : "integer",
"format" : "int32",
"description" : "A predefined info code",
"minimum" : 100,
"maximum" : 999
},
"message" : {
"type" : "string",
"description" : "Describes the info in detail"
},
"links" : {
"type" : "array",
"description" : "A list of links to objects referenced in the Info message. It could be one or more cadastres",
"items" : {
"$ref" : "#/definitions/Link"
}
}
}
},
"Link" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Location" : {
"type" : "object",
"required" : [ "formatted" ],
"properties" : {
"addressIdent" : {
"description" : "The street address ident",
"$ref" : "#/definitions/AddressIdent"
},
"addressKey" : {
"type" : "string",
"description" : "The street address key"
},
"street" : {
"type" : "string",
"description" : "The street name"
},
"addressNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The house number on the street"
},
"letter" : {
"type" : "string",
"description" : "The house letter"
},
"alternativeAddress" : {
"type" : "string",
"description" : "An alternate name for the address"
},
"shortName" : {
"type" : "string",
"description" : "A short name for the address, not unique"
},
"sourceOfAddressName" : {
"description" : "Source of the address name",
"$ref" : "#/definitions/Code"
},
"postalCode" : {
"type" : "integer",
"format" : "int32",
"description" : "The postal code",
"minimum" : 0,
"maximum" : 9999
},
"postalPlace" : {
"type" : "string",
"description" : "The name of the district with this postal code"
},
"dwellingNumber" : {
"type" : "string",
"description" : "The apartment unit number"
},
"movedInDate" : {
"description" : "The date the resident moved in",
"$ref" : "#/definitions/ApiDate"
},
"formatted" : {
"description" : "Address formatted for presentation",
"$ref" : "#/definitions/AddressFormatted"
},
"municipality" : {
"description" : "Municipality",
"$ref" : "#/definitions/MunicipalityData"
},
"geojson" : {
"description" : "DEPRECATED. The map coordinates of this location as GeoJSON",
"$ref" : "#/definitions/GeoJSONObject"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
}
}
},
"Mortgagees" : {
"type" : "object",
"properties" : {
"mortgagees" : {
"type" : "array",
"description" : "The mortgagees of the right",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"receivers" : {
"type" : "array",
"description" : "The submitters of the right",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "The defendants of the right",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "The plaintiffs of the right",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "The legal representatives of the right",
"items" : {
"$ref" : "#/definitions/Person"
}
}
}
},
"MortgageesItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Mortgagees"
}
}
},
"MunicipalityData" : {
"type" : "object",
"required" : [ "municipalityName", "municipalityNumber", "regionName", "regionNumber" ],
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality number"
},
"municipalityName" : {
"type" : "string",
"description" : "The municipality name"
},
"regionNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The region number"
},
"regionName" : {
"type" : "string",
"description" : "The region name"
}
}
},
"OrganizationItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"POCItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"POCLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/POCItemLink"
},
"conveyancesOfCadastre" : {
"description" : "A link to the cadastre conveyances",
"$ref" : "#/definitions/CadastreConveyanceListLink"
},
"cadastres" : {
"description" : "A link to the cadastres",
"$ref" : "#/definitions/CadastreListLink"
},
"conveyancesOfShare" : {
"description" : "A link to the share conveyances",
"$ref" : "#/definitions/ShareConveyanceListLink"
},
"shares" : {
"description" : "A link to the shares",
"$ref" : "#/definitions/ShareListLink"
}
}
},
"Person" : {
"type" : "object",
"required" : [ "ident", "isCoveredBondsInstitution", "isLifeInsuranceInstitution", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/PersonIdent"
},
"key" : {
"type" : "string",
"description" : "An anonymous person id"
},
"birthday" : {
"type" : "string",
"description" : "DEPRECATED. The date of birth for this person"
},
"dateOfBirth" : {
"description" : "The date of birth for this person",
"$ref" : "#/definitions/ApiDate"
},
"organizationNumber" : {
"type" : "string",
"description" : "The organization number of this company"
},
"personalNumberType" : {
"description" : "The personal number type of this person",
"$ref" : "#/definitions/Code"
},
"sex" : {
"type" : "string",
"description" : "The sex of this person"
},
"age" : {
"type" : "integer",
"format" : "int32",
"description" : "The current age of the person"
},
"isNorwegianCitizen" : {
"type" : "boolean",
"description" : "If this person has Norwegian citizenship",
"enum" : [ true, false ]
},
"personalNumber" : {
"type" : "string",
"description" : "The official personal number of this person"
},
"givenName" : {
"type" : "string",
"description" : "The first name of this person"
},
"middleName" : {
"type" : "string",
"description" : "The middle name of this person"
},
"familyName" : {
"type" : "string",
"description" : "The last name of this person"
},
"name" : {
"type" : "string",
"description" : "The combined name of this person"
},
"shortName" : {
"type" : "string",
"description" : "The registered short name for a person"
},
"location" : {
"description" : "A location connected to the person based on the living address",
"$ref" : "#/definitions/Location"
},
"businessAddress" : {
"type" : "string",
"description" : "The address this organization has registered"
},
"postalAddress" : {
"type" : "string",
"description" : "The postal address of this person or organization"
},
"businessType" : {
"description" : "The business type of this organization",
"$ref" : "#/definitions/Code"
},
"industrialClassification" : {
"type" : "array",
"description" : "The industrial classification of this organization",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"isCoveredBondsInstitution" : {
"type" : "boolean",
"description" : "If this is an organisation that is a Covered Bonds Institution"
},
"isLifeInsuranceInstitution" : {
"type" : "boolean",
"description" : "If this is an organisation that is a Life Insurance Institution"
},
"numberMainUnit" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of main unit of this organization"
},
"deletionDate" : {
"description" : "The deletion date of this organization",
"$ref" : "#/definitions/ApiDate"
},
"foreignAddress" : {
"type" : "string",
"description" : "The foreign address of this person or organization"
},
"coAddress" : {
"type" : "string",
"description" : "The care of address of this person or organization"
},
"dsfState" : {
"description" : "The DSF state of this person",
"$ref" : "#/definitions/Code"
},
"currentDataSource" : {
"description" : "The current data source for this person",
"$ref" : "#/definitions/Code"
},
"hasProperty" : {
"type" : "boolean",
"description" : "If this person has property"
},
"summary" : {
"description" : "Contains summary data on the person",
"$ref" : "#/definitions/Summary"
},
"links" : {
"$ref" : "#/definitions/PersonLinks"
}
}
},
"PersonIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "An anonymous id representing a person or organization"
}
}
},
"PersonItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"PersonLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/PersonItemLink"
},
"ownedCadastres" : {
"description" : "The cadastres owned by this person",
"$ref" : "#/definitions/CadastreListLink"
},
"ownedShares" : {
"description" : "The shares owned by this person",
"$ref" : "#/definitions/ShareListLink"
},
"residence" : {
"description" : "The place this person lives",
"$ref" : "#/definitions/AddressItemLink"
},
"cadastreOwnerships" : {
"description" : "The person’s ownerships for owned properties",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"unregisteredCadastreOwnerships" : {
"description" : "The person’s unregistered ownerships for owned properties",
"$ref" : "#/definitions/UnregisteredOwnershipListLink"
},
"shareOwnerships" : {
"description" : "The person’s ownerships for owned cooperatives",
"$ref" : "#/definitions/ShareOwnershipListLink"
},
"customerScore" : {
"description" : "Scoring of this person",
"$ref" : "#/definitions/CustomerScoreItemLink"
},
"homeEquity" : {
"description" : "The person’s homeequity",
"$ref" : "#/definitions/HomeEquityItemLink"
},
"organization" : {
"description" : "The organization resource for this person",
"$ref" : "#/definitions/OrganizationItemLink"
}
}
},
"ShareConveyanceListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareOwnershipListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"StreetAddressIdent" : {
"allOf" : [ {
"$ref" : "#/definitions/AddressIdent"
}, {
"type" : "object",
"properties" : {
"streetNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The street number. Filled out for Street Addresses"
},
"addressNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The address number within a street. Filled out for Street Addresses"
},
"letter" : {
"type" : "string",
"description" : "The address letter for an address number. Filled out for Street Addresses"
}
}
} ]
},
"Summary" : {
"type" : "object",
"properties" : {
"numberOfCadastreOwnerships" : {
"type" : "integer",
"format" : "int32",
"description" : "Contains count of cadastre ownerships"
},
"numberOfShareOwnerships" : {
"type" : "integer",
"format" : "int32",
"description" : "Contains count of share ownerships"
},
"numberOfUnregisteredOwnerships" : {
"type" : "integer",
"format" : "int32",
"description" : "Contains count of unregistered ownerships"
},
"numberOfLeaseAgreements" : {
"type" : "integer",
"format" : "int32",
"description" : "Contains count of lease agreements"
}
}
},
"UnregisteredOwnershipListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Pagination" : {
"type" : "object",
"properties" : {
"previous" : {
"type" : "string",
"description" : "The previous page"
},
"next" : {
"type" : "string",
"description" : "The next page"
}
}
},
"PersonListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"PersonItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Person"
}
}
},
"Accountant" : {
"type" : "object",
"required" : [ "name", "organizationNumber", "supplierId" ],
"properties" : {
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization number"
},
"name" : {
"type" : "string",
"description" : "The organization name"
},
"supplierId" : {
"type" : "string",
"description" : "The internal data suppplier id"
}
}
},
"AccountantHousingData" : {
"type" : "object",
"required" : [ "key" ],
"properties" : {
"key" : {
"type" : "string"
},
"propertyNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Property number"
},
"propertyCode" : {
"type" : "string",
"description" : "Property code"
},
"propertyName" : {
"type" : "string",
"description" : "Property name"
},
"hasEnergyLabel" : {
"type" : "boolean",
"description" : "Indicates if the property has an energy label"
},
"address" : {
"description" : "Address information for the property",
"$ref" : "#/definitions/HousingDataAddress"
},
"municipality" : {
"description" : "Municipality information for the property",
"$ref" : "#/definitions/HousingDataMunicipality"
},
"housingType" : {
"type" : "string",
"description" : "Type of housing",
"enum" : [ "CADASTRE", "SHARE", "STOCK_BOND", "UNKNOWN" ]
},
"cadastre" : {
"description" : "Cadastre information",
"$ref" : "#/definitions/HousingDataCadastre"
},
"share" : {
"description" : "Share information",
"$ref" : "#/definitions/HousingDataShare"
},
"stockBond" : {
"description" : "Stock bond information",
"$ref" : "#/definitions/HousingDataShare"
},
"accountant" : {
"description" : "Accountant information",
"$ref" : "#/definitions/Accountant"
},
"cooperative" : {
"description" : "Housing cooperative information",
"$ref" : "#/definitions/HousingDataCooperative"
},
"owners" : {
"type" : "array",
"description" : "List of property owners",
"items" : {
"$ref" : "#/definitions/HousingOwner"
}
},
"dwellingUnitUuid" : {
"type" : "string",
"format" : "uuid",
"description" : "Dwelling unit UUID from Matrikkelen"
},
"dwellingUnitNumber" : {
"type" : "string",
"description" : "Dwelling unit number"
},
"otherNumber" : {
"type" : "string",
"description" : "Other number"
},
"sourceDataNotes" : {
"type" : "array",
"description" : "Additional information about the sourceData, for example if expected data was missing from the source",
"items" : {
"type" : "string"
}
},
"sourceDataComplete" : {
"type" : "boolean",
"description" : "Indicates if the sourceData was complete, false if for example expected data was missing from the source"
},
"links" : {
"$ref" : "#/definitions/AccountantHousingDataLinks"
}
}
},
"AccountantHousingDataItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"AccountantHousingDataItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/AccountantHousingData"
}
}
},
"AccountantHousingDataLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/AccountantHousingDataItemLink"
},
"share" : {
"description" : "Link to the Housing cooperative share in the Land Registry",
"$ref" : "#/definitions/ShareItemLink"
},
"cadastre" : {
"description" : "Link to the Cadastre in the Land Registry",
"$ref" : "#/definitions/CadastreItemLink"
},
"cooperative" : {
"description" : "Link to the Housing Cooperative Organization",
"$ref" : "#/definitions/OrganizationItemLink"
}
}
},
"CadastreIdent" : {
"type" : "object",
"required" : [ "cadastralUnitNumber", "leasehold", "leaseholdUnitNumber", "municipalityNumber", "section", "sectionNumber", "unitNumber" ],
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality number"
},
"cadastralUnitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The cadastral unit number"
},
"unitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The unit number"
},
"leaseholdUnitNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The leasehold unit number"
},
"sectionNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The section number"
},
"leasehold" : {
"type" : "boolean"
},
"section" : {
"type" : "boolean"
}
}
},
"CadastreItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"HousingDataAddress" : {
"type" : "object",
"properties" : {
"address" : {
"type" : "string",
"description" : "Street address"
},
"postalCode" : {
"type" : "string",
"description" : "Postal code"
},
"postalPlace" : {
"type" : "string",
"description" : "Postal place"
},
"formatted" : {
"description" : "Address formatted for presentation",
"$ref" : "#/definitions/AddressFormatted"
}
}
},
"HousingDataCadastre" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"key" : {
"type" : "string",
"description" : "Unique key for the cadastre"
},
"ident" : {
"description" : "Cadastre identifier",
"$ref" : "#/definitions/CadastreIdent"
}
}
},
"HousingDataCooperative" : {
"type" : "object",
"properties" : {
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Organization number of the housing cooperative"
},
"internalId" : {
"type" : "integer",
"format" : "int32",
"description" : "Internal ID of the housing cooperative"
},
"name" : {
"type" : "string",
"description" : "Name of the housing cooperative"
},
"type" : {
"type" : "string",
"description" : "Type of housing cooperative"
},
"isAffiliatedToHousingConstructionCompany" : {
"type" : "boolean",
"description" : "Indicates if the cooperative is affiliated to a housing construction company"
},
"hasBoardApproval" : {
"type" : "boolean",
"description" : "Indicates if the cooperative has board approval"
},
"responableBoardApproval" : {
"type" : "string",
"description" : "Responsible entity for board approval"
},
"hasPreEmptiveRight" : {
"type" : "boolean",
"description" : "Indicates if there is a pre-emptive right"
},
"typeOfPreEmptiveRight" : {
"type" : "string",
"description" : "Type of pre-emptive right"
},
"responsibleForClarififyingPreEmptiveRight" : {
"type" : "string",
"description" : "Responsible entity for clarifying pre-emptive right"
},
"electronicPreAnnouncementPossible" : {
"type" : "boolean",
"description" : "Indicates if electronic pre-announcement (forhåndsutlysing) is possible"
},
"electronicSalesNotificationPossible" : {
"type" : "boolean",
"description" : "Indicates if electronic sales notification (salgsmelding) is possible"
}
}
},
"HousingDataMunicipality" : {
"type" : "object",
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Municipality number"
},
"municipalityName" : {
"type" : "string",
"description" : "Municipality name"
}
}
},
"HousingDataShare" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"description" : "Share key"
},
"ident" : {
"description" : "Share ident",
"$ref" : "#/definitions/ShareIdent"
}
}
},
"HousingOwner" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Type of housing owner",
"enum" : [ "PERSON", "ORGANIZATION", "INTERNAL_USER" ]
},
"officialNumber" : {
"type" : "string",
"description" : "Official number of the housing owner"
},
"name" : {
"type" : "string",
"description" : "Name of the housing owner"
},
"givenName" : {
"type" : "string",
"description" : "Given name of the housing owner"
},
"familyName" : {
"type" : "string",
"description" : "Family name of the housing owner"
}
}
},
"ShareIdent" : {
"type" : "object",
"required" : [ "organizationNumber", "shareNumber" ],
"properties" : {
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization that owns the cooperative"
},
"shareNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The unique share number in a cooperative"
}
}
},
"ShareItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"AccountantHousingDataListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/AccountantHousingData"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"ApiDateTime" : {
"type" : "object",
"required" : [ "ddmmyyyyHHmm", "isoDateTime", "timestamp" ],
"properties" : {
"timestamp" : {
"type" : "string",
"format" : "date",
"description" : "The date as yyyy-MM-dd "
},
"ddmmyyyyHHmm" : {
"type" : "string",
"description" : "The date as dd/MM-yyyy HH:mm"
},
"isoDateTime" : {
"type" : "string",
"description" : "Datetime formatted following ISO-8601 with offset formatting rules"
}
}
},
"CadastreEncumbranceShare" : {
"type" : "object",
"properties" : {
"fraction" : {
"description" : "The encumbrance share fraction",
"$ref" : "#/definitions/Fraction"
},
"person" : {
"description" : "The person who has this share",
"$ref" : "#/definitions/Person"
}
}
},
"CadastreLien" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"registeredDate" : {
"description" : "The date this lien was registered",
"$ref" : "#/definitions/ApiDate"
},
"cadastreLevel" : {
"description" : "The cadastre level this lien was registered on",
"$ref" : "#/definitions/Code"
},
"priority" : {
"type" : "integer",
"format" : "int32",
"description" : "A number defining the priority of this lien, lower number having higher priority"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"currentAmounts" : {
"type" : "array",
"description" : "The current amount of the lien",
"items" : {
"$ref" : "#/definitions/Money"
}
},
"originalAmounts" : {
"type" : "array",
"description" : "The original amount of the lien",
"items" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "List of the persons holding the mortgage",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"cadastreShares" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CadastreEncumbranceShare"
}
},
"remarks" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "List of the persons suing in this enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "List of the persons prosecuted in this enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "List of legal persons registered on the enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"attachmentDate" : {
"description" : "The date the enforcement were held",
"$ref" : "#/definitions/ApiDateTime"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"isEnforcement" : {
"type" : "boolean",
"description" : "Indicates if this lien is an enforcement"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"numberOfCadastres" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of cadastres affected by this lien"
},
"links" : {
"$ref" : "#/definitions/LienLinks"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"outstandingDebt" : {
"description" : "Outstanding debt for this lien",
"$ref" : "#/definitions/OutstandingDebt"
}
}
},
"CadastreLiensCalculation" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string"
},
"isInterpretable" : {
"type" : "boolean",
"description" : "Can be interpreted"
},
"hasForeignCurrency" : {
"type" : "boolean",
"description" : "Is in a foreign currency"
},
"reasonsNotInterpretable" : {
"type" : "array",
"description" : "List of reasons why the lien cannot be interpreted",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"pledge" : {
"description" : "The pledge",
"$ref" : "#/definitions/CadastrePledge"
},
"liens" : {
"type" : "array",
"description" : "List of liens",
"items" : {
"$ref" : "#/definitions/CadastreLien"
}
},
"hasSovereigntyLimitation" : {
"type" : "boolean",
"description" : "True if lien reduces owners sovereign"
},
"hasRightOfResidence" : {
"type" : "boolean",
"description" : "True if this lien has a right of residence"
},
"hasMonetaryEncumbranceEasement" : {
"type" : "boolean",
"description" : "True if this lien has an easement with a monetary encumbrance"
},
"hasPreemptive" : {
"type" : "boolean",
"description" : "True if this lien has a preemptive right"
},
"hasRightOfUse" : {
"type" : "boolean",
"description" : "True if this lien has right of use"
},
"hasEasement" : {
"type" : "boolean",
"description" : "True if this lien has an easement"
},
"hasLeaseAgreement" : {
"type" : "boolean",
"description" : "True if there are lease agreements"
},
"hasLeaseholdAgreement" : {
"type" : "boolean",
"description" : "True if there are leasehold agreements"
},
"links" : {
"$ref" : "#/definitions/CadastreLiensCalculationLinks"
}
}
},
"CadastreLiensCalculationItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreLiensCalculationItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreLiensCalculation"
}
}
},
"CadastreLiensCalculationLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CadastreLiensCalculationItemLink"
},
"cadastre" : {
"description" : "The current cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"cadastrePDF" : {
"description" : "A PDF of this cadastre from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"objectScore" : {
"description" : "A link to the objectscore on this cadastre",
"$ref" : "#/definitions/CadastreScoreItemLink"
}
}
},
"CadastrePledge" : {
"type" : "object",
"required" : [ "sumPledge" ],
"properties" : {
"sumPledge" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum pledge for the ownership in realties. Fractions are taken into account in the calculation."
},
"numberOfPledges" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of pledges"
},
"sumMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "The sum of the amounts on all the mortgages"
},
"sumOutstandingMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of the calculated outstanding mortgages"
},
"numberOfMortgages" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of mortgages"
},
"sumEnforcement" : {
"type" : "integer",
"format" : "int64",
"description" : "The sum of the amounts on all enforcements"
},
"numberOfEnforcements" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of enforcements"
},
"hasPledgeSecuringBond" : {
"type" : "boolean",
"description" : "True if a securing bond is present"
},
"hasPledgingStatement" : {
"type" : "boolean",
"description" : "True if a pledging statement is present"
},
"hasMortgageWithForeignCurrency" : {
"type" : "boolean",
"description" : "If mortgages in this pledge have currency code <> 'NOK'"
},
"hasEnforcementWithForeignCurrency" : {
"type" : "boolean",
"description" : "If enforcements in this pledge have currency code <> 'NOK'"
}
}
},
"CadastreScoreItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CreationOfRightIdent" : {
"type" : "object",
"required" : [ "documentKey", "documentNumber", "documentYear", "office", "rightNumber" ],
"properties" : {
"office" : {
"type" : "integer",
"format" : "int32",
"description" : "The juridical office where this document belongs to"
},
"documentYear" : {
"type" : "integer",
"format" : "int32",
"description" : "The year this document was registered"
},
"documentNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The serial number of this document"
},
"rightNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The creation of right number inside this document"
},
"documentKey" : {
"type" : "string"
}
}
},
"Fraction" : {
"type" : "object",
"properties" : {
"numerator" : {
"type" : "integer",
"format" : "int64",
"description" : "The numerator of the fraction"
},
"denominator" : {
"type" : "integer",
"format" : "int64",
"description" : "The denominator of the fraction"
}
}
},
"LienLinks" : {
"type" : "object",
"properties" : {
"creationOfRightPDF" : {
"description" : "PDF for this Creation of right",
"$ref" : "#/definitions/PDFItemLink"
}
}
},
"Money" : {
"type" : "object",
"required" : [ "amount", "currency" ],
"properties" : {
"currency" : {
"description" : "The type of currency as a code",
"$ref" : "#/definitions/Code"
},
"amount" : {
"type" : "integer",
"format" : "int64",
"description" : "The amount of currency"
},
"text" : {
"type" : "string",
"description" : "A text field with extra information"
},
"amountInNok" : {
"type" : "integer",
"format" : "int64",
"description" : "The amount converted to NOK. Present only if conversion is possible"
}
}
},
"OutstandingDebt" : {
"type" : "object",
"required" : [ "amount" ],
"properties" : {
"amount" : {
"type" : "integer",
"format" : "int64",
"description" : "The amount of outstanding debt"
},
"updated" : {
"description" : "When the outstanding debt was last updated",
"$ref" : "#/definitions/ApiDateTime"
}
}
},
"PDFItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Address" : {
"type" : "object",
"required" : [ "addressType", "eventStatus", "formatted", "ident", "key", "municipality", "postalPlace" ],
"properties" : {
"ident" : {
"description" : "The street address or cadastral address ident",
"$ref" : "#/definitions/AddressIdent"
},
"key" : {
"type" : "string",
"description" : "The address ident"
},
"updatedDate" : {
"description" : "The address update date",
"$ref" : "#/definitions/ApiDate"
},
"formatted" : {
"description" : "Address formatted for presentation",
"$ref" : "#/definitions/AddressFormatted"
},
"addressType" : {
"description" : "Type of address. Cadastral-address(M) or Street-address(O)",
"$ref" : "#/definitions/Code"
},
"municipality" : {
"description" : "Municipality for this this address",
"$ref" : "#/definitions/MunicipalityData"
},
"postalPlace" : {
"description" : "Postal place for this address",
"$ref" : "#/definitions/PostalPlace"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"eventStatus" : {
"type" : "integer",
"format" : "int32",
"description" : "Whether the address is active (0) or historical (1)",
"minimum" : 0,
"maximum" : 1
},
"alternativeAddress" : {
"type" : "string",
"description" : "An alternate name for the address"
},
"shortName" : {
"type" : "string",
"description" : "A short name for the address, not unique"
},
"sourceOfAddressName" : {
"description" : "Source of the address name",
"$ref" : "#/definitions/Code"
},
"street" : {
"description" : "The street if the address has one",
"$ref" : "#/definitions/Street"
},
"geojson" : {
"description" : "DEPRECATED. The position of the address in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"hasShare" : {
"type" : "boolean",
"description" : "If the person has a share"
},
"hasHousing" : {
"type" : "boolean",
"description" : "If the person has housing"
},
"hasHolidayHome" : {
"type" : "boolean",
"description" : "If the person has a holiday home"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/AddressLinks"
}
}
},
"AddressLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/AddressItemLink"
},
"cadastres" : {
"description" : "The cadastres connected to this address",
"$ref" : "#/definitions/CadastreListLink"
},
"buildings" : {
"description" : "The buildings connected to this address",
"$ref" : "#/definitions/BuildingListLink"
},
"units" : {
"description" : "The units connected to this address",
"$ref" : "#/definitions/SeparatelyOccupiedUnitListLink"
},
"districts" : {
"description" : "The districts this address is contained within",
"$ref" : "#/definitions/DistrictListLink"
},
"shares" : {
"description" : "The shares this address is contained within",
"$ref" : "#/definitions/ShareListLink"
},
"street" : {
"description" : "The street of this address",
"$ref" : "#/definitions/StreetListLink"
}
}
},
"AddressListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"AddressListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Address"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"BuildingListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"DistrictListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Extent" : {
"type" : "object",
"required" : [ "nw", "se" ],
"properties" : {
"se" : {
"description" : "The lower left corner on the map",
"$ref" : "#/definitions/Position"
},
"nw" : {
"description" : "The upper right corner on the map",
"$ref" : "#/definitions/Position"
}
}
},
"GeoJSONFeatureCollection" : {
"type" : "object",
"required" : [ "crs", "features", "type" ],
"properties" : {
"type" : {
"type" : "string"
},
"bbox" : {
"type" : "array",
"description" : "Bounding box",
"items" : {
"type" : "number",
"format" : "double"
}
},
"features" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/GeoJSONFeature"
}
},
"crs" : {
"$ref" : "#/definitions/GeoJSONCrs"
},
"properties" : {
"description" : "GeoJson properties",
"$ref" : "#/definitions/GeoJSONProperties"
}
}
},
"Position" : {
"type" : "object",
"properties" : {
"e" : {
"type" : "number",
"format" : "double",
"description" : "The easting coordinate"
},
"n" : {
"type" : "number",
"format" : "double",
"description" : "The northing coordinate"
}
}
},
"PostalPlace" : {
"type" : "object",
"required" : [ "postalCode", "postalCodeStr", "postalPlace" ],
"properties" : {
"postalCode" : {
"type" : "integer",
"format" : "int32",
"description" : "The postal code"
},
"postalCodeStr" : {
"type" : "string",
"description" : "The postal code as a four character string"
},
"postalPlace" : {
"type" : "string",
"description" : "The postal code name"
}
}
},
"SeparatelyOccupiedUnitListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Street" : {
"type" : "object",
"required" : [ "ident", "key", "postalCode", "postalPlace", "postalPlaces", "streetName" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/StreetIdent"
},
"key" : {
"type" : "string",
"description" : "The municipality and street number"
},
"streetName" : {
"type" : "string",
"description" : "The name of the street"
},
"postalCode" : {
"type" : "integer",
"format" : "int32",
"description" : "The postal code the street is in"
},
"postalPlace" : {
"type" : "string",
"description" : "The postal code name"
},
"postalPlaces" : {
"type" : "array",
"description" : "A list of the postal places this street runs through",
"items" : {
"$ref" : "#/definitions/PostalPlace"
}
},
"extent" : {
"description" : "The extent of this street based on the outer address coordinates connected to the street",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "The extent of this street in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeatureCollection"
},
"municipality" : {
"description" : "The municipality where this street is located",
"$ref" : "#/definitions/MunicipalityData"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"description" : "The links for a street",
"$ref" : "#/definitions/StreetLinks"
}
}
},
"StreetIdent" : {
"type" : "object",
"required" : [ "municipalityNumber", "streetNumber" ],
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality the street is in"
},
"streetNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The street number"
}
}
},
"StreetItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"StreetLinestringLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"StreetLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/StreetItemLink"
},
"cadastres" : {
"description" : "The cadastres related to this street",
"$ref" : "#/definitions/CadastreListLink"
},
"addresses" : {
"description" : "The addresses related to this street",
"$ref" : "#/definitions/AddressListLink"
},
"districts" : {
"description" : "The districts this street concerns",
"$ref" : "#/definitions/DistrictListLink"
},
"linestring" : {
"description" : "The linestring of this street",
"$ref" : "#/definitions/StreetLinestringLink"
}
}
},
"StreetListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"AddressItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Address"
}
}
},
"Administration" : {
"type" : "object",
"properties" : {
"administratorType" : {
"description" : "The type/role of administrators",
"$ref" : "#/definitions/Code"
},
"administrators" : {
"type" : "array",
"description" : "The administrators",
"items" : {
"$ref" : "#/definitions/Person"
}
}
}
},
"CadastreLevelRelation" : {
"type" : "object",
"required" : [ "cadastreIdent", "cadastreKey", "isActive" ],
"properties" : {
"cadastreLevel" : {
"$ref" : "#/definitions/LevelCode"
},
"cadastreIdent" : {
"$ref" : "#/definitions/CadastreIdent"
},
"cadastreKey" : {
"type" : "string"
},
"municipality" : {
"description" : "The municipality the cadastre resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"fraction" : {
"$ref" : "#/definitions/Fraction"
},
"isActive" : {
"type" : "boolean"
}
}
},
"CadastreScoreRight" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"isEnforcement" : {
"type" : "boolean",
"description" : "Indicates if the right is an enforcement"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"deletedDate" : {
"description" : "Deletion date",
"$ref" : "#/definitions/ApiDate"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"timeDeleted" : {
"description" : "Deletion time",
"$ref" : "#/definitions/ApiDateTime"
},
"currentAmounts" : {
"type" : "object",
"description" : "The current amounts registered on the rights",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"originalAmounts" : {
"type" : "object",
"description" : "The original amounts registered on the rights",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "The mortgagees",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "The plaintiffs",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "The defendants",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "The legal representatives",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"administration" : {
"description" : "The administrators of the plaintiffs possessions",
"$ref" : "#/definitions/Administration"
},
"personsWithLicense" : {
"type" : "array",
"description" : "List of persons that have license",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"cadastresWithLicense" : {
"type" : "array",
"description" : "List of cadastres that have license",
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"outstandingDebt" : {
"description" : "Outstanding debt",
"$ref" : "#/definitions/OutstandingDebt"
},
"links" : {
"$ref" : "#/definitions/ScoreRightLinks"
}
}
},
"CustomerScore" : {
"type" : "object",
"required" : [ "customerName", "ident", "isScorable", "key" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/PersonIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"customerName" : {
"type" : "string",
"description" : "The customers name"
},
"isScorable" : {
"type" : "boolean",
"description" : "Indicates if scoring for this person is possible"
},
"reasonNotScorable" : {
"type" : "string",
"description" : "If not scorable, this string contains the reason"
},
"overallRisk" : {
"description" : "The overall/total risk of providing a loan to this person",
"$ref" : "#/definitions/Code"
},
"ownedCadastresWithoutPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of cadastres not mortgaged / containing no liens"
},
"ownedSharesWithoutPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of shares not mortgaged / containing no liens"
},
"highRisks" : {
"type" : "object",
"description" : "Collection of all possible high risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"mediumRisks" : {
"type" : "object",
"description" : "Collection of all possible medium risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"lowRisks" : {
"type" : "object",
"description" : "Collection of all possible low risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"mortgagesSummary" : {
"description" : "Summary of the persons mortgages",
"$ref" : "#/definitions/CustomerScoreMortgagesSummary"
},
"links" : {
"$ref" : "#/definitions/CustomerScoreLinks"
}
}
},
"CustomerScoreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CustomerScore"
}
}
},
"CustomerScoreLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CustomerScoreItemLink"
},
"customer" : {
"description" : "Link to the current customer",
"$ref" : "#/definitions/PersonItemLink"
},
"cadastreOwnerships" : {
"description" : "The person’s ownerships on cadastres",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"shareOwnerships" : {
"description" : "The person’s ownerships on housing cooperative shares",
"$ref" : "#/definitions/ShareOwnershipListLink"
},
"homeEquity" : {
"description" : "The person’s homeequity",
"$ref" : "#/definitions/HomeEquityItemLink"
}
}
},
"CustomerScoreMortgagesSummary" : {
"type" : "object",
"required" : [ "activeSummary", "historicalSummary" ],
"properties" : {
"activeSummary" : {
"description" : "Summary of active mortgages",
"$ref" : "#/definitions/CustomerScoreMortgagesSummaryDetails"
},
"historicalSummary" : {
"description" : "Summary of historical mortgages",
"$ref" : "#/definitions/CustomerScoreMortgagesSummaryDetails"
}
}
},
"CustomerScoreMortgagesSummaryDetails" : {
"type" : "object",
"properties" : {
"sumMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of mortgages"
},
"numberOfMortgages" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of mortgages"
},
"sumMortgageCadastre" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of mortgages on cadastres"
},
"numberOfMortgagesOnCadastres" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of mortgages on cadastres"
},
"sumMortgageShare" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of mortgages on housing cooperative shares"
},
"numberOfMortgagesOnShares" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of mortgages on housing cooperative shares"
},
"sumOutstandingMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of outstanding mortgage"
},
"sumOutstandingMortgageCadastre" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of outstanding mortgage on cadastres"
},
"sumOutstandingMortgageShare" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of outstanding mortgage on shares"
},
"hasPledgeSecuringBond" : {
"type" : "boolean",
"description" : "If has pledge securing bond"
},
"hasActivePledgingStatement" : {
"type" : "boolean",
"description" : "If has active pledging statement"
},
"hasListedMortgage" : {
"type" : "boolean",
"description" : "If has listed mortgage"
},
"hasMortgageWithForeignCurrency" : {
"type" : "boolean",
"description" : "If mortgages have currency code <> 'NOK'"
},
"mortgagesOnCadastres" : {
"type" : "object",
"description" : "Mortgages on cadastres",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreScoreRight"
}
},
"mortgagesOnShares" : {
"type" : "object",
"description" : "Mortgages on shares",
"additionalProperties" : {
"$ref" : "#/definitions/ShareScoreRight"
}
}
}
},
"LevelCode" : {
"type" : "object",
"required" : [ "code" ],
"properties" : {
"code" : {
"type" : "string",
"description" : "The code"
},
"registerCode" : {
"type" : "string",
"description" : "The register code"
},
"text" : {
"type" : "string",
"description" : "The code description"
},
"active" : {
"type" : "boolean",
"description" : "true if the code is active, false if it is historical"
},
"links" : {
"$ref" : "#/definitions/CodeLinks"
}
}
},
"Risk" : {
"type" : "object",
"required" : [ "description", "isPresent", "riskOnObject", "shortDescription" ],
"properties" : {
"isPresent" : {
"type" : "boolean",
"description" : "Indicating whether this risk is present or not"
},
"description" : {
"type" : "string",
"description" : "A description of this risk"
},
"shortDescription" : {
"type" : "string",
"description" : "A short description of this risk"
},
"riskOnObject" : {
"type" : "string",
"description" : "Type of object this risk is related to"
},
"cadastreRights" : {
"type" : "array",
"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.",
"items" : {
"$ref" : "#/definitions/CadastreScoreRight"
}
},
"shareRights" : {
"type" : "array",
"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.",
"items" : {
"$ref" : "#/definitions/ShareScoreRight"
}
}
}
},
"ScoreRightLinks" : {
"type" : "object",
"properties" : {
"creationOfRightPDF" : {
"description" : "PDF for this Creation of right",
"$ref" : "#/definitions/PDFItemLink"
}
}
},
"ShareRelation" : {
"type" : "object",
"properties" : {
"shareIdent" : {
"$ref" : "#/definitions/ShareIdent"
},
"shareKey" : {
"type" : "string"
},
"housingCooperativeName" : {
"type" : "string"
},
"isActive" : {
"type" : "boolean"
}
}
},
"ShareScoreRight" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"isEnforcement" : {
"type" : "boolean",
"description" : "Indicates if the right is an enforcement"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"deletedDate" : {
"description" : "Deletion date",
"$ref" : "#/definitions/ApiDate"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"currentAmounts" : {
"type" : "object",
"description" : "The current amounts registered on the rights",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"originalAmounts" : {
"type" : "object",
"description" : "The original amounts registered on the rights",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "The mortgagees",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "The plaintiffs",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "The defendants",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "The legal representatives",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"documentHolder" : {
"type" : "array",
"description" : "The document holder",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"administration" : {
"description" : "The administrators of the plaintiffs possessions",
"$ref" : "#/definitions/Administration"
},
"personsWithLicense" : {
"type" : "array",
"description" : "List of persons that have license",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"sharesWithLicense" : {
"type" : "array",
"description" : "List of shares that have license",
"items" : {
"$ref" : "#/definitions/ShareRelation"
}
},
"outstandingDebt" : {
"description" : "Outstanding debt",
"$ref" : "#/definitions/OutstandingDebt"
},
"links" : {
"$ref" : "#/definitions/ShareScoreRightLinks"
}
}
},
"ShareScoreRightLinks" : {
"type" : "object",
"properties" : {
"creationOfRightPDF" : {
"description" : "PDF for this Creation of right",
"$ref" : "#/definitions/PDFItemLink"
}
}
},
"Affair" : {
"type" : "object",
"required" : [ "affairDocumentDate", "ident", "key", "landRegistryRegisteredDate", "referenceToMunicipalArchive", "typeOfAffair" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/AffairIdent"
},
"key" : {
"type" : "string",
"description" : "The affair key"
},
"typeOfAffair" : {
"description" : "The type of affair",
"$ref" : "#/definitions/Code"
},
"landRegistryRegisteredDate" : {
"description" : "The date the affair was registered in the Land registry",
"$ref" : "#/definitions/ApiDate"
},
"affairDocumentDate" : {
"description" : "The document date of the affair",
"$ref" : "#/definitions/ApiDate"
},
"referenceToMunicipalArchive" : {
"type" : "string",
"description" : "An reference to the municipal archive"
},
"otherReference" : {
"type" : "string",
"description" : "Other reference"
},
"cadastreAffairs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CadastreAffair"
}
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/AffairLinks"
}
}
},
"AffairIdent" : {
"type" : "object",
"required" : [ "affairSerialNumber" ],
"properties" : {
"affairSerialNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The unique serialnumber of an affair"
}
}
},
"AffairItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"AffairLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/AffairItemLink"
},
"cedingCadastres" : {
"description" : "The ceding cadastres connected to this affair",
"$ref" : "#/definitions/CadastreListLink"
},
"receivingCadastres" : {
"description" : "The receiving cadastres connected to this affair",
"$ref" : "#/definitions/CadastreListLink"
},
"affectedCadastres" : {
"description" : "The affected cadastres connected to this affair",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"AffairListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Affair"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CadastreAffair" : {
"type" : "object",
"required" : [ "area", "cadastreIdent", "roleInAffair" ],
"properties" : {
"cadastreIdent" : {
"$ref" : "#/definitions/CadastreIdent"
},
"roleInAffair" : {
"description" : "The role of the affair. Ceder, receiver or affected",
"$ref" : "#/definitions/Code"
},
"area" : {
"type" : "number",
"format" : "double",
"description" : "The area that the cadastre has ceded, received or which has been affected by this affair"
}
}
},
"AffairItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Affair"
}
}
},
"AffairListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Agriculture" : {
"type" : "object",
"properties" : {
"updatedDate" : {
"description" : "When was this data updated",
"$ref" : "#/definitions/ApiDate"
},
"cadastreIdent" : {
"description" : "The ident of the cadastre this area belongs to",
"$ref" : "#/definitions/CadastreIdent"
},
"cadastreKey" : {
"type" : "string",
"description" : "The cadastre key"
},
"agriculturalArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Agricultural area in acres"
},
"otherArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Area where the use is not specified in acres"
},
"forestArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Forest area in acres"
},
"fullGrownArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Full grown areas in acres"
},
"cultivatedArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Cultivated area in acres"
},
"pastureArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Pasture area in acres"
},
"specifiedArea" : {
"type" : "number",
"format" : "double",
"description" : "The area of the cadastre that is specified as opposed to measured area in square meters"
},
"areaSource" : {
"description" : "The source of the specified area",
"$ref" : "#/definitions/Code"
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the agriculture is historical in the land registry"
},
"isHistoricalTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the agriculture is historical in the technical land registry"
},
"companies" : {
"type" : "array",
"description" : "Organization companies connected to cadastre",
"items" : {
"$ref" : "#/definitions/AgricultureCompany"
}
},
"links" : {
"$ref" : "#/definitions/AgricultureLinks"
}
}
},
"AgricultureCompany" : {
"type" : "object",
"properties" : {
"updatedDate" : {
"description" : "When was this data updated",
"$ref" : "#/definitions/ApiDate"
},
"orgnr" : {
"type" : "integer",
"format" : "int32",
"description" : "Organization number connected to farm"
},
"producerNumber8" : {
"type" : "string",
"description" : "Eigth digit producer number"
},
"producerNumber10" : {
"type" : "string",
"description" : "Ten digit producer number"
},
"links" : {
"$ref" : "#/definitions/AgricultureCompanyLinks"
}
}
},
"AgricultureCompanyLinks" : {
"type" : "object",
"properties" : {
"organization" : {
"description" : "A link to the organization for this agricultural company",
"$ref" : "#/definitions/OrganizationItemLink"
}
}
},
"AgricultureLinks" : {
"type" : "object",
"properties" : {
"operatingUnit" : {
"description" : "A link to the agricultural unit",
"$ref" : "#/definitions/OperatingUnitItemLink"
},
"cadastre" : {
"description" : "A link to the cadastre this unit is connected to",
"$ref" : "#/definitions/CadastreItemLink"
},
"buildings" : {
"description" : "The buildings on the cadastre this unit is connected to",
"$ref" : "#/definitions/BuildingListLink"
}
}
},
"Building" : {
"type" : "object",
"required" : [ "hasElevator", "ident", "key", "municipalityNumber", "numberOfFloors", "numberOfUnits" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/BuildingIdent"
},
"key" : {
"type" : "string",
"description" : "The building number"
},
"updatedDate" : {
"description" : "The building update date",
"$ref" : "#/definitions/ApiDate"
},
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality number"
},
"municipality" : {
"description" : "The municipality this building resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"numberOfUnits" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of occupied units in the building"
},
"hasElevator" : {
"type" : "boolean",
"description" : "If the building has a registered elevator",
"enum" : [ true, false ]
},
"numberOfFloors" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of floors in the building"
},
"totalFloorSpace" : {
"type" : "number",
"format" : "double",
"description" : "The total usable area inside the building"
},
"totalAreaOfPrimarySpace" : {
"type" : "number",
"format" : "double",
"description" : "The total living area inside the building"
},
"areaOfSecondarySpace" : {
"type" : "number",
"format" : "double",
"description" : "The total area not used for living inside the building"
},
"incompleteArea" : {
"type" : "boolean",
"description" : "Whether the area is measured fully or not"
},
"builtUpArea" : {
"type" : "number",
"format" : "double",
"description" : "Area that is built on"
},
"totalArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building, including walls"
},
"totalAreaHousing" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building used for living"
},
"totalAlternateArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building not used for living"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"geojson" : {
"description" : "DEPRECATED. The position of the building in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"buildingStatus" : {
"description" : "The building status",
"$ref" : "#/definitions/Code"
},
"typeOfBuilding" : {
"description" : "The type of this building",
"$ref" : "#/definitions/Code"
},
"industryGroup" : {
"description" : "The industrial use of this building",
"$ref" : "#/definitions/Code"
},
"waterSupplyType" : {
"description" : "The source of water used by this building",
"$ref" : "#/definitions/Code"
},
"dischargeType" : {
"description" : "The type of discharge used by this building",
"$ref" : "#/definitions/Code"
},
"originType" : {
"description" : "How this building was registered into the system",
"$ref" : "#/definitions/Code"
},
"heatingType" : {
"type" : "array",
"description" : "The type of heating this building primarily uses",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"energySourceType" : {
"type" : "array",
"description" : "The type of energy source this building primarily uses",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"approvedDate" : {
"description" : "The date the building plans were approved",
"$ref" : "#/definitions/ApiDate"
},
"registeredApprovedDate" : {
"description" : "The registered date the building plans were approved",
"$ref" : "#/definitions/ApiDate"
},
"startedDate" : {
"description" : "The date the construction of this building started",
"$ref" : "#/definitions/ApiDate"
},
"registeredStartedDate" : {
"description" : "The registered date the construction of this building started",
"$ref" : "#/definitions/ApiDate"
},
"usedDate" : {
"description" : "The date this building was taken taken into use",
"$ref" : "#/definitions/ApiDate"
},
"registeredUsedDate" : {
"description" : "The registered date this building was taken taken into use",
"$ref" : "#/definitions/ApiDate"
},
"buildingStatusHistory" : {
"type" : "array",
"description" : "The building status history",
"items" : {
"$ref" : "#/definitions/BuildingStatusHistory"
}
},
"floors" : {
"type" : "array",
"description" : "The registered floor information for this building.",
"items" : {
"$ref" : "#/definitions/Floor"
}
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"fromSection" : {
"type" : "boolean",
"description" : "Whether this building was fetched from an underlying section, not the main cadastre. Only present when query param includeSections is used."
},
"links" : {
"$ref" : "#/definitions/BuildingLinks"
}
}
},
"BuildingChangeItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"BuildingChangeListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"BuildingIdent" : {
"type" : "object",
"required" : [ "buildingNumber" ],
"properties" : {
"buildingNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A unique number that identifies a building"
}
}
},
"BuildingItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"BuildingLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/BuildingItemLink"
},
"singleheritages" : {
"description" : "The single heritages connected to this building",
"$ref" : "#/definitions/SingleHeritageListLink"
},
"buildingchanges" : {
"description" : "The modifications made to this building",
"$ref" : "#/definitions/BuildingChangeListLink"
},
"culturalheritages" : {
"description" : "Cultural heritages this building belongs to",
"$ref" : "#/definitions/CulturalHeritageListLink"
},
"cadastres" : {
"description" : "The cadastre this building is placed upon",
"$ref" : "#/definitions/CadastreListLink"
},
"addresses" : {
"description" : "The addresses connected to this building",
"$ref" : "#/definitions/AddressListLink"
},
"units" : {
"description" : "The units inside this building",
"$ref" : "#/definitions/SeparatelyOccupiedUnitListLink"
},
"contacts" : {
"description" : "The registered contacts to the construction of this building",
"$ref" : "#/definitions/PersonListLink"
},
"developers" : {
"description" : "The registered developers of this building",
"$ref" : "#/definitions/PersonListLink"
},
"floors" : {
"description" : "The floors contained in this building",
"$ref" : "#/definitions/FloorListLink"
}
}
},
"BuildingStatusHistory" : {
"type" : "object",
"properties" : {
"buildingStatus" : {
"$ref" : "#/definitions/Code"
},
"buildingStatusDate" : {
"$ref" : "#/definitions/ApiDate"
},
"buildingStatusRegisteredDate" : {
"$ref" : "#/definitions/ApiDate"
}
}
},
"Cadastre" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string"
},
"position" : {
"description" : "The position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"extent" : {
"description" : "DEPRECATED. The extent of this cadastre",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "DEPRECATED. The extent of this realty in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"municipality" : {
"description" : "The municipality this cadastre resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"isSectioned" : {
"type" : "boolean",
"description" : "Whether the cadastre is sectioned in the technical land registry"
},
"condominium" : {
"description" : "The condominium (eierseksjonssameie) this section belongs to",
"$ref" : "#/definitions/Condominium"
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the land registry"
},
"isHistoricalTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the technical land registry"
},
"isRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is registered in the land registry"
},
"isTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is registered in the technical land registry"
},
"canBeMortgaged" : {
"type" : "boolean",
"description" : "Whether it is possible to add a mortgage to the cadastre"
},
"canBeSold" : {
"type" : "boolean",
"description" : "Whether the cadastre is sellable"
},
"propertyType" : {
"description" : "The cadastre type",
"$ref" : "#/definitions/Code"
},
"establishedDate" : {
"description" : "The date this cadastre was created",
"$ref" : "#/definitions/ApiDate"
},
"unitName" : {
"type" : "string",
"description" : "The name of this cadastre unit"
},
"specifiedArea" : {
"type" : "number",
"format" : "double",
"description" : "The area of the cadastre that is specified as opposed to measured area"
},
"areaSource" : {
"description" : "The source of the specified area",
"$ref" : "#/definitions/Code"
},
"unregisteredFarmCommonsArea" : {
"type" : "number",
"format" : "double",
"description" : "The area of a unregistered farm commons"
},
"areaSourceForUnregisteredFarmCommons" : {
"description" : "The source of the unregistered farm commons area",
"$ref" : "#/definitions/Code"
},
"disputedPlotArea" : {
"type" : "number",
"format" : "double",
"description" : "The area of a disputed plot"
},
"areaSourceForDisputedPlot" : {
"description" : "The source of the disputed plot area",
"$ref" : "#/definitions/Code"
},
"sharedArea" : {
"type" : "number",
"format" : "double",
"description" : "The area of a shared area"
},
"areaSourceForSharedArea" : {
"description" : "The source of the shared area",
"$ref" : "#/definitions/Code"
},
"areaMainCadastre" : {
"type" : "number",
"format" : "double",
"description" : "The area of the main cadastre, only present on sections"
},
"areaSourceForMainCadastre" : {
"description" : "The source of the shared area",
"$ref" : "#/definitions/Code"
},
"landTaxation" : {
"type" : "number",
"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"
},
"pointHitch" : {
"type" : "boolean",
"description" : "Whether a leasehold is tied to a geographic point (true) or is measured land (false)"
},
"newRegistration" : {
"type" : "boolean",
"description" : "Whether the cadastre is registered from new land. Most cadastres come from other cadastres"
},
"agriculturalCadastre" : {
"type" : "boolean",
"description" : "Whether the cadastre is an agricultural cadastre"
},
"agriculture" : {
"description" : "Agricultural information about this cadastre",
"$ref" : "#/definitions/Agriculture"
},
"industryGroup" : {
"description" : "The industrial use of this cadastre",
"$ref" : "#/definitions/Code"
},
"expired" : {
"type" : "boolean",
"description" : "Whether this cadastre has expired"
},
"hasActiveLeasedLand" : {
"type" : "boolean",
"description" : "Whether there are any active leaseholds on this cadastre"
},
"hasNotedComplaint" : {
"type" : "boolean",
"description" : "Whether there are registered any noted complaints on this cadastre"
},
"hasRegisteredLandAcquisition" : {
"type" : "boolean",
"description" : "Whether there are registered land acquisition on this cadastre"
},
"hasRegisteredLandConsolidationRequired" : {
"type" : "boolean",
"description" : "Whether there are registered land consolidation required on this cadastre"
},
"hasOldCadastre" : {
"type" : "boolean",
"description" : "Whether it is possible to create an Old Cadastre PDF based on this cadastre"
},
"includedInTotalRealEstate" : {
"type" : "boolean",
"description" : "Whether this cadastre are included in total real estate"
},
"hasSingleHeritage" : {
"type" : "boolean",
"description" : "Whether there are registered any single heritage on this cadastre"
},
"hasSoilContamination" : {
"type" : "boolean",
"description" : "Whether there are registered any soil contamination on this cadastre"
},
"hasHousing" : {
"type" : "boolean",
"description" : "Whether this cadastre has any separately occupied units of type housing"
},
"hasHolidayHome" : {
"type" : "boolean",
"description" : "Whether this cadastre has any separately occupied units of type holiday home"
},
"concession" : {
"description" : "Specifies the concession rules that apply to this cadastre",
"$ref" : "#/definitions/Code"
},
"zeroConcession" : {
"type" : "boolean",
"description" : "Liability to reside on the cadastre"
},
"zeroConcessionMessage" : {
"type" : "string",
"description" : "Extra information you should check if cadastre is registered with zeroConcession"
},
"hasBuilding" : {
"type" : "boolean",
"description" : "Whether this cadastre has any buildings at all"
},
"hasBuildingApprovedForConstruction" : {
"type" : "boolean",
"description" : "Whether this cadastre has a building approved for construction"
},
"maxCadastreLevel" : {
"description" : "The maximum cadastre level of this cadastres ownerships",
"$ref" : "#/definitions/LevelCode"
},
"numberOfPlots" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of plots"
},
"sourceSystem" : {
"description" : "The system in which the cadastre was registered",
"$ref" : "#/definitions/Code"
},
"currentSectioning" : {
"description" : "If this cadastre is a section, this field contains data about the current sectioning",
"$ref" : "#/definitions/CadastreSectioning"
},
"cityDistrict" : {
"description" : "The city district this cadastre is located in",
"$ref" : "#/definitions/CityDistrict"
},
"promDerived" : {
"type" : "integer",
"format" : "int32",
"description" : "A field which derives PROM for this cadastre for an external source"
},
"promSource" : {
"description" : "The source from which the PROM has been derived",
"$ref" : "#/definitions/Code"
},
"ownedByCooperative" : {
"type" : "boolean",
"description" : "True if owned by a cooperative"
},
"ownedByCorporation" : {
"type" : "boolean",
"description" : "True if owned by a cooperation"
},
"ownedByHousingCorporation" : {
"type" : "boolean",
"description" : "True if owned by a housing cooperation"
},
"MatrikkelenId" : {
"type" : "integer",
"format" : "int64",
"description" : "A separate id to identify a cadastre in Matrikkelen"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"postalPlace" : {
"description" : "Postal place for this cadastre",
"$ref" : "#/definitions/PostalPlace"
},
"links" : {
"$ref" : "#/definitions/CadastreLinks"
}
}
},
"CadastreConveyance" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"feeBasis" : {
"type" : "integer",
"format" : "int64",
"description" : "Basis for calculation of fee"
},
"feeCause" : {
"description" : "Cause of fee",
"$ref" : "#/definitions/Code"
},
"purchasePrice" : {
"type" : "integer",
"format" : "int64",
"description" : "The purchase price"
},
"currency" : {
"description" : "The currency of the purchase",
"$ref" : "#/definitions/Code"
},
"hasMarketValue" : {
"type" : "boolean",
"description" : "Whether the purchase price was at market value"
},
"containsBuilding" : {
"type" : "boolean",
"description" : "Whether the realty bought contains one or more buildings"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
},
"numberOfCadastresInConveyance" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of cadastres related to this conveyance"
},
"appliesToEntireCadastre" : {
"type" : "boolean",
"description" : "If this conveyance applies to entire cadastres. All ownership fractions are whole."
},
"links" : {
"$ref" : "#/definitions/CadastreConveyanceLinks"
}
}
},
"CadastreConveyanceItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreConveyanceLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/CadastreConveyanceItemLink"
},
"buyers" : {
"description" : "The list of buyers",
"$ref" : "#/definitions/PersonListLink"
},
"sellers" : {
"description" : "The list of sellers",
"$ref" : "#/definitions/PersonListLink"
},
"cadastres" : {
"description" : "The list of cadastres this conveyance applies to",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"CadastreExtended" : {
"type" : "object",
"required" : [ "cadastre" ],
"properties" : {
"cadastre" : {
"$ref" : "#/definitions/Cadastre"
},
"address" : {
"$ref" : "#/definitions/Address"
},
"units" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitExtended"
}
},
"latestConveyance" : {
"$ref" : "#/definitions/CadastreConveyance"
},
"liensCalculation" : {
"$ref" : "#/definitions/CadastreLiensCalculation"
},
"cadastreOwnerships" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CadastreOwnership"
}
}
}
},
"CadastreExtendedItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreExtended"
}
}
},
"CadastreHousingValueItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreHousingValueListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreLandRegistryItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CadastreItemLink"
},
"owners" : {
"description" : "The owners of this cadastre",
"$ref" : "#/definitions/PersonListLink"
},
"buildings" : {
"description" : "The buildings on this cadastre",
"$ref" : "#/definitions/BuildingListLink"
},
"soilContaminations" : {
"description" : "The contaminations on this cadastre",
"$ref" : "#/definitions/SoilContaminationListLink"
},
"complaints" : {
"description" : "The registered complaints on this cadastre",
"$ref" : "#/definitions/ComplaintListLink"
},
"sectionings" : {
"description" : "The sectionings of this cadastre",
"$ref" : "#/definitions/SectioningListLink"
},
"sections" : {
"description" : "The sections of this cadastre",
"$ref" : "#/definitions/CadastreListLink"
},
"plots" : {
"description" : "The plots that this cadastre consists of",
"$ref" : "#/definitions/PlotListLink"
},
"realtyEstateUnits" : {
"description" : "The realty estate this cadastre belongs to",
"$ref" : "#/definitions/RealtyEstateUnitListLink"
},
"conveyances" : {
"description" : "The conveyances of this cadastre",
"$ref" : "#/definitions/CadastreConveyanceListLink"
},
"addresses" : {
"description" : "The addresses on this cadastre",
"$ref" : "#/definitions/AddressListLink"
},
"units" : {
"description" : "The occupied units on this cadastre",
"$ref" : "#/definitions/SeparatelyOccupiedUnitListLink"
},
"shares" : {
"description" : "The cooperative shares on this cadastre",
"$ref" : "#/definitions/ShareListLink"
},
"singleHeritages" : {
"description" : "The heritages on this cadastre",
"$ref" : "#/definitions/SingleHeritageListLink"
},
"objectScore" : {
"description" : "The objectscore on this cadastre",
"$ref" : "#/definitions/CadastreScoreItemLink"
},
"ownedByOwnerships" : {
"description" : "DEPRECATED. Ownerships where this cadastre is being owned",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"ownershipsOwningThisCadastre" : {
"description" : "Ownerships where this cadastre is being owned",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"ownedOwnerships" : {
"description" : "DEPRECATED. Ownerships where this cadastre acts as an owner",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"ownershipsOwnedByThisCadastre" : {
"description" : "Ownerships where this cadastre acts as an owner",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"unregisteredOwnershipsOwnedByThisCadastre" : {
"description" : "Unregistered ownerships where this cadastre acts as an owner",
"$ref" : "#/definitions/UnregisteredOwnershipListLink"
},
"unregisteredOwnershipsOwningThisCadastre" : {
"description" : "Unregistered ownerships where this cadastre is being owned",
"$ref" : "#/definitions/UnregisteredOwnershipListLink"
},
"affairs" : {
"description" : "The affairs on this cadastre",
"$ref" : "#/definitions/AffairListLink"
},
"cadastrePDF" : {
"description" : "A PDF of this cadastre from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"cadastreWithPrivilegesPDF" : {
"description" : "A PDF of this cadastre with privileges from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"historicalCadastrePDF" : {
"description" : "A historical PDF of this cadastre from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"oldCadastrePDF" : {
"description" : "A PDF of this cadastre from the Old Land Registry. These are hand written.",
"$ref" : "#/definitions/PDFItemLink"
},
"technicalPDF" : {
"description" : "A PDF of this cadastre from the Technical Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"simpleTechnicalPDF" : {
"description" : "A simpler PDF of this cadastre from the Technical Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"mapPDF" : {
"description" : "A PDF with map of this cadastre from the Technical Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"simpleMapPDF" : {
"description" : "A simple PDF with only a map of this cadastre from the Technical Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"mainCadastres" : {
"description" : "The main cadastres of this section",
"$ref" : "#/definitions/CadastreListLink"
},
"liensCalculation" : {
"description" : "The lien calculation for this cadastre",
"$ref" : "#/definitions/CadastreLiensCalculationItemLink"
},
"housingValue" : {
"description" : "The housing value for this cadastre",
"$ref" : "#/definitions/CadastreHousingValueItemLink"
},
"surroundingHousingValues" : {
"description" : "Housing values surrounding this cadastre",
"$ref" : "#/definitions/CadastreHousingValueListLink"
},
"presentationAddress" : {
"description" : "The presentation address for this cadastre",
"$ref" : "#/definitions/AddressItemLink"
},
"accountantData" : {
"description" : "Accountant data for this cadastre",
"$ref" : "#/definitions/AccountantHousingDataItemLink"
},
"landRegistry" : {
"description" : "The presentation of the land registry for this cadastre",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"polygon" : {
"description" : "The polygon of this cadastre",
"$ref" : "#/definitions/CadastrePolygonLink"
}
}
},
"CadastreOwnership" : {
"type" : "object",
"required" : [ "cadastreLevel", "ident", "isActive", "isMaxCadastreLevel", "isOwnedObjectActive", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreOwnershipIdent"
},
"municipality" : {
"description" : "The municipality the owned cadastre resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"key" : {
"type" : "string"
},
"registered" : {
"type" : "boolean",
"description" : "Whether this ownership is registered in the Land Registry"
},
"ownedCadastreIdent" : {
"description" : "Ident of the owned cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"ownedCadastreKey" : {
"type" : "string",
"description" : "Owned cadastre key"
},
"cadastreLevel" : {
"description" : "Specifies what kind of ownership the owner has on the cadastre",
"$ref" : "#/definitions/LevelCode"
},
"isMaxCadastreLevel" : {
"type" : "boolean",
"description" : "Specifies if this ownership is on the maximum ownership level of the cadastre"
},
"fraction" : {
"description" : "Specifies the size of an ownership as a fraction",
"$ref" : "#/definitions/Fraction"
},
"useOfCadastre" : {
"description" : "The use of the realty as defined by the purchaser",
"$ref" : "#/definitions/Code"
},
"dwellingType" : {
"description" : "The type of the dwelling as defined by the owner",
"$ref" : "#/definitions/Code"
},
"ownerType" : {
"description" : "Owner type. Can be CADASTRE or PERSON",
"$ref" : "#/definitions/Code"
},
"owningPerson" : {
"description" : "If owner type is PERSON then this contains the owning person",
"$ref" : "#/definitions/Person"
},
"owningCadastreIdent" : {
"description" : "If owner type is CADASTRE then this contains the ident of the owning cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"numberOfOwnersOnLevel" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owners on the level specified by cadastreLevel"
},
"isResidence" : {
"type" : "boolean",
"description" : "Whether the owningPerson lives on this cadastre"
},
"isActive" : {
"type" : "boolean",
"description" : "Specifies if this ownership active"
},
"isOwnedObjectActive" : {
"type" : "boolean",
"description" : "Specifies if the owned cadastre is active"
},
"bought" : {
"description" : "Data about the conveyance when this ownership was bought. Deprecated: use 'started' instead.",
"$ref" : "#/definitions/RightReference"
},
"sold" : {
"description" : "Data about the conveyance when this ownership was sold. Deprecated: use 'ended' instead.",
"$ref" : "#/definitions/RightReference"
},
"started" : {
"description" : "The right that started this ownership (acquisition — deed for sales, other rettsstiftelsestyper for non-sale transitions)",
"$ref" : "#/definitions/RightReference"
},
"ended" : {
"description" : "The right that ended this ownership (deed for sales, or the rettsstiftelse that made the property/ownership historical for non-sale transitions). Only set for historical ownerships.",
"$ref" : "#/definitions/RightReference"
},
"links" : {
"$ref" : "#/definitions/CadastreOwnershipLinks"
}
}
},
"CadastreOwnershipIdent" : {
"type" : "object",
"required" : [ "cadastreIdent", "ownershipNumber" ],
"properties" : {
"cadastreIdent" : {
"description" : "The ident for the cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"ownershipNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A serial for all owners of the same cadastre"
},
"cadastreLevel" : {
"type" : "integer",
"format" : "int32",
"description" : "A number that specifies what part of the cadastre the ownership is connected to"
}
}
},
"CadastreOwnershipItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreOwnershipLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/CadastreOwnershipItemLink"
},
"ownedCadastre" : {
"description" : "The cadastre being owned",
"$ref" : "#/definitions/CadastreItemLink"
},
"owningPerson" : {
"description" : "The owning person",
"$ref" : "#/definitions/PersonItemLink"
},
"owningCadastre" : {
"description" : "The owning cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"conveyance" : {
"description" : "The conveyance that caused this ownership",
"$ref" : "#/definitions/CadastreConveyanceItemLink"
},
"boughtRight" : {
"description" : "Title right when ownership was bought",
"$ref" : "#/definitions/CreationOfRightItemLink"
},
"soldRight" : {
"description" : "Title right when ownership was sold",
"$ref" : "#/definitions/CreationOfRightItemLink"
}
}
},
"CadastrePolygonLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreSectioning" : {
"type" : "object",
"properties" : {
"fraction" : {
"description" : "Specifies the size of an ownership as a fraction",
"$ref" : "#/definitions/Fraction"
},
"purpose" : {
"description" : "Purpose of this sectioning",
"$ref" : "#/definitions/Code"
},
"additionalPart" : {
"description" : "Additional part of this sectioning",
"$ref" : "#/definitions/Code"
}
}
},
"ComplaintListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Condominium" : {
"type" : "object",
"properties" : {
"orgnr" : {
"type" : "string",
"description" : "The organisation number of the condominium (eierseksjonssameie)"
},
"name" : {
"type" : "string",
"description" : "The name of the condominium organisation"
},
"numberOfSections" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of active sections in the condominium"
},
"links" : {
"$ref" : "#/definitions/CondominiumLinks"
}
}
},
"CondominiumLinks" : {
"type" : "object",
"properties" : {
"organization" : {
"description" : "The organisation of this condominium",
"$ref" : "#/definitions/OrganizationItemLink"
}
}
},
"CreationOfRightItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CulturalHeritageListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Floor" : {
"type" : "object",
"required" : [ "eventStatus", "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/FloorIdent"
},
"key" : {
"type" : "string",
"description" : "The building number, floor number and code"
},
"eventStatus" : {
"type" : "integer",
"format" : "int32",
"description" : "Whether this floor is active (0) or historical (1)",
"minimum" : 0,
"maximum" : 1
},
"numberOfDwellingUnits" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of apartments / dwelling units on the floor"
},
"totalAlternateArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area of alternative space."
},
"totalArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside the housing, including walls"
},
"totalAreaHousing" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside the housing, including walls"
},
"totalAreaOfPrimarySpace" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside the primary rooms, excluding walls"
},
"totalFloorSpace" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside the floor, excluding walls"
},
"totalUsableArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside the floor, excluding walls"
},
"links" : {
"$ref" : "#/definitions/FloorLinks"
}
}
},
"FloorIdent" : {
"type" : "object",
"required" : [ "buildingNumber", "floorLevelCode", "floorNumber" ],
"properties" : {
"buildingNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The building number"
},
"floorNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The floor number",
"minimum" : 0,
"maximum" : 99
},
"floorLevelCode" : {
"description" : "The floor level code",
"$ref" : "#/definitions/Code"
}
}
},
"FloorItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"FloorLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/FloorItemLink"
},
"building" : {
"description" : "The building this floor is within",
"$ref" : "#/definitions/BuildingItemLink"
}
}
},
"FloorListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"OperatingUnitItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"PersonListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"PlotListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"RealtyEstateUnitListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"RightReference" : {
"type" : "object",
"required" : [ "documentStatus" ],
"properties" : {
"rightIdent" : {
"description" : "Ident for title right",
"$ref" : "#/definitions/CreationOfRightIdent"
},
"rightKey" : {
"type" : "string",
"description" : "Key for title right"
},
"timeRegistered" : {
"description" : "The date the conveyance was registered",
"$ref" : "#/definitions/ApiDateTime"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"reason" : {
"description" : "Grouped reason for why this right started or ended an ownership, derived from documentType. Examples: HJ → Opphør hjemmel (the common sale case); SA → Sammenslåing; RS/SF/SH/SM/SS → Reseksjonering; SE → Seksjonering; FB → Opphør festenr; HI → Historisk matrikkelenhet. Null for document types that are not ownership-transition-related.",
"$ref" : "#/definitions/Code"
}
}
},
"SectioningListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SeparatelyOccupiedUnit" : {
"type" : "object",
"required" : [ "ident", "key", "toBeExpired", "unitType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitIdent"
},
"key" : {
"type" : "string",
"description" : "The internal id"
},
"floorId" : {
"type" : "string",
"description" : "The floor id for this unit"
},
"floorNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The floor number this unit is registered inside"
},
"floorLevelCode" : {
"description" : "The floor type this unit is registered inside",
"$ref" : "#/definitions/Code"
},
"apartmentNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The apartment number of this unit"
},
"unitNumber" : {
"type" : "string",
"description" : "The apartment unit number. DEPRECATED, use dwelling number"
},
"dwellingNumber" : {
"type" : "string",
"description" : "The apartment unit number"
},
"internalId" : {
"type" : "integer",
"format" : "int32",
"description" : "The internal id for SeparatelyOccupiedUnit. This id is generated and might change"
},
"usableArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area inside this unit excluding walls"
},
"numberOfRooms" : {
"type" : "integer",
"format" : "int32",
"description" : "How many rooms this unit has excluding bathroom, WC and kitchen"
},
"numberOfBathRooms" : {
"type" : "integer",
"format" : "int32",
"description" : "How many bathrooms this unit has"
},
"numberOfWCs" : {
"type" : "integer",
"format" : "int32",
"description" : "How many WCs this unit has"
},
"kitchenAccessCode" : {
"description" : "What type of kitchen this unit has",
"$ref" : "#/definitions/Code"
},
"unitType" : {
"description" : "The type of unit as defined by the owner",
"$ref" : "#/definitions/Code"
},
"isBuildingChange" : {
"type" : "boolean",
"description" : "Whether this unit is connected to a building modification"
},
"buildingChangeCode" : {
"description" : "The type of modifications made to this building",
"$ref" : "#/definitions/Code"
},
"toBeExpired" : {
"type" : "boolean",
"description" : "Whether this unit will be removed"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"buildingMatrikkelenUUID" : {
"type" : "string",
"description" : "The Matrikkelen UUID of the building this unit is in"
},
"addressMatrikkelenUUID" : {
"type" : "string",
"description" : "The Matrikkelen UUID of the address of this unit"
},
"cadastreMatrikkelenUUID" : {
"type" : "string",
"description" : "The Matrikkelen UUID of the cadastre this unit is on"
},
"links" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitLinks"
}
}
},
"SeparatelyOccupiedUnitExtended" : {
"type" : "object",
"required" : [ "address", "building", "unit" ],
"properties" : {
"unit" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnit"
},
"address" : {
"$ref" : "#/definitions/Address"
},
"building" : {
"$ref" : "#/definitions/Building"
}
}
},
"SeparatelyOccupiedUnitIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "An internal id for a separately occupied unit"
}
}
},
"SeparatelyOccupiedUnitItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SeparatelyOccupiedUnitLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemLink"
},
"building" : {
"description" : "The building this unit is in",
"$ref" : "#/definitions/BuildingItemLink"
},
"buildingchange" : {
"description" : "The modifications made to building this unit is in",
"$ref" : "#/definitions/BuildingChangeItemLink"
},
"address" : {
"description" : "The address of this unit",
"$ref" : "#/definitions/AddressItemLink"
},
"cadastre" : {
"description" : "The cadastre this unit is on",
"$ref" : "#/definitions/CadastreItemLink"
},
"share" : {
"description" : "The share connected to this unit if it is a cooperative share",
"$ref" : "#/definitions/ShareItemLink"
}
}
},
"SingleHeritageListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SoilContaminationListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CoOwnerScore" : {
"type" : "object",
"required" : [ "numberOfCoOwners" ],
"properties" : {
"isScorable" : {
"type" : "boolean",
"description" : "True if person can be scored"
},
"overallRisk" : {
"description" : "The risk of the person",
"$ref" : "#/definitions/Code"
},
"numberOfCoOwners" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of coowners"
},
"coOwners" : {
"type" : "array",
"description" : "The list of coowners",
"items" : {
"$ref" : "#/definitions/CoOwnerWithScore"
}
}
}
},
"CoOwnerWithScore" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"isScorable" : {
"type" : "boolean",
"description" : "true if this person can be scored"
},
"risk" : {
"description" : "The risk for the coowner",
"$ref" : "#/definitions/Code"
}
}
},
"CustomerScoreCoOwner" : {
"type" : "object",
"required" : [ "customerName", "ident", "isScorable", "key" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/PersonIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"customerName" : {
"type" : "string",
"description" : "The customers name"
},
"isScorable" : {
"type" : "boolean",
"description" : "Indicates if scoring for this person is possible"
},
"reasonNotScorable" : {
"type" : "string",
"description" : "If not scorable, this string contains the reason"
},
"overallRisk" : {
"description" : "The overall/total risk of providing a loan to this person",
"$ref" : "#/definitions/Code"
},
"ownedCadastresWithoutPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of cadastres not mortgaged / containing no liens"
},
"ownedSharesWithoutPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of shares not mortgaged / containing no liens"
},
"highRisks" : {
"type" : "object",
"description" : "Collection of all possible high risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"mediumRisks" : {
"type" : "object",
"description" : "Collection of all possible medium risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"lowRisks" : {
"type" : "object",
"description" : "Collection of all possible low risks",
"additionalProperties" : {
"$ref" : "#/definitions/Risk"
}
},
"mortgagesSummary" : {
"description" : "Summary of the persons mortgages",
"$ref" : "#/definitions/CustomerScoreMortgagesSummary"
},
"links" : {
"$ref" : "#/definitions/CustomerScoreLinks"
},
"coOwnerScore" : {
"$ref" : "#/definitions/CoOwnerScore"
}
}
},
"CustomerScoreCoOwnerItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CustomerScoreCoOwner"
}
}
},
"CoopInternal" : {
"type" : "object",
"required" : [ "fixedValues", "ident", "key", "labelValues", "supplierId" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CoopInternalIdent"
},
"key" : {
"type" : "string"
},
"supplierId" : {
"type" : "string"
},
"labelValues" : {
"type" : "object",
"description" : "Values for this item. The label on each value depends on the format provided by the supplier",
"additionalProperties" : {
"type" : "object"
}
},
"fixedValues" : {
"description" : "Values for this item.",
"$ref" : "#/definitions/FixedValues"
},
"links" : {
"$ref" : "#/definitions/CoopInternalLinks"
}
}
},
"CoopInternalIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "The internal id for this coop internal"
}
}
},
"CoopInternalItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CoopInternalLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"$ref" : "#/definitions/CoopInternalItemLink"
}
}
},
"CoopInternalListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CoopInternal"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"FixedValues" : {
"type" : "object",
"properties" : {
"internAndelshavernr" : {
"type" : "integer",
"format" : "int32",
"description" : "Internal shareholder number. Can appear as Andelsnr, Kundenr or Medlemsnr in labeled values."
},
"internAndelsnr" : {
"type" : "integer",
"format" : "int32",
"description" : "Internal share number. Can appear as Andelsnummer, Bolignr, Enhet or Index in labeled values."
},
"internOrgnr" : {
"type" : "integer",
"format" : "int32",
"description" : "Internal organization number. Can appear as Klientnr, Selskapnr or Selskapsnr in labeled values."
},
"andelshaverNavn" : {
"type" : "string",
"description" : "Shareholder name. Can appear as Firma or Navn in labeled values."
},
"borettslagNavn" : {
"type" : "string",
"description" : "Housing cooperativ name. Can appear as Klientnavn, Selskap or Selskapsnavn in labeled values."
},
"adresse" : {
"type" : "string",
"description" : "The address. Can appear as Addresse in labeled values."
},
"postnrSted" : {
"type" : "string",
"description" : "Postal number and postal place."
},
"postnr" : {
"type" : "string",
"description" : "Postal number. Can appear as Postnr in labeled values."
},
"poststed" : {
"type" : "string",
"description" : "Postal place. Can appear as Poststed in labeled values."
},
"offAndelshavernr" : {
"type" : "integer",
"format" : "int64",
"description" : "Public shareholder number. Can appear as IDnummer in labeled values."
},
"offOrgnr" : {
"type" : "integer",
"format" : "int32",
"description" : "Official organization number. Can appear as Foretaknr or Organisasjonsnr in labeled values."
},
"matrikkel" : {
"type" : "string",
"description" : "Cadastre ident. Can appear as Matrikkel in labeled values."
},
"regionId" : {
"type" : "string",
"description" : "Region ID. Can appear as Regionid in labeled values."
},
"energimerke" : {
"type" : "string",
"description" : "Has energy label (True/False). Can appear as HarEnergimerke is labeled values."
},
"eiendomsnr" : {
"type" : "string",
"description" : "Cadastre ident for Accountant. Can appear as EiendomsidForretningsfører in labeled values."
},
"dokumentnr" : {
"type" : "string"
},
"andelsnr" : {
"type" : "string"
},
"seksjonsnr" : {
"type" : "string"
},
"aksjeboenhetsnr" : {
"type" : "string"
},
"selskapstype" : {
"type" : "string"
}
}
},
"CoopInternalItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CoopInternal"
}
}
},
"CadastreCalculationBasis" : {
"type" : "object",
"properties" : {
"conveyance" : {
"description" : "Data about the conveyance used in calculation",
"$ref" : "#/definitions/CadastreHousingValueConveyance"
},
"area" : {
"description" : "Data about the area used in calculation",
"$ref" : "#/definitions/CadastreHousingValueArea"
},
"virdi" : {
"description" : "Data about the calculation when Virdi is the supplier",
"$ref" : "#/definitions/HousingValueVirdi"
},
"index" : {
"description" : "DEPRECATED. Data about the index used in calculation. Data about the used index is now present in conveyance and area",
"$ref" : "#/definitions/Index"
},
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Municipality number for the cadastre used in calculation"
},
"unitType" : {
"description" : "Type of separately occupied unit",
"$ref" : "#/definitions/Code"
},
"preferredCalculationMethod" : {
"description" : "Preferred calculation method. Values = area, conveyance",
"$ref" : "#/definitions/Code"
}
}
},
"CadastreHousingValue" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string"
},
"isCalculable" : {
"type" : "boolean",
"description" : "Indicates if the calculation is possible"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"indexSupplier" : {
"description" : "The source of the index. Current possible values=SSB,VIRDI",
"$ref" : "#/definitions/Code"
},
"indexSupplierCode" : {
"description" : "The supplier code of the used index. Only applicable for indexSupplier SSB",
"$ref" : "#/definitions/Code"
},
"calculationText" : {
"type" : "string",
"description" : "Fixed text describing the calculation"
},
"calculationBasis" : {
"description" : "Calculation basis containing conveyance and index data",
"$ref" : "#/definitions/CadastreCalculationBasis"
},
"links" : {
"$ref" : "#/definitions/CadastreHousingValueLinks"
}
}
},
"CadastreHousingValueArea" : {
"type" : "object",
"properties" : {
"numberOfUnits" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of separately occupied units"
},
"numberOfBuildings" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of buildings"
},
"totalFloorSpace" : {
"type" : "number",
"format" : "double",
"description" : "The sum of usable area used in calculation for each cadastre"
},
"usedDate" : {
"description" : "Date of the newest building used in calculation",
"$ref" : "#/definitions/ApiDate"
},
"pricePerSquareMeter" : {
"type" : "number",
"format" : "double",
"description" : "Price per square meter"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"indexRegion" : {
"type" : "string",
"description" : "The code of index region"
},
"indexRegionName" : {
"type" : "string",
"description" : "The name of index region"
}
}
},
"CadastreHousingValueConveyance" : {
"type" : "object",
"properties" : {
"dateRegistered" : {
"description" : "The date the conveyance was registered",
"$ref" : "#/definitions/ApiDate"
},
"documentCode" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
},
"useOfCadastre" : {
"description" : "The use of the cadastre as defined by the purchaser",
"$ref" : "#/definitions/Code"
},
"dwellingType" : {
"description" : "The type of the dwelling as defined by the owner",
"$ref" : "#/definitions/Code"
},
"purchasePrice" : {
"type" : "integer",
"format" : "int64",
"description" : "The purchase price of the conveyance"
},
"numberOfCadastresInConveyance" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of cadastres in the conveyance"
},
"appliesToEntireProperty" : {
"type" : "boolean",
"description" : "If the conveyance applies to entire cadastre"
},
"conveyanceIndexDate" : {
"description" : "The index date related to the time the conveyance occured",
"$ref" : "#/definitions/ApiDate"
},
"conveyanceIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "The index value related to the time the conveyance occured"
},
"currentIndexDate" : {
"description" : "The current index date",
"$ref" : "#/definitions/ApiDate"
},
"currentIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "The current index value"
},
"indexRegion" : {
"type" : "string",
"description" : "The code of index region"
},
"indexRegionName" : {
"type" : "string",
"description" : "The name of index region"
},
"indexSupplier" : {
"description" : "The source of the index. Current possible values=SSB",
"$ref" : "#/definitions/Code"
},
"indexSupplierCode" : {
"description" : "The supplier code of the used index",
"$ref" : "#/definitions/Code"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
}
}
},
"CadastreHousingValueItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreHousingValue"
}
}
},
"CadastreHousingValueLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CadastreHousingValueItemLink"
},
"cadastre" : {
"description" : "The current cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"conveyanceInCalculationBasis" : {
"description" : "Link to the conveyance used in basis for calculation",
"$ref" : "#/definitions/CadastreConveyanceItemLink"
},
"conveyances" : {
"description" : "Link to the conveyances",
"$ref" : "#/definitions/CadastreConveyanceListLink"
},
"addresses" : {
"description" : "Link to the addresses",
"$ref" : "#/definitions/AddressListLink"
},
"affairs" : {
"description" : "Link to the affairs",
"$ref" : "#/definitions/AffairListLink"
},
"buildings" : {
"description" : "Link to the buildings",
"$ref" : "#/definitions/BuildingListLink"
},
"presentationAddress" : {
"description" : "Link to presentation address of the current cadastre",
"$ref" : "#/definitions/AddressItemLink"
}
}
},
"HousingValueVirdi" : {
"type" : "object",
"properties" : {
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"calculatedValueLow" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value low"
},
"calculatedValueHigh" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value high"
},
"updated" : {
"description" : "When was this data updated",
"$ref" : "#/definitions/ApiDate"
},
"calculatedValueWithoutJointDebt" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value without Joint Debt"
},
"jointDebt" : {
"type" : "integer",
"format" : "int64",
"description" : "Joint Debt"
},
"jointDebtUpdated" : {
"description" : "When Joint Debt was updated",
"$ref" : "#/definitions/ApiDate"
},
"estimations" : {
"type" : "array",
"description" : "Estimations this calculations is based on",
"items" : {
"$ref" : "#/definitions/VirdiEstimation"
}
}
}
},
"Index" : {
"type" : "object",
"properties" : {
"conveyanceIndexDate" : {
"description" : "Index date for the time the conveyance occured",
"$ref" : "#/definitions/ApiDate"
},
"conveyanceIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "Index value for the time the conveyance occured"
},
"currentIndexDate" : {
"description" : "The current index date",
"$ref" : "#/definitions/ApiDate"
},
"currentIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "The current index value"
},
"indexRegion" : {
"type" : "string",
"description" : "The code of index region"
},
"indexRegionName" : {
"type" : "string",
"description" : "The name of index region"
}
}
},
"VirdiEstimation" : {
"type" : "object",
"required" : [ "basedOnUnit", "calculatedValue", "calculatedValueHigh", "calculatedValueLow", "estimationMethod", "links", "uncertaintyIndicator" ],
"properties" : {
"basedOnUnit" : {
"type" : "boolean",
"description" : "True if this estimation is based on a Separately Occupied Unit"
},
"unitKey" : {
"type" : "string",
"description" : "Key of Separately Occupied Unit this estimation (optionally) is based on"
},
"dwellingNumber" : {
"type" : "string",
"description" : "The apartment unit number"
},
"addressText" : {
"type" : "string",
"description" : "Dwelling Address text"
},
"unitType" : {
"description" : "Type of Separately Occupied Unit",
"$ref" : "#/definitions/Code"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"calculatedValueLow" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value low"
},
"calculatedValueHigh" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value high"
},
"calculatedValueWithoutJointDebt" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value without Joint Debt"
},
"jointDebt" : {
"type" : "integer",
"format" : "int64",
"description" : "Joint Debt"
},
"jointDebtUpdated" : {
"description" : "When Joint Debt was updated",
"$ref" : "#/definitions/ApiDate"
},
"jointDebtSource" : {
"description" : "Data source for Joint Debt",
"$ref" : "#/definitions/Code"
},
"estimationMethod" : {
"description" : "Type of estimation used",
"$ref" : "#/definitions/Code"
},
"uncertaintyIndicator" : {
"type" : "integer",
"format" : "int32",
"description" : "The level of uncertainty in the estimated price, integer from 1 (best/ least) to 5 (worst/ most)"
},
"links" : {
"$ref" : "#/definitions/VirdiSeparatelyOccupiedUnitLinks"
}
}
},
"VirdiSeparatelyOccupiedUnitLinks" : {
"type" : "object",
"properties" : {
"unit" : {
"description" : "Link to Separately Occupied Unit if this estimation is based on it",
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemLink"
}
}
},
"JsonNode" : {
"type" : "object"
},
"BuildingChange" : {
"type" : "object",
"required" : [ "buildingChangeCode", "hasElevator", "ident", "key", "municipalityNumber", "numberOfFloors", "numberOfUnits" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/BuildingChangeIdent"
},
"key" : {
"type" : "string",
"description" : "The building number and serial for a building change"
},
"updatedDate" : {
"description" : "The building change update date",
"$ref" : "#/definitions/ApiDate"
},
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality number"
},
"municipality" : {
"description" : "The municipality this building resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"numberOfUnits" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of occupied units in this building change"
},
"hasElevator" : {
"type" : "boolean",
"description" : "If the building has a registered elevator",
"enum" : [ true, false ]
},
"numberOfFloors" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of floors in the building"
},
"totalFloorSpace" : {
"type" : "number",
"format" : "double",
"description" : "The total usable area inside the building change"
},
"totalAreaOfPrimarySpace" : {
"type" : "number",
"format" : "double",
"description" : "The total living area inside the building change"
},
"areaOfSecondarySpace" : {
"type" : "number",
"format" : "double",
"description" : "The total area not used for living inside the building change"
},
"incompleteArea" : {
"type" : "boolean",
"description" : "Whether the area is measured fully or not"
},
"builtUpArea" : {
"type" : "number",
"format" : "double",
"description" : "Area that is built on"
},
"totalArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building change, including walls"
},
"totalAreaHousing" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building change used for living"
},
"totalAlternateArea" : {
"type" : "number",
"format" : "double",
"description" : "The total area of the building change not used for living"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"buildingStatus" : {
"description" : "The building status",
"$ref" : "#/definitions/Code"
},
"typeOfBuilding" : {
"description" : "The type of this building",
"$ref" : "#/definitions/Code"
},
"industryGroup" : {
"description" : "The industrial use of this building",
"$ref" : "#/definitions/Code"
},
"waterSupplyType" : {
"description" : "The source of water used by this building",
"$ref" : "#/definitions/Code"
},
"dischargeType" : {
"description" : "The type of discharge used by this building",
"$ref" : "#/definitions/Code"
},
"originType" : {
"description" : "How this building was registered into the system",
"$ref" : "#/definitions/Code"
},
"buildingChangeCode" : {
"description" : "The type of modifications made to this building",
"$ref" : "#/definitions/Code"
},
"heatingType" : {
"type" : "array",
"description" : "The type of heating this building primarily uses",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"energySourceType" : {
"type" : "array",
"description" : "The type of energy source this building primarily uses",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"approvedDate" : {
"description" : "The date the building plans were approved",
"$ref" : "#/definitions/ApiDate"
},
"registeredApprovedDate" : {
"description" : "The registered date the building plans were approved",
"$ref" : "#/definitions/ApiDate"
},
"startedDate" : {
"description" : "The date the construction of this building started",
"$ref" : "#/definitions/ApiDate"
},
"registeredStartedDate" : {
"description" : "The registered date the construction of this building started",
"$ref" : "#/definitions/ApiDate"
},
"usedDate" : {
"description" : "The date this building was taken taken into use",
"$ref" : "#/definitions/ApiDate"
},
"registeredUsedDate" : {
"description" : "The registered date this building was taken taken into use",
"$ref" : "#/definitions/ApiDate"
},
"floors" : {
"type" : "array",
"description" : "The registered floor information for this building.",
"items" : {
"$ref" : "#/definitions/Floor"
}
},
"buildingStatusHistory" : {
"type" : "array",
"description" : "The building change status history",
"items" : {
"$ref" : "#/definitions/BuildingStatusHistory"
}
},
"links" : {
"$ref" : "#/definitions/BuildingChangeLinks"
}
}
},
"BuildingChangeIdent" : {
"type" : "object",
"required" : [ "buildingIdent", "buildingNumber", "buildingSerialNumber" ],
"properties" : {
"buildingNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A unique number that identifies a building"
},
"buildingSerialNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A serial incremented once for each building change"
},
"buildingIdent" : {
"$ref" : "#/definitions/BuildingIdent"
}
}
},
"BuildingChangeLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/BuildingChangeItemLink"
},
"building" : {
"description" : "The building this change affects",
"$ref" : "#/definitions/BuildingItemLink"
},
"cadastres" : {
"description" : "The cadastre this building is placed upon",
"$ref" : "#/definitions/CadastreListLink"
},
"addresses" : {
"description" : "The addresses connected to this building",
"$ref" : "#/definitions/AddressListLink"
},
"units" : {
"description" : "The units inside this building",
"$ref" : "#/definitions/SeparatelyOccupiedUnitListLink"
},
"contacts" : {
"description" : "The registered contacts to the construction of this building change",
"$ref" : "#/definitions/PersonListLink"
},
"developers" : {
"description" : "The registered developers of this building change",
"$ref" : "#/definitions/PersonListLink"
}
}
},
"BuildingChangeListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/BuildingChange"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"BuildingChangeItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/BuildingChange"
}
}
},
"CadastreReference" : {
"type" : "object",
"properties" : {
"ident" : {
"description" : "Ident of cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string",
"description" : "Key of cadastre"
}
}
},
"HousingCooperative" : {
"type" : "object",
"required" : [ "housingCooperativeName", "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/HousingCooperativeIdent"
},
"key" : {
"type" : "string",
"description" : "The organization number of the cooperative"
},
"housingCooperativeName" : {
"type" : "string",
"description" : "The name of the cooperative"
},
"numberOfShares" : {
"type" : "integer",
"format" : "int32",
"description" : "Amount of shares in housing cooperative"
},
"extent" : {
"description" : "DEPRECATED. The calculated extent of the cooperative",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "The calculated extent of the cooperative as GeoJSON",
"$ref" : "#/definitions/GeoJSONObject"
},
"links" : {
"$ref" : "#/definitions/HousingCooperativeLinks"
}
}
},
"HousingCooperativeIdent" : {
"type" : "object",
"required" : [ "organizationNumber" ],
"properties" : {
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization that owns the cooperative"
}
}
},
"HousingCooperativeItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"HousingCooperativeLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/HousingCooperativeItemLink"
},
"owner" : {
"description" : "Owner of this housing cooperative",
"$ref" : "#/definitions/PersonItemLink"
},
"shares" : {
"description" : "Shares in this housing cooperative",
"$ref" : "#/definitions/ShareListLink"
},
"ownedCadastres" : {
"description" : "Cadastres owned by this housing cooperative",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"Share" : {
"type" : "object",
"required" : [ "housingCooperative", "ident", "isHistoricalRegisteredLand", "key", "noHistoryForShare" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string"
},
"addressKey" : {
"type" : "string",
"description" : "Key to the shares address"
},
"formattedAddress" : {
"description" : "Formatted address",
"$ref" : "#/definitions/AddressFormatted"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"extent" : {
"description" : "DEPRECATED. The extent of this share",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "DEPRECATED. The extent of this share in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether this share is active (false) or historical (true)"
},
"canBeMortgaged" : {
"type" : "boolean",
"description" : "Whether it is possible to add a mortgage to the share"
},
"canBeSold" : {
"type" : "boolean",
"description" : "Whether the share is sellable"
},
"noHistoryForShare" : {
"type" : "boolean",
"description" : "Is history for share available"
},
"housingCooperative" : {
"description" : "The housing cooperative this share belongs to",
"$ref" : "#/definitions/HousingCooperative"
},
"municipality" : {
"description" : "The municipality this share belongs to",
"$ref" : "#/definitions/MunicipalityData"
},
"zeroConcession" : {
"type" : "boolean",
"description" : "Liability to reside on the share"
},
"zeroConcessionMessage" : {
"type" : "string",
"description" : "Extra information you should check if share is registered with zeroConcession"
},
"maxShareLevel" : {
"description" : "The maximum share level of this share ownerships",
"$ref" : "#/definitions/LevelCode"
},
"cityDistrict" : {
"description" : "The city district this share is located in",
"$ref" : "#/definitions/CityDistrict"
},
"landLot" : {
"description" : "Land lot. A reference to the cadastre at the ground where the share is located",
"$ref" : "#/definitions/CadastreReference"
},
"postalPlace" : {
"description" : "Postal place for this share",
"$ref" : "#/definitions/PostalPlace"
},
"shareWithForeignAddress" : {
"type" : "boolean",
"description" : "The share is located outside of Norway"
},
"links" : {
"$ref" : "#/definitions/ShareLinks"
}
}
},
"ShareHousingValueItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareLandRegistryItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareLiensCalculationItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/ShareItemLink"
},
"owners" : {
"description" : "List of share owners",
"$ref" : "#/definitions/PersonListLink"
},
"conveyances" : {
"description" : "List of conveyances of this share",
"$ref" : "#/definitions/ShareConveyanceListLink"
},
"address" : {
"description" : "The address of the share",
"$ref" : "#/definitions/AddressItemLink"
},
"unit" : {
"description" : "The unit from the technical land registry this share is registered on",
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemLink"
},
"building" : {
"description" : "The building from the technical land registry this share is registered on",
"$ref" : "#/definitions/BuildingItemLink"
},
"landLot" : {
"description" : "Land lot. The cadastre at the ground where the share is located",
"$ref" : "#/definitions/CadastreItemLink"
},
"objectScore" : {
"description" : "The objectscore on this share",
"$ref" : "#/definitions/ShareScoreItemLink"
},
"ownedByOwnerships" : {
"description" : "DEPRECATED. Ownerships where this housing cooperative share is being owned",
"$ref" : "#/definitions/ShareOwnershipListLink"
},
"ownershipsOwningThisShare" : {
"description" : "Ownerships where this housing cooperative share is being owned",
"$ref" : "#/definitions/ShareOwnershipListLink"
},
"housingCooperative" : {
"description" : "The housing cooperative this share belongs to",
"$ref" : "#/definitions/HousingCooperativeItemLink"
},
"sharePDF" : {
"description" : "A PDF of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"historicalSharePDF" : {
"description" : "A historical PDF of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"titlePDF" : {
"description" : "A PDF of the title of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"historicalTitlePDF" : {
"description" : "A historical PDF of the title of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"mortgagePDF" : {
"description" : "A PDF of the mortgages of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"historicalMortgagePDF" : {
"description" : "A historical PDF of the mortgages of this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"shareInfoPDF" : {
"description" : "A PDF with info on this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"historicalShareInfoPDF" : {
"description" : "A historical PDF with info on this share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"liensCalculation" : {
"description" : "The lien calculation for this share",
"$ref" : "#/definitions/ShareLiensCalculationItemLink"
},
"housingValue" : {
"description" : "The housing value for this share",
"$ref" : "#/definitions/ShareHousingValueItemLink"
},
"accountantData" : {
"description" : "Accountant data for this share",
"$ref" : "#/definitions/AccountantHousingDataItemLink"
},
"landRegistry" : {
"description" : "The presentation of the land registry for this share",
"$ref" : "#/definitions/ShareLandRegistryItemLink"
}
}
},
"ShareListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Share"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"ShareScoreItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Share"
}
}
},
"PersonsOwnings" : {
"type" : "object",
"properties" : {
"persons" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"responseInfo" : {
"$ref" : "#/definitions/PersonsOwningsResponseInfo"
},
"ownedCadastres" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CadastreExtended"
}
},
"ownedShares" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ShareExtended"
}
}
}
},
"PersonsOwningsItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/PersonsOwnings"
}
}
},
"PersonsOwningsResponseInfo" : {
"type" : "object",
"required" : [ "hasWarnings", "responseComplete", "warnings" ],
"properties" : {
"responseComplete" : {
"type" : "boolean"
},
"hasWarnings" : {
"type" : "boolean",
"description" : "Indicates if there are any warnings to this response"
},
"warnings" : {
"$ref" : "#/definitions/PersonsOwningsWarnings"
}
}
},
"PersonsOwningsWarnings" : {
"type" : "object",
"required" : [ "somePersonsNotFound", "tooManyOwnerships" ],
"properties" : {
"tooManyOwnerships" : {
"type" : "boolean",
"description" : "The requested persons had too many ownerships. The limit for the number of ownerships was exceeded."
},
"somePersonsNotFound" : {
"type" : "boolean",
"description" : "Some requested persons could not be found"
}
}
},
"ShareConveyance" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"purchasePrice" : {
"type" : "integer",
"format" : "int64",
"description" : "The purchase price"
},
"hasMarketValue" : {
"type" : "boolean",
"description" : "Whether the purchase price was at market value"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
},
"numberOfSharesInConveyance" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of shares related to this conveyance"
},
"appliesToEntireShare" : {
"type" : "boolean",
"description" : "If this conveyance applies to entire shares. All ownership fractions are whole."
},
"links" : {
"$ref" : "#/definitions/ShareConveyanceLinks"
}
}
},
"ShareConveyanceItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareConveyanceLinks" : {
"type" : "object",
"required" : [ "shares" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/ShareConveyanceItemLink"
},
"buyers" : {
"description" : "The list of buyers",
"$ref" : "#/definitions/PersonListLink"
},
"sellers" : {
"description" : "The list of sellers",
"$ref" : "#/definitions/PersonListLink"
},
"shares" : {
"description" : "The list of housing cooperative shares this conveyance applies to",
"$ref" : "#/definitions/ShareListLink"
}
}
},
"ShareEncumbranceShare" : {
"type" : "object",
"properties" : {
"fraction" : {
"description" : "The encumbrance share fraction",
"$ref" : "#/definitions/Fraction"
},
"person" : {
"description" : "The person who has this share",
"$ref" : "#/definitions/Person"
}
}
},
"ShareExtended" : {
"type" : "object",
"required" : [ "share" ],
"properties" : {
"share" : {
"$ref" : "#/definitions/Share"
},
"address" : {
"$ref" : "#/definitions/Address"
},
"unit" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnitExtended"
},
"latestConveyance" : {
"$ref" : "#/definitions/ShareConveyance"
},
"liensCalculation" : {
"$ref" : "#/definitions/ShareLiensCalculation"
},
"shareOwnerships" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ShareOwnership"
}
}
}
},
"ShareLien" : {
"type" : "object",
"required" : [ "documentCode", "documentStatus", "documentType", "ident", "isActive", "key", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentCode" : {
"description" : "Deprecated. Use documentType instead. After 18/4-2017 code in this field will no longer be unique for identifying the type of document.",
"$ref" : "#/definitions/Code"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"registeredDate" : {
"description" : "Registered date for the right",
"$ref" : "#/definitions/ApiDate"
},
"shareLevel" : {
"description" : "The share level this lien was registered on",
"$ref" : "#/definitions/LevelCode"
},
"documentHolder" : {
"type" : "array",
"description" : "List of the persons storing the documents",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"priority" : {
"type" : "integer",
"format" : "int32",
"description" : "Priority of the lien"
},
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"type" : "string"
}
},
"currentAmounts" : {
"type" : "array",
"description" : "The current amounts registered on the rights",
"items" : {
"$ref" : "#/definitions/Money"
}
},
"originalAmounts" : {
"type" : "array",
"description" : "The original amounts registered on the rights",
"items" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "List of the persons holding the mortgage",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"remarks" : {
"type" : "array",
"description" : "The remarks for this lien",
"items" : {
"type" : "string"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "List of the persons suing in this enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "List of the persons prosecuted in this enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "List of legal persons registered on the enforcement case",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"attachmentDate" : {
"description" : "The date the enforcement were held",
"$ref" : "#/definitions/ApiDateTime"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"isEnforcement" : {
"type" : "boolean",
"description" : "Indicates if this lien is an enforcement"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"shares" : {
"type" : "array",
"description" : "The shares for this lien",
"items" : {
"$ref" : "#/definitions/ShareEncumbranceShare"
}
},
"numberOfShares" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of shares"
},
"links" : {
"$ref" : "#/definitions/LienLinks"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"outstandingDebt" : {
"description" : "Outstanding debt for this lien",
"$ref" : "#/definitions/OutstandingDebt"
}
}
},
"ShareLiensCalculation" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"description" : "The ident for the share",
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string"
},
"isInterpretable" : {
"type" : "boolean",
"description" : "Can be interpreted"
},
"hasForeignCurrency" : {
"type" : "boolean",
"description" : "Is in a foreign currency"
},
"reasonsNotInterpretable" : {
"type" : "array",
"description" : "List of reasons why the lien cannot be interpreted",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"pledge" : {
"description" : "The pledge",
"$ref" : "#/definitions/SharePledge"
},
"liens" : {
"type" : "array",
"description" : "List of liens",
"items" : {
"$ref" : "#/definitions/ShareLien"
}
},
"hasSovereigntyLimitation" : {
"type" : "boolean",
"description" : "True if lien reduces owners sovereign"
},
"hasEasement" : {
"type" : "boolean",
"description" : "True if this lien has an easement"
},
"hasMonetaryEncumbranceEasement" : {
"type" : "boolean",
"description" : "True if this lien has an easement with a monetary encumbrance"
},
"hasPreemptive" : {
"type" : "boolean",
"description" : "True if this lien has a preemptive right"
},
"hasRightOfUse" : {
"type" : "boolean",
"description" : "True if this lien has a right of use"
},
"links" : {
"$ref" : "#/definitions/ShareLiensCalculationLinks"
}
}
},
"ShareLiensCalculationLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/ShareLiensCalculationItemLink"
},
"share" : {
"description" : "The current housing cooperative share",
"$ref" : "#/definitions/ShareItemLink"
},
"sharePDF" : {
"description" : "A PDF of this housing cooperative share from the Land Registry",
"$ref" : "#/definitions/PDFItemLink"
},
"objectScore" : {
"description" : "A link to the objectscore on this share",
"$ref" : "#/definitions/ShareScoreItemLink"
}
}
},
"ShareOwnership" : {
"type" : "object",
"required" : [ "housingCooperativeName", "ident", "isActive", "isMaxShareLevel", "isOwnedObjectActive", "key", "objectTypeName", "shareLevel" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ShareOwnershipIdent"
},
"municipality" : {
"description" : "The municipality the owned share resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"key" : {
"type" : "string"
},
"housingCooperativeName" : {
"type" : "string",
"description" : "The name of the cooperative"
},
"registered" : {
"type" : "boolean",
"description" : "Whether this ownership is registered in the Land Registry. Not used!"
},
"ownedShareIdent" : {
"description" : "Ident of the owned housing cooperative share",
"$ref" : "#/definitions/ShareIdent"
},
"ownedShareKey" : {
"type" : "string",
"description" : "Owned housing cooperation share key"
},
"fraction" : {
"description" : "Specifies the size of an ownership as a fraction",
"$ref" : "#/definitions/Fraction"
},
"usedForType" : {
"description" : "The type of use of the housing cooperative share as defined by the purchaser",
"$ref" : "#/definitions/Code"
},
"dwellingType" : {
"description" : "The type of the dwelling as defined by the owner",
"$ref" : "#/definitions/Code"
},
"shareLevel" : {
"description" : "Specifies what kind of ownership the owner has on the share",
"$ref" : "#/definitions/LevelCode"
},
"isMaxShareLevel" : {
"type" : "boolean",
"description" : "Specifies if this ownership is on the maximum ownership level of the share"
},
"owningPerson" : {
"description" : "Owning person",
"$ref" : "#/definitions/Person"
},
"numberOfOwnersOnLevel" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owners on the level specified by shareLevel"
},
"isResidence" : {
"type" : "boolean",
"description" : "Whether the owningPerson lives in this share"
},
"isActive" : {
"type" : "boolean",
"description" : "Specifies if this ownership active"
},
"isOwnedObjectActive" : {
"type" : "boolean",
"description" : "Specifies if the owned share is active"
},
"bought" : {
"description" : "Data about the conveyance when this ownership was bought. Deprecated: use 'started' instead.",
"$ref" : "#/definitions/RightReference"
},
"sold" : {
"description" : "Data about the conveyance when this ownership was sold. Deprecated: use 'ended' instead.",
"$ref" : "#/definitions/RightReference"
},
"started" : {
"description" : "The right that started this ownership (acquisition — deed for sales, other rettsstiftelsestyper for non-sale transitions)",
"$ref" : "#/definitions/RightReference"
},
"ended" : {
"description" : "The right that ended this ownership (deed for sales, or the rettsstiftelse that made the share/ownership historical for non-sale transitions). Only set for historical ownerships.",
"$ref" : "#/definitions/RightReference"
},
"links" : {
"$ref" : "#/definitions/ShareOwnershipLinks"
},
"objectTypeName" : {
"type" : "string"
}
}
},
"ShareOwnershipIdent" : {
"type" : "object",
"required" : [ "ownershipNumber", "shareIdent" ],
"properties" : {
"shareIdent" : {
"description" : "The ident for the share",
"$ref" : "#/definitions/ShareIdent"
},
"ownershipNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A serial for all owners of the same share"
},
"shareLevel" : {
"type" : "integer",
"format" : "int32",
"description" : "Specifies what kind of ownership the owner has on the share"
}
}
},
"ShareOwnershipItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareOwnershipLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/ShareOwnershipItemLink"
},
"ownedShare" : {
"description" : "The housing cooperative share being owned",
"$ref" : "#/definitions/ShareItemLink"
},
"owningPerson" : {
"description" : "The owning person",
"$ref" : "#/definitions/PersonItemLink"
},
"conveyance" : {
"description" : "The conveyance that caused this ownership",
"$ref" : "#/definitions/ShareConveyanceItemLink"
},
"boughtRight" : {
"description" : "Title right when ownership was bought",
"$ref" : "#/definitions/CreationOfRightItemLink"
},
"soldRight" : {
"description" : "Title right when ownership was sold",
"$ref" : "#/definitions/CreationOfRightItemLink"
}
}
},
"SharePledge" : {
"type" : "object",
"required" : [ "sumPledge" ],
"properties" : {
"sumPledge" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum pledge for the ownership in realties. Fractions are taken into account in the calculation."
},
"numberOfPledges" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of pledges"
},
"sumMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "The sum of the amounts on all the mortgages"
},
"sumOutstandingMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of the calculated outstanding mortgages"
},
"numberOfMortgages" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of mortgages"
},
"sumEnforcement" : {
"type" : "integer",
"format" : "int64",
"description" : "The sum of the amounts on all enforcements"
},
"numberOfEnforcements" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of enforcements"
},
"hasPledgeSecuringBond" : {
"type" : "boolean",
"description" : "True if a securing bond is present"
},
"hasPledgingStatement" : {
"type" : "boolean",
"description" : "True if a pledging statement is present"
},
"hasMortgageWithForeignCurrency" : {
"type" : "boolean",
"description" : "If mortgages in this pledge have currency code <> 'NOK'"
},
"hasEnforcementWithForeignCurrency" : {
"type" : "boolean",
"description" : "If enforcements in this pledge have currency code <> 'NOK'"
},
"hasListedMortgage" : {
"type" : "boolean",
"description" : "True if at least one of the mortgages are listed"
},
"hasListedEnforcement" : {
"type" : "boolean",
"description" : "True if at least one of the enforcements are listed"
}
}
},
"CadastreConveyanceItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreConveyance"
}
}
},
"CadastreConveyanceListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CadastreConveyance"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"ShareExtendedItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareExtended"
}
}
},
"HousingCooperativeSearch" : {
"type" : "object",
"required" : [ "housingCooperativeName", "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/HousingCooperativeIdent"
},
"key" : {
"type" : "string",
"description" : "The organization number of the cooperative"
},
"housingCooperativeName" : {
"type" : "string",
"description" : "The name of the cooperative"
},
"extent" : {
"description" : "DEPRECATED. The calculated extent of the cooperative",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "The calculated extent of the cooperative as GeoJSON",
"$ref" : "#/definitions/GeoJSONObject"
},
"links" : {
"$ref" : "#/definitions/HousingCooperativeSearchLinks"
}
}
},
"HousingCooperativeSearchLinks" : {
"type" : "object",
"required" : [ "housingcooperative", "ownedCadastres", "self", "shares" ],
"properties" : {
"self" : {
"description" : "Self link to housingcooperative",
"$ref" : "#/definitions/HousingCooperativeItemLink"
},
"housingcooperative" : {
"description" : "A link to itself",
"$ref" : "#/definitions/HousingCooperativeItemLink"
},
"shares" : {
"description" : "Shares in this housing cooperative",
"$ref" : "#/definitions/ShareListLink"
},
"ownedCadastres" : {
"description" : "Cadastres owned by this housing cooperative",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"HousingCooperativeSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/HousingCooperativeSearch"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"PingResponse" : {
"type" : "object",
"required" : [ "land_registry_ajour", "latency", "localCacheSize", "online", "release_time", "started_time", "status_time", "system", "technical_land_registry_ajour", "version" ],
"properties" : {
"online" : {
"type" : "boolean",
"description" : "Whether realty is ok"
},
"statuses" : {
"type" : "array",
"description" : "Contains all errors since last reset",
"items" : {
"type" : "string"
}
},
"overall_status" : {
"type" : "string",
"description" : "A status field",
"enum" : [ "green", "yellow", "orange", "red" ]
},
"status_time" : {
"type" : "string",
"description" : "Timestamp created on call"
},
"system" : {
"type" : "string",
"description" : "Name of system"
},
"env" : {
"type" : "string",
"description" : "The environment this component runs in, not in use at the moment"
},
"version" : {
"type" : "string",
"description" : "The version of this component"
},
"release_time" : {
"type" : "string",
"description" : "Timestamp created when code was released"
},
"started_time" : {
"type" : "string",
"description" : "Timestamp created when service was last started"
},
"latency" : {
"type" : "integer",
"format" : "int64",
"description" : "The time it took to respond in milliseconds"
},
"land_registry_ajour" : {
"type" : "string",
"description" : "How current the land registry is (Elida)"
},
"technical_land_registry_ajour" : {
"type" : "string",
"description" : "How current the technical land registry is (Matrikkelen)"
},
"localCacheSize" : {
"type" : "integer",
"format" : "int32",
"description" : "Current size of local cache"
},
"dsp_ajour" : {
"type" : "string",
"description" : "How current DSP (Folkeregisteret) is"
},
"enhetsregisteret_ajour" : {
"type" : "string",
"description" : "How current ER (Enhetsregisteret) is"
},
"sentralt_stednavnregister_ajour" : {
"type" : "string",
"description" : "How current Sentralt stednavnregister is"
}
}
},
"AddressSearch" : {
"type" : "object",
"required" : [ "formatted", "ident", "key" ],
"properties" : {
"ident" : {
"description" : "The street address ident",
"$ref" : "#/definitions/StreetAddressIdent"
},
"key" : {
"type" : "string",
"description" : "The municipality, street, address and letter"
},
"street" : {
"description" : "The street of this address",
"$ref" : "#/definitions/Street"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"formatted" : {
"description" : "Address formatted for presentation",
"$ref" : "#/definitions/AddressFormatted"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"geojson" : {
"description" : "DEPRECATED. The position of the address in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"links" : {
"$ref" : "#/definitions/AddressSearchLinks"
}
}
},
"AddressSearchLinks" : {
"type" : "object",
"required" : [ "address", "self" ],
"properties" : {
"self" : {
"description" : "Self link to address",
"$ref" : "#/definitions/AddressItemLink"
},
"address" : {
"description" : "Lookup link to address",
"$ref" : "#/definitions/AddressItemLink"
}
}
},
"AddressSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/AddressSearch"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"PersonSearch" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/PersonIdent"
},
"key" : {
"type" : "string",
"description" : "An anonymous person id"
},
"dateOfBirth" : {
"description" : "The date of birth for this person",
"$ref" : "#/definitions/ApiDate"
},
"age" : {
"type" : "integer",
"format" : "int32",
"description" : "The current age of the person"
},
"sex" : {
"type" : "string",
"description" : "The sex of this person"
},
"organizationNumber" : {
"type" : "string",
"description" : "The organization number of this company"
},
"givenName" : {
"type" : "string",
"description" : "The first name of a person"
},
"middleName" : {
"type" : "string",
"description" : "The middle name of a person"
},
"familyName" : {
"type" : "string",
"description" : "The last name of a person"
},
"name" : {
"type" : "string",
"description" : "The combined name of a person"
},
"location" : {
"description" : "A location connected to the person based on the living address",
"$ref" : "#/definitions/Location"
},
"businessAddress" : {
"type" : "string",
"description" : "A business address for an organization"
},
"dsfState" : {
"description" : "The DSF state of this person",
"$ref" : "#/definitions/Code"
},
"links" : {
"$ref" : "#/definitions/PersonSearchLinks"
}
}
},
"PersonSearchLinks" : {
"type" : "object",
"required" : [ "ownedCadastres", "ownedShares", "persons", "self" ],
"properties" : {
"self" : {
"description" : "Self link to person",
"$ref" : "#/definitions/PersonItemLink"
},
"persons" : {
"description" : "A lookup link to person",
"$ref" : "#/definitions/PersonItemLink"
},
"ownedCadastres" : {
"description" : "The cadastres owned by this person",
"$ref" : "#/definitions/CadastreListLink"
},
"ownedShares" : {
"description" : "The shares owned by this person",
"$ref" : "#/definitions/ShareListLink"
},
"residence" : {
"description" : "The place this person lives",
"$ref" : "#/definitions/AddressItemLink"
},
"organization" : {
"description" : "The organization resource for this person",
"$ref" : "#/definitions/OrganizationItemLink"
}
}
},
"PersonSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/PersonSearch"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"ConveyanceData" : {
"type" : "object",
"properties" : {
"dateRegistered" : {
"description" : "The date the conveyance was registered",
"$ref" : "#/definitions/ApiDate"
},
"documentCode" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
},
"useOfRealty" : {
"description" : "The use of the realty as defined by the purchaser",
"$ref" : "#/definitions/Code"
},
"dwellingType" : {
"description" : "The type of the dwelling as defined by the owner",
"$ref" : "#/definitions/Code"
},
"purchasePrice" : {
"type" : "integer",
"format" : "int64",
"description" : "The purchase price of the conveyance"
},
"numberOfRealtiesInConveyance" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of realties in the conveyance"
},
"appliesToEntireRealty" : {
"type" : "boolean",
"description" : "If the conveyance applies to entire realty"
}
}
},
"HomeEquity" : {
"type" : "object",
"required" : [ "calculatedHomeEquity", "ident", "isCalculable", "key", "ownedRealties", "personName", "pledge", "valueEstimation" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/PersonIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"personName" : {
"type" : "string",
"description" : "The persons name"
},
"isCalculable" : {
"type" : "boolean",
"description" : "Indicates if the calculation is possible"
},
"reasonNotCalculable" : {
"type" : "string",
"description" : "If not calculable, this string contains the reason"
},
"ownedRealties" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of relevant owned realties (cadastres and housing cooperative shares). Ownerships with fractions less 1/4 is not included"
},
"ownedCadastres" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned cadastres"
},
"ownedShares" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned housing cooperative shares"
},
"calculatedHomeEquity" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated home equity"
},
"valueEstimation" : {
"$ref" : "#/definitions/ValueEstimation"
},
"pledge" : {
"$ref" : "#/definitions/Pledge"
},
"summary" : {
"description" : "Contains summary data",
"$ref" : "#/definitions/Summary"
},
"latestConveyance" : {
"description" : "The latest conveyance for this realty",
"$ref" : "#/definitions/ConveyanceData"
},
"remarksOnPerson" : {
"description" : "A list if the risks that can be on a person",
"$ref" : "#/definitions/Risk"
},
"links" : {
"$ref" : "#/definitions/HomeEquityLinks"
}
}
},
"HomeEquityItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/HomeEquity"
}
}
},
"HomeEquityLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/HomeEquityItemLink"
},
"person" : {
"description" : "Link to the current person",
"$ref" : "#/definitions/PersonItemLink"
},
"cadastreOwnerships" : {
"description" : "The person’s ownerships on cadastres",
"$ref" : "#/definitions/CadastreOwnershipListLink"
},
"shareOwnerships" : {
"description" : "The person’s ownerships on housing cooperative shares",
"$ref" : "#/definitions/ShareOwnershipListLink"
},
"customerScore" : {
"description" : "Scoring of this person",
"$ref" : "#/definitions/CustomerScoreItemLink"
},
"latestConveyancePDF" : {
"description" : "PDF for the Creation of right representing the latest conveyance",
"$ref" : "#/definitions/PDFItemLink"
}
}
},
"Pledge" : {
"type" : "object",
"required" : [ "sumPledge" ],
"properties" : {
"ownedRealtiesWithPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned realties with pledge"
},
"ownedRealtiesWithoutPledge" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned realties without pledge"
},
"sumPledge" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum pledge for the persons ownership in realties. Fractions are taken into account in the calculation."
},
"numberOfPledges" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of pledges on this item"
},
"sumMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of the amount on all mortgages"
},
"sumOutstandingMortgage" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of the calculated outstanding mortgages"
},
"numberOfMortgages" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of mortgages (rights) on this item"
},
"numberOfMortgagees" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of distinct mortgagees (persons) on this item"
},
"sumEnforcement" : {
"type" : "integer",
"format" : "int64",
"description" : "Sum of the amount on all enforcements"
},
"numberOfEnforcements" : {
"type" : "integer",
"format" : "int32",
"description" : "Number or enforcements on this item"
},
"hasPledgeSecuringBond" : {
"type" : "boolean",
"description" : "True if a securing bond is present"
},
"hasPledgingStatement" : {
"type" : "boolean",
"description" : "True if a pledging statement is present"
},
"hasListedMortgage" : {
"type" : "boolean",
"description" : "True if at least one mortgages is just listed"
},
"hasListedEnforcement" : {
"type" : "boolean",
"description" : "True if at least one enforcement is just listed"
},
"hasMortgageWithForeignCurrency" : {
"type" : "boolean",
"description" : "If mortgages in this pledge have currency code <> 'NOK'"
},
"hasEnforcementWithForeignCurrency" : {
"type" : "boolean",
"description" : "If enforcements in this pledge have currency code <> 'NOK'"
},
"summaryCadastres" : {
"description" : "Pledge information for cadastres",
"$ref" : "#/definitions/Pledge"
},
"summaryShares" : {
"description" : "Pledge information for shares",
"$ref" : "#/definitions/Pledge"
}
}
},
"ValueEstimation" : {
"type" : "object",
"required" : [ "ownedRealtiesWithEstimatedValue", "ownedRealtiesWithoutEstimatedValue", "sumEstimatedValue" ],
"properties" : {
"ownedRealtiesWithoutEstimatedValue" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned realties without an estimated value"
},
"ownedRealtiesWithEstimatedValue" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of owned realties with an estimated value"
},
"sumEstimatedValue" : {
"type" : "integer",
"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."
}
}
},
"ApiTime" : {
"type" : "object",
"required" : [ "hhmm" ],
"properties" : {
"hhmm" : {
"type" : "string"
}
}
},
"Appeal" : {
"type" : "object",
"properties" : {
"appealType" : {
"description" : "Type of appeal",
"$ref" : "#/definitions/Code"
},
"decisionDate" : {
"description" : "Decision date this appeal applies to",
"$ref" : "#/definitions/ApiDate"
},
"appealDate" : {
"description" : "Appeal date",
"$ref" : "#/definitions/ApiDate"
},
"denialDate" : {
"description" : "Denial date",
"$ref" : "#/definitions/ApiDate"
}
}
},
"AppliesTo" : {
"type" : "object",
"properties" : {
"cadastres" : {
"type" : "array",
"description" : "List of entire cadastres/cadastreLevel this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"cadastreOwnerships" : {
"type" : "array",
"description" : "List of cadastre ownerships this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/CadastreOwnershipRelation"
}
},
"shares" : {
"type" : "array",
"description" : "List of entire share/shareLevel this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/ShareLevelRelation"
}
},
"shareOwnerships" : {
"type" : "array",
"description" : "List of share ownerships this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/ShareOwnershipRelation"
}
},
"persons" : {
"type" : "array",
"description" : "List of person this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"creationOfRights" : {
"type" : "array",
"description" : "List of other Creation of rights this Creation of right applies to",
"items" : {
"$ref" : "#/definitions/CreationOfRight"
}
},
"numberOfCreationOfRights" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of other Creation of rights this Creation of right applies to"
},
"numberOfRealties" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of realties(cadastres or shares) this Creation of right applies to"
}
}
},
"CadastreLandRegistry" : {
"type" : "object",
"properties" : {
"landRegistryUpToDate" : {
"description" : "When the data was last updated.",
"$ref" : "#/definitions/ApiDateTime"
},
"key" : {
"type" : "string",
"description" : "The key for the share or cadastre"
},
"dateConverted" : {
"description" : "The date from which historical data is available for the current realty, usually called the conversion date.",
"$ref" : "#/definitions/ApiDate"
},
"eventStatus" : {
"type" : "string",
"description" : "The type of request",
"enum" : [ "active", "historical", "active_and_historical" ]
},
"topText" : {
"type" : "array",
"description" : "Top text displayed when there are specific notes for this land registry report",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"formattedAddress" : {
"description" : "The presentation address for the property contains the single most relevant address that can be used when only one address should be presented.",
"$ref" : "#/definitions/AddressFormatted"
},
"allAddresses" : {
"type" : "array",
"description" : "List of all formatted addresses",
"items" : {
"$ref" : "#/definitions/AddressFormatted"
}
},
"parts" : {
"type" : "object",
"description" : "A map with the Land Registry parts found",
"additionalProperties" : {
"$ref" : "#/definitions/Part"
}
},
"cadastreIdent" : {
"description" : "The ident for the cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"cadastreKey" : {
"type" : "string",
"description" : "The key for the cadastre"
},
"municipality" : {
"description" : "The municipality this cadastre resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"links" : {
"$ref" : "#/definitions/CadastreLandRegistryLinks"
}
}
},
"CadastreLandRegistryItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreLandRegistry"
}
}
},
"CadastreLandRegistryLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"cadastre" : {
"description" : "Link to the current cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"titles" : {
"description" : "Hjemmel part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"encumbrances" : {
"description" : "Heftelser part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"monetaryEncumbrances" : {
"description" : "Pengeheftelser part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"landData" : {
"description" : "Andelsopplysninger part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"leaseholdAgreements" : {
"description" : "Festeavtaler part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"leaseAgreements" : {
"description" : "Leieavtaler part of Grunnbok",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"easements" : {
"description" : "Servitutter.",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
},
"privileges" : {
"description" : "Rettigheter. Eiendommens rettigheter",
"$ref" : "#/definitions/CadastreLandRegistryItemLink"
}
}
},
"CadastreOwnershipRelation" : {
"type" : "object",
"required" : [ "active", "isActive", "ownership" ],
"properties" : {
"ownership" : {
"$ref" : "#/definitions/CadastreOwnership"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if this connection is active. If not its historical"
},
"creationOfRight" : {
"$ref" : "#/definitions/CreationOfRight"
},
"active" : {
"type" : "boolean"
}
}
},
"CreationOfRight" : {
"type" : "object",
"required" : [ "documentKey", "documentStatus", "documentType", "ident", "isActive", "key", "presentation", "rightType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"documentKey" : {
"type" : "string",
"description" : "The document key (office-documentYear-documentNumber)"
},
"presentation" : {
"description" : "Simple presentation of this object",
"$ref" : "#/definitions/Presentation"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the right is active. If not its historical"
},
"rightType" : {
"description" : "The category for the document type",
"$ref" : "#/definitions/Code"
},
"documentType" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"documentStatus" : {
"description" : "The status of the document",
"$ref" : "#/definitions/Code"
},
"dateRegistered" : {
"description" : "Registration date",
"$ref" : "#/definitions/ApiDate"
},
"timeRegistered" : {
"description" : "Registration time",
"$ref" : "#/definitions/ApiDateTime"
},
"details" : {
"description" : "More details about this right",
"$ref" : "#/definitions/RightDetails"
},
"formatted" : {
"description" : "Content of this right formatted for presentation",
"$ref" : "#/definitions/Formatted"
},
"relatedRights" : {
"description" : "Rights with relation to this creation of right",
"$ref" : "#/definitions/RelatedRights"
},
"documentCopyExists" : {
"type" : "boolean",
"description" : "Whether or not a copy of this document can be ordered"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Whether or not a this document is a securing bond"
},
"documentCopyReasonNotExists" : {
"type" : "string",
"description" : "Explanation for why a document copy does not exist"
},
"isElectronicallySubmitted" : {
"type" : "boolean",
"description" : "Indicates if the right was submitted electronically"
},
"priorityType" : {
"description" : "Right priority type",
"$ref" : "#/definitions/Code"
},
"links" : {
"$ref" : "#/definitions/CreationOfRightLinks"
}
}
},
"CreationOfRightLinks" : {
"type" : "object",
"required" : [ "self", "selfHtml" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/CreationOfRightItemLink"
},
"selfHtml" : {
"$ref" : "#/definitions/InternalHtmlLinkCreationOfRight"
}
}
},
"Downpayment" : {
"type" : "object",
"properties" : {
"amounts" : {
"type" : "object",
"description" : "Amounts of downpayment",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
}
}
},
"EncumbranceTransfer" : {
"type" : "object",
"properties" : {
"transfers" : {
"type" : "array",
"description" : "List of transfers relevant to requested object",
"items" : {
"$ref" : "#/definitions/TransferredEncumbrance"
}
}
}
},
"Enforcement" : {
"type" : "object",
"required" : [ "enforcementHeldDate" ],
"properties" : {
"originalAmounts" : {
"type" : "object",
"description" : "The original amount on the enforcement",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"plaintiffs" : {
"type" : "array",
"description" : "The plaintiffs in the legal proceeding",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"legalRepresentatives" : {
"type" : "array",
"description" : "The legal representatives in the proceeding",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"defendants" : {
"type" : "array",
"description" : "The defendants in the legal proceeding",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"listedPledge" : {
"description" : "Listed pledge information.",
"$ref" : "#/definitions/ListedPledge"
},
"enforcementHeldDate" : {
"description" : "The date of the proceeding",
"$ref" : "#/definitions/ApiDate"
},
"enforcementHeldDateTime" : {
"description" : "The date and time of the proceeding. Field only present when a time is present",
"$ref" : "#/definitions/ApiDateTime"
},
"enforcementHeldTime" : {
"description" : "The time of the proceeding. Field only present when a time is present",
"$ref" : "#/definitions/ApiTime"
},
"encumbrances" : {
"type" : "array",
"description" : "DEPRECATED. List of encumbrances for this enforcement",
"items" : {
"$ref" : "#/definitions/CadastreOwnershipRelation"
}
},
"numberOfCadastres" : {
"type" : "integer",
"format" : "int32",
"description" : "DEPRECATED"
}
}
},
"Exchange" : {
"type" : "object",
"properties" : {
"invokedExchangeWith" : {
"type" : "array",
"description" : "Creation of rights invoked exchanged with",
"items" : {
"$ref" : "#/definitions/CreationOfRight"
}
},
"invokedPriorityFrom" : {
"description" : "The date this invoked exchange applies to",
"$ref" : "#/definitions/ApiDate"
}
}
},
"Formatted" : {
"type" : "object",
"properties" : {
"formattedRights" : {
"type" : "array",
"description" : "List of formatted rights",
"items" : {
"$ref" : "#/definitions/FormattedRight"
}
}
}
},
"FormattedRight" : {
"type" : "object",
"required" : [ "headingLine", "isActive", "keyLines", "rightKey", "textLines" ],
"properties" : {
"rightKey" : {
"type" : "string",
"description" : "The key of this right"
},
"keyLines" : {
"type" : "array",
"description" : "Text lines for presenting the key-data for this right",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"headingLine" : {
"description" : "The heading line of this right",
"$ref" : "#/definitions/TextLine"
},
"textLines" : {
"type" : "array",
"description" : "Text lines for presenting the content of this right",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"nestingLevel" : {
"type" : "integer",
"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."
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if this right is active"
},
"links" : {
"$ref" : "#/definitions/FormattedRightLinks"
}
}
},
"FormattedRightLinks" : {
"type" : "object",
"required" : [ "right", "rightHtml" ],
"properties" : {
"right" : {
"description" : "Link the the Creation of right",
"$ref" : "#/definitions/CreationOfRightItemLink"
},
"rightHtml" : {
"description" : "HTML for this Creation of right",
"$ref" : "#/definitions/InternalHtmlLinkCreationOfRight"
}
}
},
"InternalHtmlLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"InternalHtmlLinkCreationOfRight" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"LandData" : {
"type" : "object",
"properties" : {
"fromCadastres" : {
"type" : "array",
"description" : "Original cadastres of this land data right",
"items" : {
"$ref" : "#/definitions/LandDataCadastre"
}
},
"toCadastres" : {
"type" : "array",
"description" : "Resulting cadastres of this land data right",
"items" : {
"$ref" : "#/definitions/LandDataCadastre"
}
},
"fromShare" : {
"type" : "array",
"description" : "Original shares of this land data right",
"items" : {
"$ref" : "#/definitions/LandDataShare"
}
},
"toShare" : {
"type" : "array",
"description" : "Resulting shares of this land data right",
"items" : {
"$ref" : "#/definitions/LandDataShare"
}
},
"purchasePrice" : {
"description" : "The purchase price. Is filled only when this is of type area transfer",
"$ref" : "#/definitions/Money"
},
"hasMarketValue" : {
"type" : "boolean",
"description" : "Whether the purchase price was at market value. Is filled only when this is of type area transfer"
},
"containsBuilding" : {
"type" : "boolean",
"description" : "Whether the realty bought contains one or more buildings. Is filled only when this is of type area transfer"
},
"conveyanceType" : {
"description" : "The type of conveyance. Is filled only when this is of type area transfer",
"$ref" : "#/definitions/Code"
}
}
},
"LandDataCadastre" : {
"type" : "object",
"required" : [ "cadastreIdent", "cadastreKey", "isActive" ],
"properties" : {
"cadastreIdent" : {
"$ref" : "#/definitions/CadastreIdent"
},
"cadastreKey" : {
"type" : "string"
},
"roleText" : {
"type" : "string",
"description" : "The ident of the cadastre this area belongs to"
},
"fraction" : {
"description" : "Specifies the size of an ownership as a fraction",
"$ref" : "#/definitions/Fraction"
},
"purposeSectioning" : {
"description" : "The reason for sectioning",
"$ref" : "#/definitions/Code"
},
"additionalPart" : {
"description" : "Additional part of this sectioning",
"$ref" : "#/definitions/Code"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if active. If not its historical"
}
}
},
"LandDataShare" : {
"type" : "object",
"required" : [ "housingCooperativeName", "isActive", "shareIdent" ],
"properties" : {
"shareIdent" : {
"$ref" : "#/definitions/ShareIdentModel"
},
"isActive" : {
"type" : "boolean"
},
"housingCooperativeName" : {
"type" : "string"
},
"referencedShare" : {
"$ref" : "#/definitions/LandDataShare"
}
}
},
"LeaseAgreement" : {
"type" : "object",
"required" : [ "leaseholders" ],
"properties" : {
"leaseholders" : {
"type" : "array",
"description" : "List of leaseholders",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"amount" : {
"description" : "Amount",
"$ref" : "#/definitions/Money"
},
"amountPeriodType" : {
"description" : "Type of period for amount",
"$ref" : "#/definitions/Code"
},
"duration" : {
"type" : "integer",
"format" : "int32",
"description" : "Duration"
},
"durationPeriodType" : {
"description" : "Type of periode for duration",
"$ref" : "#/definitions/Code"
},
"fromDate" : {
"description" : "The date this lease agreement started",
"$ref" : "#/definitions/ApiDate"
}
}
},
"LeaseholdAgreement" : {
"type" : "object",
"required" : [ "conditions" ],
"properties" : {
"conditions" : {
"type" : "array",
"description" : "Conditions in this leasehold agreement",
"items" : {
"$ref" : "#/definitions/LeaseholdCondition"
}
}
}
},
"LeaseholdCondition" : {
"type" : "object",
"properties" : {
"leaseholdTime" : {
"type" : "integer",
"format" : "int32",
"description" : "Leasehold time"
},
"leaseholdFee" : {
"description" : "Leasehold fee",
"$ref" : "#/definitions/Money"
},
"landValue" : {
"description" : "Land value",
"$ref" : "#/definitions/Money"
},
"conclusionDate" : {
"description" : "Conclusion date",
"$ref" : "#/definitions/ApiDate"
}
}
},
"Level" : {
"type" : "object",
"required" : [ "rights" ],
"properties" : {
"header" : {
"type" : "string"
},
"topText" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"rights" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/CreationOfRight"
}
}
}
},
"ListedPledge" : {
"type" : "object",
"properties" : {
"notificationDate" : {
"description" : "Notification date",
"$ref" : "#/definitions/ApiDate"
},
"possessors" : {
"type" : "array",
"description" : "The possessors of this listed pledge",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"priority" : {
"type" : "integer",
"format" : "int32",
"description" : "Priority"
}
}
},
"Mortgage" : {
"type" : "object",
"properties" : {
"originalAmounts" : {
"type" : "object",
"description" : "The original amounts on the mortgage document",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "The mortgagees this mortgage refers to",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"listedPledge" : {
"description" : "Listed pledge information.",
"$ref" : "#/definitions/ListedPledge"
},
"isPledgingStatement" : {
"type" : "boolean",
"description" : "Indicates that this right is a pledging statement"
},
"isPledgeSecuringBond" : {
"type" : "boolean",
"description" : "Indicates that this right is a securing bond"
}
}
},
"Office" : {
"type" : "object",
"required" : [ "officeName", "officeNumber" ],
"properties" : {
"officeNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The juridical office where this document belongs to"
},
"officeName" : {
"type" : "string",
"description" : "The name of the office this document belongs to"
}
}
},
"OtherEncumbrance" : {
"type" : "object",
"properties" : {
"personsWithLicense" : {
"type" : "array",
"description" : "List of persons that have license",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"deletionNeedsConsentFrom" : {
"type" : "array",
"description" : "List of persons that has to consent to the deletion of this right",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"cadastresWithLicense" : {
"type" : "array",
"description" : "List of entire cadastres/cadastreLevel that have license",
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"cadastreOwnershipsWithLicense" : {
"type" : "array",
"description" : "List of cadastre ownerships that have license",
"items" : {
"$ref" : "#/definitions/CadastreOwnershipRelation"
}
},
"sharesWithLicense" : {
"type" : "array",
"description" : "List of entire shares/shareLevel that have license",
"items" : {
"$ref" : "#/definitions/ShareLevelRelation"
}
},
"shareOwnershipsWithLicense" : {
"type" : "array",
"description" : "List of share ownerships that have license",
"items" : {
"$ref" : "#/definitions/ShareOwnershipRelation"
}
}
}
},
"Part" : {
"type" : "object",
"properties" : {
"header" : {
"type" : "string"
},
"topText" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"bottomText" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"levels" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Level"
}
}
}
},
"PersonRelation" : {
"type" : "object",
"required" : [ "isActive", "person" ],
"properties" : {
"isActive" : {
"type" : "boolean"
},
"person" : {
"$ref" : "#/definitions/Person"
}
}
},
"Presentation" : {
"type" : "object",
"required" : [ "formatted" ],
"properties" : {
"formatted" : {
"type" : "string",
"description" : "A formatted presentation string"
}
}
},
"PriorityAppliesTo" : {
"type" : "object",
"properties" : {
"creationOfRight" : {
"description" : "The affected creation of right",
"$ref" : "#/definitions/CreationOfRight"
},
"priorityRelationType" : {
"type" : "string",
"description" : "The type of the relation"
},
"cadastres" : {
"type" : "array",
"description" : "Cadastres this priority affect",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"shares" : {
"type" : "array",
"description" : "Cadastres this priority affect",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/ShareLevelRelation"
}
}
}
},
"PriorityDecision" : {
"type" : "object",
"properties" : {
"priorityRelationType" : {
"type" : "string",
"description" : "Contains the text of priority relation type"
},
"amounts" : {
"type" : "object",
"description" : "The amounts in the decision",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"amountsSubordinatedWith" : {
"type" : "object",
"description" : "The amounts that this claim concedes with",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"amountsSubordinatedFor" : {
"type" : "object",
"description" : "The amounts that this claim concedes for",
"additionalProperties" : {
"$ref" : "#/definitions/Money"
}
},
"mortgagees" : {
"type" : "array",
"description" : "Contains the persons that are mortgagees",
"items" : {
"$ref" : "#/definitions/Person"
}
},
"rightsWithOtherPriority" : {
"type" : "array",
"description" : "Contains relation about what objects this priority affect",
"items" : {
"$ref" : "#/definitions/PriorityAppliesTo"
}
}
}
},
"RelatedRights" : {
"type" : "object",
"properties" : {
"remarks" : {
"type" : "object",
"description" : "Remarks on this Creation of right",
"additionalProperties" : {
"$ref" : "#/definitions/CreationOfRight"
}
},
"encumbrances" : {
"type" : "object",
"description" : "Encumbrances on this Creation of right",
"additionalProperties" : {
"$ref" : "#/definitions/CreationOfRight"
}
}
},
"description" : "Rights with relation to this Creation of right"
},
"Remark" : {
"type" : "object",
"properties" : {
"reasons" : {
"type" : "object",
"description" : "Reasons for this remark",
"additionalProperties" : {
"type" : "string"
}
},
"downpayment" : {
"description" : "Downpayment",
"$ref" : "#/definitions/Downpayment"
},
"transport" : {
"description" : "Transport of document",
"$ref" : "#/definitions/Transport"
},
"exchange" : {
"description" : "Exchange",
"$ref" : "#/definitions/Exchange"
},
"appeal" : {
"description" : "Appeal",
"$ref" : "#/definitions/Appeal"
},
"priorityDecision" : {
"description" : "Unregistered priority decision for encumbrances",
"$ref" : "#/definitions/PriorityDecision"
},
"administration" : {
"description" : "Administration",
"$ref" : "#/definitions/Administration"
}
}
},
"RightDetails" : {
"type" : "object",
"required" : [ "detailsType", "textLines" ],
"properties" : {
"textLines" : {
"type" : "array",
"description" : "Text embedded on the document",
"items" : {
"$ref" : "#/definitions/TextLineDetails"
}
},
"detailsType" : {
"type" : "string",
"description" : "Type of details. A corresponding field will be filled with data"
},
"leaseAgreement" : {
"description" : "Lease agreement data. Is filled for detailsType LEASE_AGREEMENT.",
"$ref" : "#/definitions/LeaseAgreement"
},
"leaseholdAgreement" : {
"description" : "Leasehold agreement data. Is filled for detailsType LEASEHOLD_AGREEMENT.",
"$ref" : "#/definitions/LeaseholdAgreement"
},
"otherEncumbrance" : {
"description" : "Data for encumbrances other than monetary encumbrances. Is filled for detailsType OTHER_ENCUMBRANCE.",
"$ref" : "#/definitions/OtherEncumbrance"
},
"enforcement" : {
"description" : "Enforcement data. Is filled for detailsType ENFORCEMENT.",
"$ref" : "#/definitions/Enforcement"
},
"landData" : {
"description" : "Land data. Is filled for detailsType LAND_DATA.",
"$ref" : "#/definitions/LandData"
},
"title" : {
"description" : "Title data. Is filled for detailsType TITLE.",
"$ref" : "#/definitions/Title"
},
"mortgage" : {
"description" : "Mortgage data. Is filled for detailsType MORTGAGE.",
"$ref" : "#/definitions/Mortgage"
},
"remark" : {
"description" : "Remark data. Is filled for detailsType REMARK.",
"$ref" : "#/definitions/Remark"
},
"office" : {
"description" : "Office where the document was registered",
"$ref" : "#/definitions/Office"
},
"encumbranceTransfer" : {
"description" : "Contains data encumbrance transfer for this creation of right",
"$ref" : "#/definitions/EncumbranceTransfer"
},
"appliesTo" : {
"description" : "Contains data about what objects this Creation of right applies to",
"$ref" : "#/definitions/AppliesTo"
}
}
},
"ShareIdentModel" : {
"type" : "object",
"required" : [ "formattedString", "organizationNumber", "shareNumber", "uniqueKey" ],
"properties" : {
"organizationNumber" : {
"type" : "integer",
"format" : "int32"
},
"shareNumber" : {
"type" : "integer",
"format" : "int32"
},
"uniqueKey" : {
"type" : "string"
},
"formattedString" : {
"type" : "string"
}
}
},
"ShareLevelRelation" : {
"type" : "object",
"required" : [ "housingCooperativeName", "isActive", "shareIdent", "shareKey", "shareLevel" ],
"properties" : {
"shareLevel" : {
"$ref" : "#/definitions/LevelCode"
},
"shareIdent" : {
"$ref" : "#/definitions/ShareIdent"
},
"shareKey" : {
"type" : "string"
},
"housingCooperativeName" : {
"type" : "string"
},
"fraction" : {
"$ref" : "#/definitions/Fraction"
},
"isActive" : {
"type" : "boolean"
}
}
},
"ShareOwnershipRelation" : {
"type" : "object",
"required" : [ "active", "isActive", "ownership" ],
"properties" : {
"ownership" : {
"$ref" : "#/definitions/ShareOwnership"
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if this connection is active. If not its historical"
},
"creationOfRight" : {
"$ref" : "#/definitions/CreationOfRight"
},
"active" : {
"type" : "boolean"
}
}
},
"TextItem" : {
"type" : "object",
"required" : [ "bold" ],
"properties" : {
"text" : {
"type" : "string",
"description" : "Text"
},
"linkToReferencedObject" : {
"description" : "Link to an object that is referenced in the text",
"$ref" : "#/definitions/Link"
},
"alignment" : {
"type" : "string",
"description" : "If set, this indicates that this text should be aligned to the left or right",
"enum" : [ "left", "right" ]
},
"bold" : {
"type" : "boolean",
"description" : "Indicates that this text should be presented with a bold text"
}
}
},
"TextLine" : {
"type" : "object",
"required" : [ "items" ],
"properties" : {
"items" : {
"type" : "array",
"description" : "List of text items on this line",
"items" : {
"$ref" : "#/definitions/TextItem"
}
},
"isActive" : {
"type" : "boolean",
"description" : "Indicates if the text represents active data. If not, it's historical."
}
}
},
"TextLineDetails" : {
"type" : "object",
"required" : [ "isActive", "text" ],
"properties" : {
"isActive" : {
"type" : "boolean"
},
"text" : {
"$ref" : "#/definitions/Code"
}
}
},
"Title" : {
"type" : "object",
"required" : [ "cadastreSellers", "shareSellers" ],
"properties" : {
"cadastreSellers" : {
"type" : "array",
"description" : "List of persons that have sold title to cadastre",
"items" : {
"$ref" : "#/definitions/CadastreOwnershipRelation"
}
},
"shareSellers" : {
"type" : "array",
"description" : "List of persons that have sold title to share",
"items" : {
"$ref" : "#/definitions/ShareOwnershipRelation"
}
},
"feeBasis" : {
"description" : "Basis for calculation of fee",
"$ref" : "#/definitions/Money"
},
"feeCause" : {
"description" : "Cause of fee",
"$ref" : "#/definitions/Code"
},
"purchasePrice" : {
"description" : "The purchase price",
"$ref" : "#/definitions/Money"
},
"hasMarketValue" : {
"type" : "boolean",
"description" : "Whether the purchase price was at market value"
},
"containsBuilding" : {
"type" : "boolean",
"description" : "Whether the realty bought contains one or more buildings"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
}
}
},
"TransferredEncumbrance" : {
"type" : "object",
"required" : [ "isActive" ],
"properties" : {
"isActive" : {
"type" : "boolean",
"description" : "Indicates if this connection is active. If not its historical"
},
"transferredTo" : {
"description" : "Contains data about what objects this encumbrance is transferred to",
"$ref" : "#/definitions/TransferredEncumbranceTo"
},
"transferredFrom" : {
"description" : "Contains data about what objects this encumbrance is transferred from",
"$ref" : "#/definitions/TransferredEncumbranceFrom"
}
}
},
"TransferredEncumbranceFrom" : {
"type" : "object",
"properties" : {
"cadastre" : {
"description" : "Encumbrance is transferred from this entire cadastre/cadastreLevel",
"$ref" : "#/definitions/CadastreLevelRelation"
},
"creationOfRightIdent" : {
"description" : "Encumbrance is transferred from this creation of right",
"$ref" : "#/definitions/CreationOfRightIdent"
}
}
},
"TransferredEncumbranceTo" : {
"type" : "object",
"properties" : {
"cadastre" : {
"description" : "This encumbrance is transferred to this entire cadastre/cadastreLevel",
"$ref" : "#/definitions/CadastreLevelRelation"
},
"ownership" : {
"description" : "This encumbrance is transferred to this ownership",
"$ref" : "#/definitions/CadastreOwnershipRelation"
}
}
},
"Transport" : {
"type" : "object",
"properties" : {
"fromPerson" : {
"type" : "array",
"description" : "Persons that the document is transported from",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"toPerson" : {
"type" : "array",
"description" : "Persons that the document is transported to",
"items" : {
"$ref" : "#/definitions/PersonRelation"
}
},
"fromCadastreLevel" : {
"type" : "array",
"description" : "CadastreLevels the document is transported from",
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"toCadastreLevel" : {
"type" : "array",
"description" : "CadastreLevels the document is transported to",
"items" : {
"$ref" : "#/definitions/CadastreLevelRelation"
}
},
"fromShareLevel" : {
"type" : "array",
"description" : "ShareLevels the document is transported from",
"items" : {
"$ref" : "#/definitions/ShareLevelRelation"
}
},
"toShareLevel" : {
"type" : "array",
"description" : "ShareLevels the document is transported to",
"items" : {
"$ref" : "#/definitions/ShareLevelRelation"
}
}
}
},
"Municipality" : {
"type" : "object",
"required" : [ "ident", "isActive", "municipalityName", "regionName", "regionNumber" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/MunicipalityIdent"
},
"municipalityName" : {
"type" : "string",
"description" : "The municipality name"
},
"regionNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The region number"
},
"regionName" : {
"type" : "string",
"description" : "The region name"
},
"isActive" : {
"type" : "boolean",
"description" : "If this municipality is active"
},
"links" : {
"$ref" : "#/definitions/MunicipalityLinks"
}
}
},
"MunicipalityIdent" : {
"type" : "object",
"required" : [ "municipalityNumber" ],
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A number representing a municipality"
}
}
},
"MunicipalityItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"MunicipalityItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Municipality"
}
}
},
"MunicipalityLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/MunicipalityItemLink"
},
"conveyances" : {
"description" : "The conveyances in this municipality",
"$ref" : "#/definitions/CadastreConveyanceListLink"
}
}
},
"MunicipalityListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Municipality"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"RealtyEstateUnit" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/RealtyEstateUnitIdent"
},
"key" : {
"type" : "string",
"description" : "The internal id"
},
"registeredDate" : {
"description" : "Registered date og the estate unit",
"$ref" : "#/definitions/ApiDate"
},
"reference" : {
"type" : "string",
"description" : "A reference to the estate unit"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/RealtyEstateUnitLinks"
}
}
},
"RealtyEstateUnitIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "An internal id for a realty estate unit"
}
}
},
"RealtyEstateUnitItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"RealtyEstateUnitLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/RealtyEstateUnitItemLink"
},
"cadastres" : {
"description" : "A link to the cadastres this realty estate unit encompasses",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"RealtyEstateUnitListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/RealtyEstateUnit"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"RealtyEstateUnitItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/RealtyEstateUnit"
}
}
},
"CadastreDocumentCopyExistenceLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CadastreDocumentCopyExistenceItemLink"
}
}
},
"CreationOfRightCopyExistence" : {
"type" : "object",
"required" : [ "documentName", "documentType", "exists", "ident", "key", "reasonNotExists" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CreationOfRightIdent"
},
"key" : {
"type" : "string"
},
"exists" : {
"type" : "boolean"
},
"reasonNotExists" : {
"type" : "string"
},
"documentType" : {
"type" : "string"
},
"documentName" : {
"type" : "string"
},
"links" : {
"$ref" : "#/definitions/CadastreDocumentCopyExistenceLinks"
}
}
},
"ShareDocumentCopyExistence" : {
"type" : "object",
"required" : [ "exists", "ident", "key", "reasonNotExists" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ShareDocumentIdent"
},
"key" : {
"type" : "string"
},
"exists" : {
"type" : "boolean"
},
"reasonNotExists" : {
"type" : "string"
},
"rights" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CreationOfRightCopyExistence"
}
},
"links" : {
"$ref" : "#/definitions/ShareDocumentCopyExistenceLinks"
}
}
},
"ShareDocumentCopyExistenceItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareDocumentCopyExistenceItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareDocumentCopyExistence"
}
}
},
"ShareDocumentCopyExistenceLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/ShareDocumentCopyExistenceItemLink"
}
}
},
"ShareDocumentIdent" : {
"type" : "object",
"required" : [ "documentNumber", "documentYear" ],
"properties" : {
"documentYear" : {
"type" : "integer",
"format" : "int32",
"description" : "The document year"
},
"documentNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The document number"
},
"office" : {
"type" : "integer",
"format" : "int32",
"description" : "The office this document was registered in"
}
}
},
"CadastreDocumentCopyExistence" : {
"type" : "object",
"required" : [ "exists", "ident", "key", "reasonNotExists" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/DocumentIdent"
},
"key" : {
"type" : "string"
},
"exists" : {
"type" : "boolean"
},
"reasonNotExists" : {
"type" : "string"
},
"rights" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CreationOfRightCopyExistence"
}
},
"links" : {
"$ref" : "#/definitions/CadastreDocumentCopyExistenceLinks"
}
}
},
"CadastreDocumentCopyExistenceItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CadastreDocumentCopyExistenceItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreDocumentCopyExistence"
}
}
},
"DocumentIdent" : {
"type" : "object",
"required" : [ "documentNumber", "documentYear", "office" ],
"properties" : {
"documentYear" : {
"type" : "integer",
"format" : "int32",
"description" : "The year this document was registered"
},
"documentNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The serial number of this document"
},
"office" : {
"type" : "integer",
"format" : "int32",
"description" : "The office number of this document"
}
}
},
"Place" : {
"type" : "object",
"required" : [ "ident", "key", "placeName", "placeType" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/PlaceIdent"
},
"key" : {
"type" : "string",
"description" : "The internal ident as string"
},
"placeName" : {
"type" : "string",
"description" : "The name of the place"
},
"placeType" : {
"type" : "string",
"description" : "The type of the place"
},
"municipality" : {
"type" : "string",
"description" : "The municipality this place is located in"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"geojson" : {
"description" : "DEPRECATED. The position of this place as GeoJSON",
"$ref" : "#/definitions/GeoJSONFeatureCollection"
}
}
},
"PlaceIdent" : {
"type" : "object",
"required" : [ "id", "uuid" ],
"properties" : {
"uuid" : {
"type" : "string",
"description" : "UUID for a place, municipality and spelling"
},
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "Kartverkets id for this place"
}
}
},
"PlaceSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Place"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"OperatingUnit" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string"
},
"municipality" : {
"description" : "The municipality this cadastre resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"propertyType" : {
"description" : "The cadastre type",
"$ref" : "#/definitions/Code"
},
"totalAgriculturalArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Agricultural area in acres"
},
"totalOtherArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Area where the use is not specified in acres"
},
"totalForestArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Forest area in acres"
},
"totalFullGrownArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Full grown areas in acres"
},
"totalCultivatedArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Cultivated area in acres"
},
"totalPastureArea" : {
"type" : "integer",
"format" : "int32",
"description" : "Pasture area in acres"
},
"totalCadastreArea" : {
"type" : "number",
"format" : "double",
"description" : "Aggregated cadastre area for operating unit, calculated as sum of all specifiedAreas in square meters"
},
"companies" : {
"type" : "array",
"description" : "Organization companies connected to cadastre",
"items" : {
"$ref" : "#/definitions/AgricultureCompany"
}
},
"agriculturalUnits" : {
"type" : "array",
"description" : "Agricultural information about this cadastre",
"items" : {
"$ref" : "#/definitions/Agriculture"
}
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the land registry"
},
"isHistoricalTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the technical land registry"
},
"industryGroup" : {
"description" : "The industrial use of this cadastre",
"$ref" : "#/definitions/Code"
},
"maxCadastreLevel" : {
"description" : "The maximum cadastre level of this operating units ownerships",
"$ref" : "#/definitions/LevelCode"
},
"links" : {
"$ref" : "#/definitions/OperatingUnitLinks"
}
}
},
"OperatingUnitItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/OperatingUnit"
}
}
},
"OperatingUnitLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/OperatingUnitItemLink"
},
"cadastre" : {
"description" : "A link to the main cadastre",
"$ref" : "#/definitions/CadastreItemLink"
}
}
},
"POCItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
}
}
},
"POCListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CulturalHeritage" : {
"type" : "object",
"required" : [ "ident", "key", "objectName" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CulturalHeritageIdent"
},
"key" : {
"type" : "string",
"description" : "The municipality, district and house serial"
},
"objectName" : {
"type" : "string",
"description" : "The given name of the heritage"
},
"siteDating" : {
"description" : "How old this heritage is",
"$ref" : "#/definitions/Code"
},
"originalFunction" : {
"type" : "string",
"description" : "What function the heritage had"
},
"currentFunction" : {
"type" : "string",
"description" : "What function the heritage has, might differ from its original function"
},
"extension" : {
"type" : "string",
"description" : "A description of any changes made to the heritage"
},
"appliesToBuildingChange" : {
"type" : "boolean",
"description" : "Whether the heritage is connected to a modification on a building, rather than the building itself"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/CulturalHeritageLinks"
}
}
},
"CulturalHeritageIdent" : {
"type" : "object",
"required" : [ "houseSerialNumber", "municipalityNumber", "registrationDistrictNumber" ],
"properties" : {
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality this heritage belongs to"
},
"registrationDistrictNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The district this heritage belongs to"
},
"houseSerialNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The serial of the building heritage"
}
}
},
"CulturalHeritageItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"CulturalHeritageLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/CulturalHeritageItemLink"
},
"buildings" : {
"description" : "The buildings connected to this heritage",
"$ref" : "#/definitions/BuildingListLink"
}
}
},
"CulturalHeritageListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CulturalHeritage"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CulturalHeritageItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CulturalHeritage"
}
}
},
"ExternalLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ExternalLinkSingleHeritage" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SingleHeritage" : {
"type" : "object",
"required" : [ "categoryCode", "eventStatus", "heritageType", "ident", "key", "lastUpdatedDate", "preservationTypeCode", "registeredDate" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/SingleHeritageIdent"
},
"key" : {
"type" : "string",
"description" : "The unique heritage serial"
},
"eventStatus" : {
"type" : "integer",
"format" : "int32",
"description" : "Whether this heritage is active (0) or historical (1)",
"minimum" : 0,
"maximum" : 1
},
"registeredDate" : {
"description" : "The date the heritage was registered",
"$ref" : "#/definitions/ApiDate"
},
"lastUpdatedDate" : {
"description" : "The date this data was last updated",
"$ref" : "#/definitions/ApiDate"
},
"categoryCode" : {
"description" : "What category does this heritage belong to. A general categorization",
"$ref" : "#/definitions/Code"
},
"heritageType" : {
"description" : "What kind of heritage this is. A specialized categorization",
"$ref" : "#/definitions/Code"
},
"preservationTypeCode" : {
"description" : "What kind of preservation rules applies to this heritage",
"$ref" : "#/definitions/Code"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/SingleHeritageLinks"
}
}
},
"SingleHeritageIdent" : {
"type" : "object",
"required" : [ "localityNumber" ],
"properties" : {
"localityNumber" : {
"type" : "string",
"description" : "An official unique serial for a single heritage"
}
}
},
"SingleHeritageItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SingleHeritageLinks" : {
"type" : "object",
"required" : [ "singleHeritageWebpage" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/SingleHeritageItemLink"
},
"buildings" : {
"description" : "The buildings connected to this heritage",
"$ref" : "#/definitions/BuildingListLink"
},
"cadastres" : {
"description" : "The cadastres connected to this heritage",
"$ref" : "#/definitions/CadastreListLink"
},
"singleHeritageWebpage" : {
"description" : "A link to source-register",
"$ref" : "#/definitions/ExternalLinkSingleHeritage"
}
}
},
"SingleHeritageListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/SingleHeritage"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"SingleHeritageItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/SingleHeritage"
}
}
},
"FloorListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Floor"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"FloorItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Floor"
}
}
},
"Scope" : {
"type" : "object",
"required" : [ "controllers", "description", "name" ],
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"controllers" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"ScopeAccess" : {
"type" : "object",
"required" : [ "scopes" ],
"properties" : {
"scopes" : {
"type" : "array",
"description" : "A list of the resources a scope yields",
"items" : {
"$ref" : "#/definitions/Scope"
}
}
}
},
"ShareRiskV2" : {
"type" : "object",
"required" : [ "description", "isPresent", "riskOnObject", "shortDescription" ],
"properties" : {
"isPresent" : {
"type" : "boolean",
"description" : "Indicating whether this risk is present or not"
},
"description" : {
"type" : "string",
"description" : "A description of this risk"
},
"shortDescription" : {
"type" : "string",
"description" : "A short description of this risk"
},
"riskOnObject" : {
"type" : "string",
"description" : "Type of object this risk is related to"
},
"levels" : {
"type" : "object",
"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.",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRiskV2RightsInLevel"
}
}
}
},
"ShareRiskV2RightsInLevel" : {
"type" : "object",
"required" : [ "rights", "shareLevel" ],
"properties" : {
"shareLevel" : {
"$ref" : "#/definitions/LevelCode"
},
"rights" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/ShareScoreRight"
}
}
}
},
"ShareScoreItemLinkV2" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ShareScoreItemResponseV2" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareScoreV2"
}
}
},
"ShareScoreLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/ShareScoreItemLink"
},
"share" : {
"description" : "Link to the current share",
"$ref" : "#/definitions/ShareItemLink"
},
"liensCalculation" : {
"description" : "Link to the share's liens calculation",
"$ref" : "#/definitions/ShareLiensCalculationItemLink"
}
}
},
"ShareScoreV2" : {
"type" : "object",
"required" : [ "ident", "key", "links" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"isScorable" : {
"type" : "boolean",
"description" : "Indicates if scoring for this share is possible"
},
"reasonNotScorable" : {
"type" : "string",
"description" : "If not scorable, this string contains the reason"
},
"overallRisk" : {
"description" : "The overall/total risk of providing a loan to the person owning this share",
"$ref" : "#/definitions/Code"
},
"highRisks" : {
"type" : "object",
"description" : "Collection of all possible high risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRiskV2"
}
},
"mediumRisks" : {
"type" : "object",
"description" : "Collection of all possible medium risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRiskV2"
}
},
"lowRisks" : {
"type" : "object",
"description" : "Collection of all possible low risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRiskV2"
}
},
"links" : {
"$ref" : "#/definitions/ShareScoreLinks"
}
}
},
"CadastreSearch" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string"
},
"extent" : {
"description" : "DEPRECATED. The extent of this cadastre",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "The extent of this cadastre in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"isRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the land registry"
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the land registry"
},
"isHistoricalTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is historical in the technical land registry"
},
"isTechnicalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether the cadastre is registered in the technical land registry"
},
"MatrikkelenId" : {
"type" : "integer",
"format" : "int64",
"description" : "A separate id to identify a cadastre in Matrikkelen"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/CadastreSearchLinks"
}
}
},
"CadastreSearchLinks" : {
"type" : "object",
"required" : [ "cadastre", "self" ],
"properties" : {
"self" : {
"description" : "Self link to cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"cadastre" : {
"description" : "Lookup link to cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"owners" : {
"description" : "Any owners of this cadastre",
"$ref" : "#/definitions/PersonListLink"
},
"addresses" : {
"description" : "The addresses of this cadastre",
"$ref" : "#/definitions/AddressListLink"
}
}
},
"CadastreSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CadastreSearch"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"District" : {
"type" : "object",
"required" : [ "districtName", "eventStatus", "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/DistrictIdent"
},
"key" : {
"type" : "string",
"description" : "The district number, code and municipality"
},
"eventStatus" : {
"type" : "integer",
"format" : "int32",
"description" : "Whether this district is active (0) or historical (1)",
"minimum" : 0,
"maximum" : 1
},
"municipality" : {
"description" : "The municipality this building resides in",
"$ref" : "#/definitions/MunicipalityData"
},
"districtName" : {
"type" : "string",
"description" : "The name of the district"
},
"links" : {
"$ref" : "#/definitions/DistrictLinks"
}
}
},
"DistrictIdent" : {
"type" : "object",
"required" : [ "districtCode", "districtNumber", "municipalityNumber" ],
"properties" : {
"districtNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The district number"
},
"districtCode" : {
"description" : "The district type",
"$ref" : "#/definitions/Code"
},
"municipalityNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The municipality the district is contained in"
}
}
},
"DistrictItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"DistrictLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/DistrictItemLink"
},
"addresses" : {
"description" : "The addresses connected to this district",
"$ref" : "#/definitions/AddressListLink"
}
}
},
"DistrictListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/District"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"DistrictItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/District"
}
}
},
"HousingCooperativeItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/HousingCooperative"
}
}
},
"ShareLiensCalculationItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareLiensCalculation"
}
}
},
"ExternalResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
}
}
},
"ShareLandRegistry" : {
"type" : "object",
"properties" : {
"landRegistryUpToDate" : {
"description" : "When the data was last updated.",
"$ref" : "#/definitions/ApiDateTime"
},
"key" : {
"type" : "string",
"description" : "The key for the share or cadastre"
},
"dateConverted" : {
"description" : "The date from which historical data is available for the current realty, usually called the conversion date.",
"$ref" : "#/definitions/ApiDate"
},
"eventStatus" : {
"type" : "string",
"description" : "The type of request",
"enum" : [ "active", "historical", "active_and_historical" ]
},
"topText" : {
"type" : "array",
"description" : "Top text displayed when there are specific notes for this land registry report",
"items" : {
"$ref" : "#/definitions/TextLine"
}
},
"formattedAddress" : {
"description" : "The presentation address for the property contains the single most relevant address that can be used when only one address should be presented.",
"$ref" : "#/definitions/AddressFormatted"
},
"allAddresses" : {
"type" : "array",
"description" : "List of all formatted addresses",
"items" : {
"$ref" : "#/definitions/AddressFormatted"
}
},
"parts" : {
"type" : "object",
"description" : "A map with the Land Registry parts found",
"additionalProperties" : {
"$ref" : "#/definitions/Part"
}
},
"shareIdent" : {
"description" : "The ident for the cadastre",
"$ref" : "#/definitions/ShareIdent"
},
"shareKey" : {
"type" : "string",
"description" : "The key for the cadastre"
},
"housingCooperative" : {
"description" : "The housing cooperative this share belongs to",
"$ref" : "#/definitions/HousingCooperative"
},
"links" : {
"$ref" : "#/definitions/ShareLandRegistryLinks"
}
}
},
"ShareLandRegistryItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareLandRegistry"
}
}
},
"ShareLandRegistryLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/ShareLandRegistryItemLink"
},
"share" : {
"description" : "Link to the current share",
"$ref" : "#/definitions/ShareItemLink"
},
"titles" : {
"description" : "Hjemmel part of Grunnbok",
"$ref" : "#/definitions/ShareLandRegistryItemLink"
},
"encumbrances" : {
"description" : "Heftelser part of Grunnbok",
"$ref" : "#/definitions/ShareLandRegistryItemLink"
},
"shareInformation" : {
"description" : "Andelsopplysninger part of Grunnbok",
"$ref" : "#/definitions/ShareLandRegistryItemLink"
}
}
},
"StreetSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Street"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CreationOfRightsListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CreationOfRight"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"Complaint" : {
"type" : "object",
"required" : [ "cadastres", "complaintConcerns", "ident", "key", "reference", "registeredDate" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ComplaintIdent"
},
"key" : {
"type" : "string",
"description" : "The internal complaint id"
},
"reference" : {
"type" : "string",
"description" : "A reference to a complaint document"
},
"complaintConcerns" : {
"type" : "string",
"description" : "A short description on what the complaint is about"
},
"registeredDate" : {
"description" : "Registered date of the complaint",
"$ref" : "#/definitions/ApiDate"
},
"cadastres" : {
"type" : "array",
"description" : "The cadastres this complaint applies to",
"items" : {
"$ref" : "#/definitions/CadastreReference"
}
},
"links" : {
"$ref" : "#/definitions/ComplaintLinks"
}
}
},
"ComplaintIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "The internal id of the complaint"
}
}
},
"ComplaintItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"ComplaintLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/ComplaintItemLink"
},
"cadastres" : {
"description" : "The cadastre this complaint concerns",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"ComplaintListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Complaint"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"ComplaintItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Complaint"
}
}
},
"ShareConveyanceItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareConveyance"
}
}
},
"ShareConveyanceListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/ShareConveyance"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CadastreListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Cadastre"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CadastreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Cadastre"
}
}
},
"User" : {
"type" : "object",
"required" : [ "active", "defaultMonthsOfData", "hasMunicipalities", "maxMonthsOfData", "showFilter", "showPropertyLayer", "userName", "xMax", "xMin", "yMax", "yMin" ],
"properties" : {
"userName" : {
"type" : "string",
"description" : "The name of the user"
},
"active" : {
"type" : "boolean",
"description" : "Whether the user is active"
},
"defaultMonthsOfData" : {
"type" : "integer",
"format" : "int32",
"description" : "The amount of historical data fetched by default expressed in months"
},
"maxMonthsOfData" : {
"type" : "integer",
"format" : "int32",
"description" : "The maximum amount of historical data that can be fetched expressed in months"
},
"showFilter" : {
"type" : "boolean",
"description" : "Whether the filter should be enabled"
},
"showPropertyLayer" : {
"type" : "boolean",
"description" : "Whether the property layer should be enabled"
},
"xMin" : {
"type" : "number",
"format" : "double",
"description" : "Lower left x coordinate"
},
"yMin" : {
"type" : "number",
"format" : "double",
"description" : "Lower left y coordinate"
},
"xMax" : {
"type" : "number",
"format" : "double",
"description" : "Upper right x coordinate"
},
"yMax" : {
"type" : "number",
"format" : "double",
"description" : "Upper right y coordinate"
},
"hasMunicipalities" : {
"type" : "boolean",
"description" : "True if the customer has access to municipalities"
}
}
},
"UserItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/User"
}
}
},
"CadastreRisk" : {
"type" : "object",
"required" : [ "description", "isPresent", "riskOnObject", "shortDescription" ],
"properties" : {
"isPresent" : {
"type" : "boolean",
"description" : "Indicating whether this risk is present or not"
},
"description" : {
"type" : "string",
"description" : "A description of this risk"
},
"shortDescription" : {
"type" : "string",
"description" : "A short description of this risk"
},
"riskOnObject" : {
"type" : "string",
"description" : "Type of object this risk is related to"
},
"levels" : {
"type" : "object",
"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.",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreRiskRightsInLevel"
}
}
}
},
"CadastreRiskRightsInLevel" : {
"type" : "object",
"required" : [ "rights" ],
"properties" : {
"cadastreLevel" : {
"description" : "The level of the cadastre where the risk was found",
"$ref" : "#/definitions/LevelCode"
},
"rights" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreScoreRight"
}
}
}
},
"CadastreScore" : {
"type" : "object",
"required" : [ "ident", "isScorable", "key", "maxCadastreLevel" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/CadastreIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"maxCadastreLevel" : {
"type" : "boolean",
"description" : "Indicates whether score applies to max cadastre level only"
},
"isScorable" : {
"type" : "boolean",
"description" : "Indicates if scoring for this cadastre is possible"
},
"reasonNotScorable" : {
"type" : "string",
"description" : "If not scorable, this string contains the reason"
},
"overallRisk" : {
"description" : "The overall/total risk of providing a loan to the person owning this cadastre",
"$ref" : "#/definitions/Code"
},
"highRisks" : {
"type" : "object",
"description" : "Collection of all possible high risks",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreRisk"
}
},
"mediumRisks" : {
"type" : "object",
"description" : "Collection of all possible medium risks",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreRisk"
}
},
"lowRisks" : {
"type" : "object",
"description" : "Collection of all possible low risks",
"additionalProperties" : {
"$ref" : "#/definitions/CadastreRisk"
}
},
"links" : {
"$ref" : "#/definitions/CadastreScoreLinks"
}
}
},
"CadastreScoreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreScore"
}
}
},
"CadastreScoreLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/CadastreScoreItemLink"
},
"cadastre" : {
"description" : "Link to the current cadastre",
"$ref" : "#/definitions/CadastreItemLink"
},
"liensCalculation" : {
"description" : "Link to the cadastre's liens calculation",
"$ref" : "#/definitions/CadastreLiensCalculationItemLink"
}
}
},
"POCGeoJSONResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"geojson" : {
"description" : "Contains the GeoJSON you've searched for",
"$ref" : "#/definitions/GeoJSONFeature"
}
}
},
"POCGeoJSONResponseCollection" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"geojson" : {
"description" : "Contains the GeoJSON FeatureCollection you've searched for",
"$ref" : "#/definitions/GeoJSONFeatureCollection"
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a GeoJSON features list",
"$ref" : "#/definitions/Pagination"
}
}
},
"Akeldo" : {
"type" : "object",
"required" : [ "roles" ],
"properties" : {
"messageTypes" : {
"type" : "array",
"description" : "Deprecated. Use messagesConsumed",
"items" : {
"type" : "string"
}
},
"messagesConsumed" : {
"type" : "array",
"description" : "The types of messages this organization can receive",
"items" : {
"type" : "string"
}
},
"messagesProduced" : {
"type" : "array",
"description" : "The types of messages this organization can send",
"items" : {
"type" : "string"
}
},
"roles" : {
"type" : "array",
"description" : "The roles an organization can have in Akeldo",
"items" : {
"type" : "string"
}
}
}
},
"Combination" : {
"type" : "object",
"properties" : {
"code" : {
"$ref" : "#/definitions/Type"
},
"combinationId" : {
"type" : "string"
},
"personRoleCombination" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SigningRole"
}
}
}
},
"ErineAddress" : {
"type" : "object",
"properties" : {
"addressLine1" : {
"type" : "string",
"description" : "The first address line"
},
"addressLine2" : {
"type" : "string",
"description" : "The second address line"
},
"addressLine3" : {
"type" : "string",
"description" : "The third address line"
},
"postalPlace" : {
"description" : "The postal place this organization is placed in",
"$ref" : "#/definitions/PostalPlace"
}
}
},
"LegalEntityRole" : {
"type" : "object",
"properties" : {
"role" : {
"$ref" : "#/definitions/Code"
},
"electedBy" : {
"$ref" : "#/definitions/Code"
},
"rolePerson" : {
"$ref" : "#/definitions/RolePerson"
},
"roleOrganization" : {
"$ref" : "#/definitions/RoleOrganization"
}
}
},
"OfficialNames" : {
"type" : "object",
"properties" : {
"officialNameLine1" : {
"type" : "string",
"description" : "The first official name"
},
"officialNameLine2" : {
"type" : "string",
"description" : "The second official name"
},
"officialNameLine3" : {
"type" : "string",
"description" : "The third official name"
},
"officialNameLine4" : {
"type" : "string",
"description" : "The fourth official name"
},
"officialNameLine5" : {
"type" : "string",
"description" : "The fifth official name"
}
}
},
"Organization" : {
"type" : "object",
"required" : [ "businessType", "country", "ident", "isActive", "key", "name", "organizationNumber", "registeredDate" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/OrganizationIdent"
},
"key" : {
"type" : "string",
"description" : "The organization key"
},
"isActive" : {
"type" : "boolean",
"description" : "If the organization record is active"
},
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization number"
},
"name" : {
"type" : "string",
"description" : "The organization name"
},
"officialNames" : {
"description" : "Official names for organization",
"$ref" : "#/definitions/OfficialNames"
},
"businessAddress" : {
"description" : "The business address",
"$ref" : "#/definitions/ErineAddress"
},
"postalAddress" : {
"description" : "The postal address",
"$ref" : "#/definitions/ErineAddress"
},
"availability" : {
"description" : "The availability code",
"$ref" : "#/definitions/Code"
},
"phoneNumber" : {
"type" : "string",
"description" : "The organization phone number"
},
"telefaxNumber" : {
"type" : "string",
"description" : "The organization telefax number"
},
"mobileNumber" : {
"type" : "string",
"description" : "The organization mobile phone number"
},
"email" : {
"type" : "string",
"description" : "The organization email address"
},
"website" : {
"type" : "string",
"description" : "The organization main website"
},
"volunteeringRegister" : {
"type" : "string",
"description" : "If the organization han en entry in the volunteering register",
"enum" : [ "NO", "YES" ]
},
"mainUnit" : {
"type" : "integer",
"format" : "int64",
"description" : "The organization number of the main unit"
},
"businessType" : {
"description" : "The organization type",
"$ref" : "#/definitions/Code"
},
"industrialClassification" : {
"type" : "array",
"description" : "The industrial classification of this organization",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"postalPlace" : {
"description" : "The postal place this organization is placed in",
"$ref" : "#/definitions/PostalPlace"
},
"municipality" : {
"description" : "The municipality this organization is placed in",
"$ref" : "#/definitions/MunicipalityData"
},
"country" : {
"type" : "string",
"description" : "The country this organization is placed in"
},
"registeredDate" : {
"description" : "The date this organization was registered",
"$ref" : "#/definitions/ApiDate"
},
"formedDate" : {
"description" : "The date this organization was formed",
"$ref" : "#/definitions/ApiDate"
},
"deletionDate" : {
"description" : "The date this organization was deleted",
"$ref" : "#/definitions/ApiDate"
},
"akeldo" : {
"description" : "Akeldo data on this organization",
"$ref" : "#/definitions/Akeldo"
},
"roles" : {
"type" : "array",
"description" : "Roles register og legal entities",
"items" : {
"$ref" : "#/definitions/RolesRegisterOfLegalEntities"
}
},
"signature" : {
"description" : "Information about signatures",
"$ref" : "#/definitions/Signature"
},
"procura" : {
"description" : "Information about procura",
"$ref" : "#/definitions/Procura"
},
"supplier" : {
"description" : "Data about supplier",
"$ref" : "#/definitions/Supplier"
},
"links" : {
"$ref" : "#/definitions/OrganizationLinks"
}
}
},
"OrganizationIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization ident"
}
}
},
"OrganizationItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Organization"
}
}
},
"OrganizationLinks" : {
"type" : "object",
"required" : [ "allDescendants", "children", "mainUnit", "parent", "root", "self" ],
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/OrganizationItemLink"
},
"mainUnit" : {
"description" : "A link to main unit",
"$ref" : "#/definitions/OrganizationItemLink"
},
"root" : {
"description" : "A link to the root parent. A root (parent) is defined as the organization on top of the hierarchy.",
"$ref" : "#/definitions/OrganizationItemLink"
},
"parent" : {
"description" : "A link to the parent. A parent is defined as an organization which owns more that fifty percent of this organization.",
"$ref" : "#/definitions/OrganizationItemLink"
},
"children" : {
"description" : "A link to the lst of children. A child is defined as an organization which is owned by more that fifty percent by this organization.",
"$ref" : "#/definitions/OrganizationListLink"
},
"allDescendants" : {
"description" : "All descendants. This is a list of all organizations below this organization including this organization.",
"$ref" : "#/definitions/OrganizationListLink"
}
}
},
"OrganizationListLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"Procura" : {
"type" : "object",
"properties" : {
"routineStatus" : {
"$ref" : "#/definitions/Type"
},
"combinationStatus" : {
"$ref" : "#/definitions/Type"
},
"ruleStatus" : {
"$ref" : "#/definitions/Type"
},
"signingBasis" : {
"$ref" : "#/definitions/SigningBasis"
},
"signingCombinations" : {
"$ref" : "#/definitions/SigningCombination"
}
}
},
"RoleOrganization" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resigned" : {
"type" : "boolean",
"description" : "This field has been removed in the Brønnøysund register, use deregisterd"
},
"deregistered" : {
"type" : "boolean",
"description" : "True if role is no longer active"
},
"order" : {
"type" : "integer",
"format" : "int32"
},
"organizationNumber" : {
"type" : "string"
},
"businessType" : {
"$ref" : "#/definitions/Code"
},
"isDeleted" : {
"type" : "boolean"
}
}
},
"RolePerson" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resigned" : {
"type" : "boolean",
"description" : "This field has been removed in the Brønnøysund register, use deregisterd"
},
"deregistered" : {
"type" : "boolean",
"description" : "True if role is no longer active"
},
"order" : {
"type" : "integer",
"format" : "int32"
},
"dateOfBirth" : {
"$ref" : "#/definitions/ApiDate"
},
"givenName" : {
"type" : "string"
},
"middleName" : {
"type" : "string"
},
"familyName" : {
"type" : "string"
},
"isDead" : {
"type" : "boolean"
}
}
},
"RolesRegisterOfLegalEntities" : {
"type" : "object",
"properties" : {
"lastUpdatedDate" : {
"$ref" : "#/definitions/ApiDate"
},
"roleGroup" : {
"$ref" : "#/definitions/Code"
},
"roles" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LegalEntityRole"
}
}
}
},
"Signature" : {
"type" : "object",
"properties" : {
"bankruptcy" : {
"type" : "boolean"
},
"underLiquidation" : {
"type" : "boolean"
},
"underForcedLiquidationOrCompulsoryDissolution" : {
"type" : "boolean"
},
"routineStatus" : {
"$ref" : "#/definitions/Type"
},
"combinationStatus" : {
"$ref" : "#/definitions/Type"
},
"ruleStatus" : {
"$ref" : "#/definitions/Type"
},
"signingBasis" : {
"$ref" : "#/definitions/SigningBasis"
},
"signingCombinations" : {
"$ref" : "#/definitions/SigningCombination"
}
}
},
"SignatureProcuraRoles" : {
"type" : "object",
"properties" : {
"freeText" : {
"type" : "string"
},
"signingRoles" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SigningRole"
}
}
}
},
"SigningBasis" : {
"type" : "object",
"properties" : {
"code" : {
"$ref" : "#/definitions/Type"
},
"signatureProcuraRoles" : {
"$ref" : "#/definitions/SignatureProcuraRoles"
},
"signingRoles" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SigningRole"
}
}
}
},
"SigningCombination" : {
"type" : "object",
"properties" : {
"combinations" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Combination"
}
}
}
},
"SigningRole" : {
"type" : "object",
"properties" : {
"dateOfBirth" : {
"$ref" : "#/definitions/ApiDate"
},
"name" : {
"type" : "string"
},
"role" : {
"$ref" : "#/definitions/Type"
}
}
},
"Supplier" : {
"type" : "object",
"properties" : {
"lineOfBusinessSystem" : {
"type" : "string",
"description" : "Name of system that an accountant is using. Can be usbl, bblpivotal or onproperty. Only filled out for accountant resource."
},
"supportsSamhandlingAccountant" : {
"type" : "boolean",
"description" : "Supports the Vitec Next 'Samhandling' integration with accountants. Only filled out for accountant resource."
},
"hasIntegration" : {
"type" : "boolean",
"description" : "Can supply data through Infoland"
},
"supplierId" : {
"type" : "string",
"description" : "Infoland supplier id"
},
"supplierUpdateTime" : {
"description" : "Supplier last updated",
"$ref" : "#/definitions/ApiDateTime"
}
}
},
"Type" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
},
"SimpleOrganization" : {
"type" : "object",
"required" : [ "ambitaDefined", "ident", "isActive", "key", "name", "organizationNumber" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/OrganizationIdent"
},
"key" : {
"type" : "string",
"description" : "The organization key"
},
"isActive" : {
"type" : "boolean",
"description" : "If the organization record is active"
},
"organizationNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "The organization number"
},
"name" : {
"type" : "string",
"description" : "The organization name"
},
"ambitaDefined" : {
"type" : "boolean",
"description" : "True if the organization is defined by Ambita (and not Brønnøysundregistrene)"
}
}
},
"SimpleOrganizationListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/SimpleOrganization"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"OrganizationListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Organization"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CodeField" : {
"type" : "object",
"required" : [ "codes", "key" ],
"properties" : {
"key" : {
"type" : "string",
"description" : "The codefield type"
},
"description" : {
"type" : "string",
"description" : "A description of the codefield"
},
"codes" : {
"type" : "array",
"description" : "A list containing the various codes that may occur in the codefield",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"links" : {
"$ref" : "#/definitions/CodeLinks"
}
}
},
"CodeFieldItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CodeField"
}
}
},
"CodeFieldListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CodeField"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"BuildingListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Building"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"BuildingItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Building"
}
}
},
"CreationOfRightItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CreationOfRight"
}
}
},
"ForretningsforerData" : {
"type" : "object",
"properties" : {
"housingData" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AccountantHousingData"
}
},
"coopInternal" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CoopInternal"
}
}
}
},
"ForretningsforerDataItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ForretningsforerData"
}
}
},
"ShareSearch" : {
"type" : "object",
"required" : [ "address", "housingCooperative", "ident", "isHistoricalRegisteredLand", "key", "municipality" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string"
},
"addressKey" : {
"type" : "string",
"description" : "Key to the shares address"
},
"formattedAddress" : {
"description" : "Formatted address",
"$ref" : "#/definitions/AddressFormatted"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"extent" : {
"description" : "DEPRECATED. The extent of this share",
"$ref" : "#/definitions/Extent"
},
"geojson" : {
"description" : "DEPRECATED. The extent of this share in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"isHistoricalRegisteredLand" : {
"type" : "boolean",
"description" : "Whether this share is active (false) or historical (true)"
},
"housingCooperative" : {
"description" : "The housing cooperative this share belongs to",
"$ref" : "#/definitions/HousingCooperative"
},
"address" : {
"description" : "Whether this share is active (false) or historical (true)",
"$ref" : "#/definitions/AddressSearch"
},
"municipality" : {
"description" : "The municipality this share belongs to",
"$ref" : "#/definitions/MunicipalityData"
},
"links" : {
"$ref" : "#/definitions/ShareSearchLinks"
}
}
},
"ShareSearchLinks" : {
"type" : "object",
"required" : [ "self", "share" ],
"properties" : {
"self" : {
"description" : "Self link to share",
"$ref" : "#/definitions/ShareItemLink"
},
"share" : {
"description" : "Lookup link to share",
"$ref" : "#/definitions/ShareItemLink"
},
"owners" : {
"description" : "Any owners of this share",
"$ref" : "#/definitions/PersonListLink"
},
"address" : {
"description" : "The address of this share",
"$ref" : "#/definitions/AddressItemLink"
}
}
},
"ShareSearchListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/ShareSearch"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"PersonScore" : {
"type" : "object",
"properties" : {
"person" : {
"$ref" : "#/definitions/Person"
},
"customerScore" : {
"$ref" : "#/definitions/CustomerScore"
},
"homeEquity" : {
"$ref" : "#/definitions/HomeEquity"
}
}
},
"PersonScoreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/PersonScore"
}
}
},
"Sectioning" : {
"type" : "object",
"required" : [ "denominator", "ident", "key", "numerator", "purposeSectioning" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/SectioningIdent"
},
"key" : {
"type" : "string",
"description" : "The cadastre and sectioning serial"
},
"numerator" : {
"type" : "number",
"description" : "The numerator of the fraction of this section"
},
"denominator" : {
"type" : "number",
"description" : "The denominator of the fraction of this section"
},
"purposeSectioning" : {
"description" : "The reason for sectioning",
"$ref" : "#/definitions/Code"
},
"links" : {
"$ref" : "#/definitions/SectioningLinks"
}
}
},
"SectioningIdent" : {
"type" : "object",
"required" : [ "cadastreIdent", "serialNumber" ],
"properties" : {
"cadastreIdent" : {
"description" : "The cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"serialNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A unique serial for the sectioning of a cadstre"
}
}
},
"SectioningItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SectioningLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/SectioningItemLink"
},
"cadastres" : {
"description" : "A link to the cadastre this section divides",
"$ref" : "#/definitions/CadastreListLink"
}
}
},
"SectioningListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Sectioning"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"SectioningItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Sectioning"
}
}
},
"ExternalLinkSoilContamination" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SoilContamination" : {
"type" : "object",
"required" : [ "authorityType", "degreeOfImpactType", "ident", "key", "lastUpdatedDate", "localityName", "registeredDate" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/SoilContaminationIdent"
},
"key" : {
"type" : "string",
"description" : "The official serial"
},
"registeredDate" : {
"description" : "The date the contamination was registered",
"$ref" : "#/definitions/ApiDate"
},
"degreeOfImpactType" : {
"description" : "The severity of the contamination",
"$ref" : "#/definitions/Code"
},
"localityName" : {
"type" : "string",
"description" : "A name of the location the contamination was located"
},
"lastUpdatedDate" : {
"description" : "The last date this data was updated",
"$ref" : "#/definitions/ApiDate"
},
"authorityType" : {
"description" : "The authority who registered this contamination",
"$ref" : "#/definitions/Code"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/SoilContaminationLinks"
}
}
},
"SoilContaminationIdent" : {
"type" : "object",
"required" : [ "localityNumber" ],
"properties" : {
"localityNumber" : {
"type" : "string",
"description" : "An official unique serial for a soil contamination"
}
}
},
"SoilContaminationItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"SoilContaminationLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/SoilContaminationItemLink"
},
"cadastres" : {
"description" : "Affected cadastres",
"$ref" : "#/definitions/CadastreListLink"
},
"soilContaminationWebpage" : {
"description" : "A link to source-register",
"$ref" : "#/definitions/ExternalLinkSoilContamination"
}
}
},
"SoilContaminationListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/SoilContamination"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"SoilContaminationItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/SoilContamination"
}
}
},
"ShareRisk" : {
"type" : "object",
"required" : [ "description", "isPresent", "riskOnObject", "shortDescription" ],
"properties" : {
"isPresent" : {
"type" : "boolean",
"description" : "Indicating whether this risk is present or not"
},
"description" : {
"type" : "string",
"description" : "A description of this risk"
},
"shortDescription" : {
"type" : "string",
"description" : "A short description of this risk"
},
"riskOnObject" : {
"type" : "string",
"description" : "Type of object this risk is related to"
},
"rights" : {
"type" : "object",
"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.",
"additionalProperties" : {
"$ref" : "#/definitions/ShareScoreRight"
}
}
}
},
"ShareScore" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"description" : "The ident for this resource",
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string",
"description" : "The key for this resource"
},
"isScorable" : {
"type" : "boolean",
"description" : "Indicates if scoring for this share is possible"
},
"reasonNotScorable" : {
"type" : "string",
"description" : "If not scorable, this string contains the reason"
},
"overallRisk" : {
"description" : "The overall/total risk of providing a loan to the person owning this share",
"$ref" : "#/definitions/Code"
},
"highRisks" : {
"type" : "object",
"description" : "Collection of all possible high risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRisk"
}
},
"mediumRisks" : {
"type" : "object",
"description" : "Collection of all possible medium risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRisk"
}
},
"lowRisks" : {
"type" : "object",
"description" : "Collection of all possible low risks",
"additionalProperties" : {
"$ref" : "#/definitions/ShareRisk"
}
},
"links" : {
"$ref" : "#/definitions/ShareScoreLinks"
}
}
},
"ShareScoreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareScore"
}
}
},
"SeparatelyOccupiedUnitListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/SeparatelyOccupiedUnit"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"SeparatelyOccupiedUnitItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/SeparatelyOccupiedUnit"
}
}
},
"UnregisteredOwnership" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/UnregisteredOwnershipIdent"
},
"key" : {
"type" : "string"
},
"cadastreLevel" : {
"description" : "Specifies what part of the cadastre the ownership is connected to",
"$ref" : "#/definitions/LevelCode"
},
"fraction" : {
"description" : "Specifies the size of an unregistered ownership as a fraction",
"$ref" : "#/definitions/Fraction"
},
"ownedCadastre" : {
"description" : "Ident of the owned cadastre",
"$ref" : "#/definitions/CadastreReference"
},
"ownerType" : {
"description" : "Owner type. Can be CADASTRE or PERSON",
"$ref" : "#/definitions/Code"
},
"owningPerson" : {
"description" : "If the owner type is PERSON this contains the owning person",
"$ref" : "#/definitions/Person"
},
"owningCadastre" : {
"description" : "If the owner type is CADASTRE then this contains the reference owning cadastre",
"$ref" : "#/definitions/CadastreReference"
},
"links" : {
"$ref" : "#/definitions/UnregisteredOwnershipLinks"
}
}
},
"UnregisteredOwnershipIdent" : {
"type" : "object",
"required" : [ "cadastreIdent", "ownershipNumber" ],
"properties" : {
"cadastreIdent" : {
"description" : "The ident for the cadastre",
"$ref" : "#/definitions/CadastreIdent"
},
"ownershipNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "A serial for all owners of the same cadastre"
},
"cadastreLevel" : {
"type" : "string",
"description" : "A string that specifies what part of the cadastre the ownership is connected to"
}
}
},
"UnregisteredOwnershipItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"UnregisteredOwnershipLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to self",
"$ref" : "#/definitions/UnregisteredOwnershipItemLink"
},
"ownedCadastre" : {
"description" : "The cadastre being owned",
"$ref" : "#/definitions/CadastreItemLink"
},
"owningPerson" : {
"description" : "The owning person",
"$ref" : "#/definitions/PersonItemLink"
},
"owningCadastre" : {
"description" : "The owning cadastre",
"$ref" : "#/definitions/CadastreItemLink"
}
}
},
"UnregisteredOwnershipListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/UnregisteredOwnership"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"UnregisteredOwnershipItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/UnregisteredOwnership"
}
}
},
"ShareOwnershipItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareOwnership"
}
}
},
"ShareOwnershipListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/ShareOwnership"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"Dictionary" : {
"type" : "object",
"required" : [ "dictionary", "fromLanguage", "toLanguage" ],
"properties" : {
"dictionary" : {
"type" : "object",
"description" : "A map containing key/value pairs of the dictionary",
"additionalProperties" : {
"type" : "string"
}
},
"fromLanguage" : {
"type" : "string",
"description" : "The language used in keys"
},
"toLanguage" : {
"type" : "string",
"description" : "The language used in values"
}
}
},
"CadastreOffice" : {
"type" : "object",
"required" : [ "documentIdent" ],
"properties" : {
"documentIdent" : {
"$ref" : "#/definitions/DocumentIdent"
}
}
},
"CadastreOfficeItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreOffice"
}
}
},
"CadastreHousingValueListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CadastreHousingValue"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"CadastreOwnershipItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/CadastreOwnership"
}
}
},
"CadastreOwnershipListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/CadastreOwnership"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"RightCollection" : {
"type" : "object",
"properties" : {
"levels" : {
"type" : "object",
"description" : "This map contains the creation of rights by level.",
"additionalProperties" : {
"$ref" : "#/definitions/RightCollectionRightsInLevel"
}
}
}
},
"RightCollectionRightsInLevel" : {
"type" : "object",
"required" : [ "heading", "level" ],
"properties" : {
"heading" : {
"type" : "string",
"description" : "Heading for this level of rights"
},
"level" : {
"description" : "The level for the rights in this collection",
"$ref" : "#/definitions/LevelCode"
},
"rights" : {
"type" : "object",
"description" : "This map contains the creation of rights for this level",
"additionalProperties" : {
"$ref" : "#/definitions/CreationOfRight"
}
}
}
},
"RightsItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/RightCollection"
}
}
},
"ValidCadastresLinks" : {
"type" : "object",
"properties" : {
"cadastre" : {
"description" : "The valid cadastre",
"$ref" : "#/definitions/CadastreItemLink"
}
}
},
"ValidateCadastre" : {
"type" : "object",
"properties" : {
"validCadastre" : {
"type" : "boolean",
"description" : "Tells whether the cadastre is ok"
},
"links" : {
"$ref" : "#/definitions/ValidCadastresLinks"
}
}
},
"ValidateCadastreItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ValidateCadastre"
}
}
},
"ShareCalculationBasis" : {
"type" : "object",
"properties" : {
"conveyance" : {
"description" : "Data about the conveyance used in calculation",
"$ref" : "#/definitions/ShareHousingValueConveyance"
},
"area" : {
"description" : "Data about the area used in calculation",
"$ref" : "#/definitions/ShareHousingValueArea"
},
"virdi" : {
"description" : "Data about the calculation when Virdi is the supplier",
"$ref" : "#/definitions/HousingValueVirdi"
},
"index" : {
"description" : "DEPRECATED. Data about the index used in calculation. Data about the used index is now present in conveyance and /or area",
"$ref" : "#/definitions/Index"
},
"unitType" : {
"description" : "Type of separately occupied unit",
"$ref" : "#/definitions/Code"
},
"preferredCalculationMethod" : {
"description" : "Preferred calculation method. Values = area,conveyance",
"$ref" : "#/definitions/Code"
}
}
},
"ShareHousingValue" : {
"type" : "object",
"required" : [ "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/ShareIdent"
},
"key" : {
"type" : "string"
},
"isCalculable" : {
"type" : "boolean",
"description" : "Indicates if the calculation is possible"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"indexSupplier" : {
"description" : "The source of the index. Current possible values=SSB,VIRDI",
"$ref" : "#/definitions/Code"
},
"indexSupplierCode" : {
"description" : "The supplier code of the used index. Only applicable for indexSupplier SSB",
"$ref" : "#/definitions/Code"
},
"calculationText" : {
"type" : "string",
"description" : "Fixed text describing the calculation"
},
"calculationBasis" : {
"description" : "Calculation basis containing conveyance and index data",
"$ref" : "#/definitions/ShareCalculationBasis"
},
"links" : {
"$ref" : "#/definitions/ShareHousingValueLinks"
}
}
},
"ShareHousingValueArea" : {
"type" : "object",
"properties" : {
"numberOfUnits" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of separately occupied units"
},
"numberOfBuildings" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of buildings"
},
"totalFloorSpace" : {
"type" : "number",
"format" : "double",
"description" : "The sum of usable area used in calculation for each cadastre"
},
"pricePerSquareMeter" : {
"type" : "number",
"format" : "double",
"description" : "Price per square meter"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
},
"indexRegion" : {
"type" : "string",
"description" : "The code of index region"
},
"indexRegionName" : {
"type" : "string",
"description" : "The name of index region"
}
}
},
"ShareHousingValueConveyance" : {
"type" : "object",
"properties" : {
"dateRegistered" : {
"description" : "The date the conveyance was registered",
"$ref" : "#/definitions/ApiDate"
},
"documentCode" : {
"description" : "The type of document",
"$ref" : "#/definitions/Code"
},
"conveyanceType" : {
"description" : "The type of conveyance",
"$ref" : "#/definitions/Code"
},
"usedForType" : {
"description" : "The use of the cadastre as defined by the purchaser",
"$ref" : "#/definitions/Code"
},
"dwellingType" : {
"description" : "The type of the dwelling as defined by the owner",
"$ref" : "#/definitions/Code"
},
"purchasePrice" : {
"type" : "integer",
"format" : "int64",
"description" : "The purchase price of the conveyance"
},
"numberOfSharesInConveyance" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of cadastres in the conveyance"
},
"appliesToEntireProperty" : {
"type" : "boolean",
"description" : "If the conveyance applies to entire cadastre"
},
"conveyanceIndexDate" : {
"description" : "The index date related to the time the conveyance occured",
"$ref" : "#/definitions/ApiDate"
},
"conveyanceIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "The index value related to the time the conveyance occured"
},
"currentIndexDate" : {
"description" : "The current index date",
"$ref" : "#/definitions/ApiDate"
},
"currentIndexValue" : {
"type" : "number",
"format" : "double",
"description" : "The current index value"
},
"indexRegion" : {
"type" : "string",
"description" : "The code of index region"
},
"indexRegionName" : {
"type" : "string",
"description" : "The name of index region"
},
"indexSupplier" : {
"description" : "The source of the index. Current possible values=SSB",
"$ref" : "#/definitions/Code"
},
"indexSupplierCode" : {
"description" : "The supplier code of the used index",
"$ref" : "#/definitions/Code"
},
"calculatedValue" : {
"type" : "integer",
"format" : "int64",
"description" : "Calculated value"
}
}
},
"ShareHousingValueItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/ShareHousingValue"
}
}
},
"ShareHousingValueLinks" : {
"type" : "object",
"required" : [ "self" ],
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/ShareHousingValueItemLink"
},
"share" : {
"description" : "The current share",
"$ref" : "#/definitions/ShareItemLink"
},
"conveyanceInCalculationBasis" : {
"description" : "Link to the conveyance used in basis for calculation",
"$ref" : "#/definitions/ShareConveyanceItemLink"
},
"conveyances" : {
"description" : "Link to the conveyances",
"$ref" : "#/definitions/ShareConveyanceListLink"
},
"address" : {
"description" : "Link to the address",
"$ref" : "#/definitions/AddressItemLink"
},
"unit" : {
"description" : "Link to the separately occupied unit",
"$ref" : "#/definitions/SeparatelyOccupiedUnitItemLink"
}
}
},
"StreetListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Street"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"StreetItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Street"
}
}
},
"Plot" : {
"type" : "object",
"required" : [ "eventStatus", "ident", "key" ],
"properties" : {
"ident" : {
"$ref" : "#/definitions/PlotIdent"
},
"key" : {
"type" : "string",
"description" : "The internal id of the plot"
},
"eventStatus" : {
"type" : "integer",
"format" : "int32",
"description" : "Whether this plot is active (0) or historical (1)",
"minimum" : 0,
"maximum" : 1
},
"area" : {
"type" : "number",
"format" : "double",
"description" : "The area of the plot"
},
"areaNotes" : {
"type" : "array",
"description" : "Notes to area",
"items" : {
"$ref" : "#/definitions/Code"
}
},
"unregisteredFarmCommons" : {
"type" : "string",
"description" : "If this is part of a farm commons but not registered as such",
"enum" : [ "J", "N" ]
},
"dispute" : {
"type" : "string",
"description" : "If it is a registered dispute for this plot",
"enum" : [ "J", "N" ]
},
"clarifiedOwnership" : {
"type" : "string",
"description" : "If this plot has a clear ownership",
"enum" : [ "J", "N" ]
},
"hasSeveralCadastreUnits" : {
"type" : "string",
"description" : "If this plot is connected to more than one cadastre",
"enum" : [ "J", "N" ]
},
"dataCaptureDate" : {
"description" : "The date this data was collected",
"$ref" : "#/definitions/ApiDate"
},
"position" : {
"description" : "Position in GeoJSON format",
"$ref" : "#/definitions/GeoJSONFeature"
},
"geojson" : {
"description" : "DEPRECATED. The position of the plot in GeoJSON format",
"$ref" : "#/definitions/GeoJSONObject"
},
"MatrikkelenUUID" : {
"type" : "string",
"description" : "UUID to uniquely identify any object in Matrikkelen"
},
"links" : {
"$ref" : "#/definitions/PlotLinks"
}
}
},
"PlotIdent" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"description" : "The internal id of the plot"
}
}
},
"PlotItemLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"PlotLinks" : {
"type" : "object",
"properties" : {
"self" : {
"description" : "A link to itself",
"$ref" : "#/definitions/PlotItemLink"
},
"cadastres" : {
"description" : "The cadastres containing this plot. Usually only one.",
"$ref" : "#/definitions/CadastreListLink"
},
"polygon" : {
"description" : "The polygon geometry of this plot as GeoJSON",
"$ref" : "#/definitions/PlotPolygonLink"
}
}
},
"PlotListResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"items" : {
"type" : "array",
"description" : "Contains the items you've searched for",
"items" : {
"$ref" : "#/definitions/Plot"
}
},
"pagination" : {
"description" : "Contains http references to the next or previous elements in a list",
"$ref" : "#/definitions/Pagination"
}
}
},
"PlotPolygonLink" : {
"type" : "object",
"required" : [ "href", "rel" ],
"properties" : {
"rel" : {
"type" : "string",
"description" : "The type of object you can expect when consuming this link"
},
"href" : {
"type" : "string",
"description" : "The http reference to this link"
},
"nickname" : {
"type" : "string",
"description" : "A nickname for this link, used in the UI"
},
"key" : {
"type" : "string",
"description" : "The key used in this link"
}
}
},
"PlotItemResponse" : {
"type" : "object",
"properties" : {
"error" : {
"description" : "Contains error messages",
"$ref" : "#/definitions/Error"
},
"info" : {
"description" : "Contains info messages",
"$ref" : "#/definitions/Info"
},
"item" : {
"description" : "Contains the item you've searched for",
"$ref" : "#/definitions/Plot"
}
}
}
}
}