Housing Company API (1.0)
Download OpenAPI specification:
If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.
Get a housing company
Get housing company data.
Authorizations:
bearerAuth
path Parameters
| businessId required | string Example: 1234567-8 Business ID of the housing company. |
header Parameters
| Request-ID required | string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
Content type
application/json
{- "businessIdentification": {
- "businessId": "FI02472382",
- "schemeId": "VAT"
}, - "name": "As Oy Tammentie",
- "address": {
- "streetAddress": "Yliopistonkatu 55",
- "locality": "Tampere",
- "postcode": "33100"
}, - "plot": {
- "area": {
- "value": 2.3,
- "areaUnitCode": "M2"
}, - "holdingTypeCode": "OWN"
}, - "constructionYear": 1980,
- "buildings": [
- {
- "outerRoof": {
- "typeCode": "FLAT",
- "materialCode": "BRICK"
}, - "heatingSystemCode": "DISTRICT_HEATING",
- "hasSauna": true,
- "hasElevator": true
}
], - "energyCertificate": {
- "typeCode": "A_2018",
- "description": "Energy certificate is not available"
}, - "apartmentCount": 10,
- "businessPremisesCount": 10,
- "parkingSpaceDescription": "One parking space for each apartment",
- "pastRenovations": [
- {
- "typeCode": "LIFT",
- "year": 2020
}
]
}