Nutzungseinheiten

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Hinweise zur Funktion

Nutzungseinheiten sind definierte Bereiche eines Gebäudes, welche für die Nutzung durch Personen freigegeben werden können. Mietverträge beziehen sich üblicherweise auf Nutzungseinheiten.

Nutzungseinheiten abrufen

Version 1.0

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

buildingIdinteger · int32Optional

economicUnitIdinteger · int32Optional

includeUseUnitTypesbooleanOptionalDefault: false

includeBillingUnitsbooleanOptionalDefault: false

includeMarketingTagsbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

UsableSpacenumber · decimal · nullfähigOptional

LivingSpacenumber · decimal · nullfähigOptional

HeatingSpacenumber · decimal · nullfähigOptional

NumberOfRoomsnumber · decimal · nullfähigOptional

NumberOfHalfRoomsnumber · decimal · nullfähigOptional

DescriptionOfPositionstring · nullfähigOptional

TargetRentnumber · decimal · nullfähigOptional

ManagementStartstring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ManagementEndstring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

BindingEndDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

MoveInDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExitDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EntryDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EnergyCertificateIdinteger · int32 · nullfähigOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.0/CommercialInventory/UseUnits

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/UseUnits HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "BuildingLand": {
      "Id": 1,
      "IdNum": "text",
      "BuildingLandType": "text"
    },
    "EconomicUnit": {
      "Id": 1,
      "IdNum": "text",
      "Name": "text",
      "Location": "text"
    },
    "EstateAddress": {
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "CountryId": 1,
      "CountryCode": "text",
      "StreetComplete": "text",
      "HouseNumberComplete": "text"
    },
    "FinancingType": {
      "Id": 1,
      "Name": "text",
      "ClassificationId": 1,
      "ClassificationName": "text"
    },
    "CurrentUseUnitType": {
      "Id": 1,
      "ValidFrom": "2026-03-20",
      "ValidTo": "2026-03-20",
      "UseUnitUsageType": {
        "Id": 1,
        "Name": "text",
        "ClassificationId": 1,
        "ClassificationName": "text"
      }
    },
    "UsableSpace": 1,
    "LivingSpace": 1,
    "HeatingSpace": 1,
    "NumberOfRooms": 1,
    "NumberOfHalfRooms": 1,
    "DescriptionOfPosition": "text",
    "TargetRent": 1,
    "ManagementStart": "2026-03-20",
    "ManagementEnd": "2026-03-20",
    "BindingEndDate": "2026-03-20",
    "MoveInDate": "2026-03-20",
    "ExitDate": "2026-03-20",
    "EntryDate": "2026-03-20",
    "EnergyCertificateId": 1,
    "Position": {
      "Id": 1,
      "Name": "text"
    },
    "Floor": {
      "Id": 1,
      "Name": "text",
      "LevelToGround": 1
    },
    "ResidentialAuthorization": {
      "Id": 1,
      "Name": "text"
    },
    "EntryReason": {
      "Id": 1,
      "Name": "text"
    },
    "ExitReason": {
      "Id": 1,
      "Name": "text"
    },
    "BillingUnits": [
      {
        "Id": 1,
        "Value": 1,
        "ValidFrom": "2026-03-20",
        "ValidTo": "2026-03-20",
        "IsBaseComponentColdWater": true,
        "IsBaseComponentHeating": true,
        "IsBaseComponentWarmWater": true,
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        }
      }
    ],
    "UseUnitTypes": [
      {
        "Id": 1,
        "ValidFrom": "2026-03-20",
        "ValidTo": "2026-03-20",
        "UseUnitUsageType": {
          "Id": 1,
          "Name": "text",
          "ClassificationId": 1,
          "ClassificationName": "text"
        }
      }
    ],
    "MarketingTags": [
      {
        "Name": "text",
        "ExportKey": "text",
        "Amount": 1
      }
    ],
    "UseUnitKeys": [
      {
        "Id": 1,
        "IdNum": "text",
        "Count": 1,
        "KeyType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "CompanyCode": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    }
  }
]

---

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

useUnitNumberstringOptional

buildingLandIdinteger · int32Optional

buildingLandIdNumstringOptional

economicUnitIdinteger · int32Optional

economicUnitIdNumstringOptional

managementIdinteger · int32Optional

managementIdNumstringOptional

activeOnstring · date-timeOptional

caretakerIdinteger · int32Optional

includeUseUnitTypesbooleanOptionalDefault: false

includeFinancingTypesbooleanOptionalDefault: false

includeBillingUnitsbooleanOptionalDefault: false

includeMarketingTagsbooleanOptionalDefault: false

includeUseUnitKeysbooleanOptionalDefault: false

includeAdditionalFieldbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

UsableSpacenumber · decimal · nullfähigOptional

LivingSpacenumber · decimal · nullfähigOptional

HeatingSpacenumber · decimal · nullfähigOptional

NumberOfRoomsnumber · decimal · nullfähigOptional

NumberOfHalfRoomsnumber · decimal · nullfähigOptional

DescriptionOfPositionstring · nullfähigOptional

TargetRentnumber · decimal · nullfähigOptional

ManagementStartstring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ManagementEndstring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

BindingEndDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

MoveInDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExitDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EntryDatestring · date · nullfähigOptionalExample: 2026-03-20Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EnergyCertificateIdinteger · int32 · nullfähigOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/CommercialInventory/UseUnits

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventory/UseUnits HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "BuildingLand": {
      "Id": 1,
      "IdNum": "text",
      "BuildingLandType": "text"
    },
    "EconomicUnit": {
      "Id": 1,
      "IdNum": "text",
      "Name": "text",
      "Location": "text"
    },
    "EstateAddress": {
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "CountryId": 1,
      "CountryCode": "text",
      "StreetComplete": "text",
      "HouseNumberComplete": "text"
    },
    "CurrentFinancingType": {
      "Id": 1,
      "ValidFrom": "2026-03-20",
      "ValidTo": "2026-03-20",
      "FinancingTypeCatalog": {
        "Id": 1,
        "Name": "text",
        "ClassificationId": 1,
        "ClassificationName": "text"
      }
    },
    "CurrentUseUnitType": {
      "Id": 1,
      "ValidFrom": "2026-03-20",
      "ValidTo": "2026-03-20",
      "UseUnitUsageType": {
        "Id": 1,
        "Name": "text",
        "ClassificationId": 1,
        "ClassificationName": "text"
      }
    },
    "UsableSpace": 1,
    "LivingSpace": 1,
    "HeatingSpace": 1,
    "NumberOfRooms": 1,
    "NumberOfHalfRooms": 1,
    "DescriptionOfPosition": "text",
    "TargetRent": 1,
    "ManagementStart": "2026-03-20",
    "ManagementEnd": "2026-03-20",
    "BindingEndDate": "2026-03-20",
    "MoveInDate": "2026-03-20",
    "ExitDate": "2026-03-20",
    "EntryDate": "2026-03-20",
    "EnergyCertificateId": 1,
    "Position": {
      "Id": 1,
      "Name": "text"
    },
    "Floor": {
      "Id": 1,
      "Name": "text",
      "LevelToGround": 1
    },
    "ResidentialAuthorization": {
      "Id": 1,
      "Name": "text"
    },
    "EntryReason": {
      "Id": 1,
      "Name": "text"
    },
    "ExitReason": {
      "Id": 1,
      "Name": "text"
    },
    "CooperativeMembershipData": {
      "SharesCategory": {
        "Id": 1,
        "Code": "text"
      },
      "NeededCooperativeSharesForUseUnit": 1
    },
    "Caretaker": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "AlternativeCaretaker": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "BillingUnits": [
      {
        "Id": 1,
        "Value": 1,
        "ValidFrom": "2026-03-20",
        "ValidTo": "2026-03-20",
        "IsBaseComponentColdWater": true,
        "IsBaseComponentHeating": true,
        "IsBaseComponentWarmWater": true,
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        }
      }
    ],
    "UseUnitTypes": [
      {
        "Id": 1,
        "ValidFrom": "2026-03-20",
        "ValidTo": "2026-03-20",
        "UseUnitUsageType": {
          "Id": 1,
          "Name": "text",
          "ClassificationId": 1,
          "ClassificationName": "text"
        }
      }
    ],
    "FinancingTypes": [
      {
        "Id": 1,
        "ValidFrom": "2026-03-20",
        "ValidTo": "2026-03-20",
        "FinancingTypeCatalog": {
          "Id": 1,
          "Name": "text",
          "ClassificationId": 1,
          "ClassificationName": "text"
        }
      }
    ],
    "MarketingTags": [
      {
        "Name": "text",
        "ExportKey": "text",
        "Amount": 1
      }
    ],
    "UseUnitKeys": [
      {
        "Id": 1,
        "IdNum": "text",
        "Count": 1,
        "KeyType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "CompanyCode": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    }
  }
]

---

Die Enumerationseinträge für "CountryId" und "CountryCode" finden Sie in den Personen-Katalogen.

Enumerationseinträge für "FinancingTypeId" und "FinancingType".

Id	FinancingType
1	ohne Zuordnung
2	öffentlich gefördert
3	Freifinanziert
4	Mischfinanzierung

Enumerationseinträge für "FloorId" und "Floor".

Id	Floor
1	Keine Angaben
2	Erdgeschoss
3	1. Obergeschoss
4	2. Obergeschoss
5	3. Obergeschoss
6	4. Obergeschoss
7	5. Obergeschoss
8	6. Obergeschoss
9	7. Obergeschoss
10	8. Obergeschoss
11	9. Obergeschoss
12	10. Obergeschoss
13	11. Obergeschoss
14	12. Obergeschoss
15	13. Obergeschoss
16	14. Obergeschoss
17	15. Obergeschoss
18	16. Obergeschoss
19	17. Obergeschoss
20	18. Obergeschoss
21	19. Obergeschoss
22	20. Obergeschoss
23	21. Obergeschoss
24	22. Obergeschoss
25	23. Obergeschoss
26	24. Obergeschoss
27	DG mit Galerie
28	Penthouse
29	Dachgeschoss
30	3. OG Dachgeschoss
31	4. OG Dachgeschoss
32	5. OG Dachgeschoss
33	6. OG Dachgeschoss
34	7. OG Dachgeschoss
35	Untergeschoss
36	Souterrain
37	ebenerdig
38	Dachfläche
39	Keller