Ausstattung

Nähere Informationen zu Ausstattungsgruppen und -elementen finden Sie im Bereich "Ausstattung"

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

Ausstattungsgruppen abrufen

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

facilityIdinteger · int32Optional

useUnitIdinteger · int32Optional

buildingIdinteger · int32Optional

propertyIdinteger · int32Optional

economicUnitIdinteger · int32Optional

includeAdditionalFieldbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

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

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "Inactive": true,
    "FacilityCatalog": {
      "Id": 1,
      "Name": "text"
    },
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "BuildingId": 1,
    "PropertyId": 1,
    "EconomicUnitId": 1,
    "UseUnitId": 1,
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

apiKeystringOptional

includeAdditionalFieldbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/Facility/{id} HTTP/1.1
Host: 
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "Inactive": true,
  "FacilityCatalog": {
    "Id": 1,
    "Name": "text"
  },
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "BuildingId": 1,
  "PropertyId": 1,
  "EconomicUnitId": 1,
  "UseUnitId": 1,
  "AdditionalFields": [
    {
      "Name": "text",
      "Content": "text",
      "Type": "text"
    }
  ]
}

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

facilityIdinteger · int32Optional

useUnitIdinteger · int32Optional

buildingIdinteger · int32Optional

propertyIdinteger · int32Optional

economicUnitIdinteger · int32Optional

includeAdditionalFieldbooleanOptionalDefault: 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/CommercialInventory/Facility HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "Inactive": true,
    "FacilityCatalog": {
      "Id": 1,
      "Name": "text"
    },
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "BuildingId": 1,
    "PropertyId": 1,
    "EconomicUnitId": 1,
    "UseUnitId": 1,
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

apiKeystringOptional

includeAdditionalFieldbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventory/Facility/{id} HTTP/1.1
Host: 
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "Inactive": true,
  "FacilityCatalog": {
    "Id": 1,
    "Name": "text"
  },
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "BuildingId": 1,
  "PropertyId": 1,
  "EconomicUnitId": 1,
  "UseUnitId": 1,
  "AdditionalFields": [
    {
      "Name": "text",
      "Content": "text",
      "Type": "text"
    }
  ]
}

---

Ausstattungselemente abrufen

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

componentIdinteger · int32Optional

facilityIdinteger · int32Optional

useUnitIdinteger · int32Optional

buildingIdinteger · int32Optional

landIdinteger · int32Optional

economicUnitIdinteger · int32Optional

includeAdditionalFieldbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

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

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "FacilityIsInactive": true,
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "RepairRelevance": true,
    "LeaseRelevance": true,
    "Comment": "text",
    "AcquisitionDate": "2025-05-12",
    "WarrantyPeriod": "text",
    "WarrantyEnd": "2025-05-12",
    "WarrantyConditions": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "Position": "text",
    "ValidFrom": "2025-05-12",
    "ValidTo": "2025-05-12",
    "InsertAutomaticResubmission": true,
    "ResubmissionDate": "2025-05-12",
    "ComponentCatalog": {
      "Id": 1,
      "Name": "text",
      "QuantityType": {
        "Id": 1,
        "Name": "text",
        "Code": "text",
        "ArgeCode": "text"
      },
      "IsMeteringDevice": true,
      "FacilityCatalogId": 1
    },
    "MeteringDevice": {
      "MeterSerialNumber": "text",
      "EndOfGaugingTerm": "2025-05-12",
      "InstallationDate": "2025-05-12",
      "InitialValueOfMeteringDevice": 1,
      "RemovalDate": "2025-05-12",
      "SummationMeter": true,
      "ReplacedByComponent": 1,
      "MeteringDeviceType": {
        "Id": 1,
        "Name": "text"
      },
      "ValuationFactorKq": 1,
      "ValuationFactorKc": 1,
      "Virtual": true
    },
    "FacilityId": 1,
    "BuildingId": 1,
    "EconomicUnitId": 1,
    "UseUnitId": 1,
    "UnderComponents": [
      {
        "Id": 1,
        "Name": "text"
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

apiKeystringOptional

includeAdditionalFieldbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/CommercialInventory/Component/{id} HTTP/1.1
Host: 
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "FacilityIsInactive": true,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-05-12",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-05-12",
  "WarrantyConditions": "text",
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "Position": "text",
  "ValidFrom": "2025-05-12",
  "ValidTo": "2025-05-12",
  "InsertAutomaticResubmission": true,
  "ResubmissionDate": "2025-05-12",
  "ComponentCatalog": {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "EndOfGaugingTerm": "2025-05-12",
    "InstallationDate": "2025-05-12",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-05-12",
    "SummationMeter": true,
    "ReplacedByComponent": 1,
    "MeteringDeviceType": {
      "Id": 1,
      "Name": "text"
    },
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "FacilityId": 1,
  "BuildingId": 1,
  "EconomicUnitId": 1,
  "UseUnitId": 1,
  "UnderComponents": [
    {
      "Id": 1,
      "Name": "text"
    }
  ],
  "AdditionalFields": [
    {
      "Name": "text",
      "Content": "text",
      "Type": "text"
    }
  ]
}

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

componentIdinteger · int32Optional

facilityIdinteger · int32Optional

useUnitIdinteger · int32Optional

buildingIdinteger · int32Optional

landIdinteger · int32Optional

economicUnitIdinteger · int32Optional

includeAdditionalFieldbooleanOptionalDefault: 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/CommercialInventory/Component HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "FacilityIsInactive": true,
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "RepairRelevance": true,
    "LeaseRelevance": true,
    "Comment": "text",
    "AcquisitionDate": "2025-05-12",
    "WarrantyPeriod": "text",
    "WarrantyEnd": "2025-05-12",
    "WarrantyConditions": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "Position": "text",
    "ValidFrom": "2025-05-12",
    "ValidTo": "2025-05-12",
    "InsertAutomaticResubmission": true,
    "ResubmissionDate": "2025-05-12",
    "ComponentCatalog": {
      "Id": 1,
      "Name": "text",
      "QuantityType": {
        "Id": 1,
        "Name": "text",
        "Code": "text",
        "ArgeCode": "text"
      },
      "IsMeteringDevice": true,
      "FacilityCatalogId": 1
    },
    "MeteringDevice": {
      "MeterSerialNumber": "text",
      "EndOfGaugingTerm": "2025-05-12",
      "InstallationDate": "2025-05-12",
      "InitialValueOfMeteringDevice": 1,
      "RemovalDate": "2025-05-12",
      "SummationMeter": true,
      "ReplacedByComponent": 1,
      "MeteringDeviceType": {
        "Id": 1,
        "Name": "text"
      },
      "ValuationFactorKq": 1,
      "ValuationFactorKc": 1,
      "Virtual": true
    },
    "FacilityId": 1,
    "BuildingId": 1,
    "EconomicUnitId": 1,
    "UseUnitId": 1,
    "UnderComponents": [
      {
        "Id": 1,
        "Name": "text"
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

apiKeystringOptional

includeAdditionalFieldbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/CommercialInventory/Component/{id} HTTP/1.1
Host: 
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "FacilityIsInactive": true,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-05-12",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-05-12",
  "WarrantyConditions": "text",
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "Position": "text",
  "ValidFrom": "2025-05-12",
  "ValidTo": "2025-05-12",
  "InsertAutomaticResubmission": true,
  "ResubmissionDate": "2025-05-12",
  "ComponentCatalog": {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "EndOfGaugingTerm": "2025-05-12",
    "InstallationDate": "2025-05-12",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-05-12",
    "SummationMeter": true,
    "ReplacedByComponent": 1,
    "MeteringDeviceType": {
      "Id": 1,
      "Name": "text"
    },
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "FacilityId": 1,
  "BuildingId": 1,
  "EconomicUnitId": 1,
  "UseUnitId": 1,
  "UnderComponents": [
    {
      "Id": 1,
      "Name": "text"
    }
  ],
  "AdditionalFields": [
    {
      "Name": "text",
      "Content": "text",
      "Type": "text"
    }
  ]
}

---

Die Kataloge zu den Ausstattungsgruppen und Ausstattungselementen finden Sie hier.