Kataloge

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

Nutzungseinheitenarten abrufen

Dieser Abruf enthält die Nutzungseinheitenarten, welche den Nutzungseinheiten zugeordnet sein können.

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/UseUnitTypeCatalog HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/UseUnitType HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  }
]

---

Stadtteile abrufen

Dieser Abruf enthält die Stadtteile, welche den Nutzungseinheiten zugeordnet sein können.

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/Districts HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/Districts HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Gebäudeart abrufen

Dieser Abruf enthält die Gebäudearten, welche den Gebäuden zugeordnet sein können.

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/BuildingTypes HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/BuildingTypes HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Ausstattungsgruppen abrufen

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

availableEconomicUnitLandbooleanOptionalDefault: false

availableBuildingbooleanOptionalDefault: false

availableUseUnitbooleanOptionalDefault: false

includeComponentsbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/FacilityCatalog HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "AvailableEconomicUnitLand": true,
    "AvailableBuilding": true,
    "AvailableUseUnit": true,
    "RepairRelevance": true,
    "FacilityCatalogDefault": {
      "Id": 1,
      "Name": "text"
    },
    "ComponentCatalogItems": [
      {
        "Id": 1,
        "Name": "text",
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        },
        "IsMeteringDevice": true,
        "FacilityCatalogId": 1
      }
    ]
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

availableEconomicUnitLandbooleanOptionalDefault: false

availableBuildingbooleanOptionalDefault: false

availableUseUnitbooleanOptionalDefault: false

includeComponentsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/FacilityCatalog HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "AvailableEconomicUnitLand": true,
    "AvailableBuilding": true,
    "AvailableUseUnit": true,
    "RepairRelevance": true,
    "FacilityCatalogDefault": {
      "Id": 1,
      "Name": "text"
    },
    "ComponentCatalogItems": [
      {
        "Id": 1,
        "Name": "text",
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        },
        "IsMeteringDevice": true,
        "FacilityCatalogId": 1
      }
    ]
  }
]

---

Ausstattungselemente abrufen

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

facilityIdinteger · int32Optional

facilityAvailableEconomicUnitLandbooleanOptionalDefault: false

facilityAvailableBuildingbooleanOptionalDefault: false

facilityAvailableUseUnitbooleanOptionalDefault: false

isMeterbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/ComponentCatalog HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1,
    "Comment": "text",
    "FacilityCatalog": {
      "Id": 1,
      "Name": "text"
    },
    "IsMaintenanceRelevant": true,
    "IsRepairRelevant": true,
    "IsLeaseRelevant": true,
    "IsWarrantyRelevant": true
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

facilityIdinteger · int32Optional

facilityAvailableEconomicUnitLandbooleanOptionalDefault: false

facilityAvailableBuildingbooleanOptionalDefault: false

facilityAvailableUseUnitbooleanOptionalDefault: false

isMeterbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/ComponentCatalog HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1,
    "Comment": "text",
    "FacilityCatalog": {
      "Id": 1,
      "Name": "text"
    },
    "IsMaintenanceRelevant": true,
    "IsRepairRelevant": true,
    "IsLeaseRelevant": true,
    "IsWarrantyRelevant": true
  }
]

---

Ausstattungsmerkmale abrufen

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/UnderComponent HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "NodeId": 1
  }
]

---

Abrechnungsgrößen abrufen

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/QuantityType HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Code": "text",
    "ArgeCode": "text"
  }
]

---

Abteilungsart

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/DepartmentType HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Abteilungstyp

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/DepartmentSubtype HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text"
  }
]

---

Schlüsselarten

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventoryCatalog/KeyType HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Code": "text"
  }
]

---