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

Version 1.2

Ausstattungselemente abrufen

Version 1.0

Version 1.2

Die Kataloge zu den Ausstattungsgruppen und Ausstattungselementen finden Sie hier.

PreviousEigentümer NextSchlüssel der Nutzungseinheit

Last updated 11 months ago

GET/openwowi/v1.0/CommercialInventory/Facility

Authorization

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*integer (int32)

Inactive*boolean

FacilityCatalog*object

Offsetnullable all of

Status*object

BuildingIdnullable integer (int32)

PropertyIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.0/CommercialInventory/Facility', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "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/openwowi/v1.0/CommercialInventory/Facility/{id}

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*integer (int32)

Inactive*boolean

FacilityCatalog*object

Offsetnullable all of

Status*object

BuildingIdnullable integer (int32)

PropertyIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.0/CommercialInventory/Facility/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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/openwowi/v1.0/CommercialInventory/Component

Authorization

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*number (decimal)

FacilityIsInactiveboolean

Offsetnullable all of

RepairRelevanceboolean

LeaseRelevanceboolean

Commentnullable string

AcquisitionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodnullable string

WarrantyEndnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsnullable string

Status*object

Positionnullable string

ValidFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

InsertAutomaticResubmissionboolean

ResubmissionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentCatalog*object

MeteringDevicenullable all of

FacilityIdinteger (int32)

BuildingIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

UnderComponentsnullable array of object

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.0/CommercialInventory/Component', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "FacilityIsInactive": true,
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "RepairRelevance": true,
    "LeaseRelevance": true,
    "Comment": "text",
    "AcquisitionDate": "2025-02-05",
    "WarrantyPeriod": "text",
    "WarrantyEnd": "2025-02-05",
    "WarrantyConditions": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "Position": "text",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "InsertAutomaticResubmission": true,
    "ResubmissionDate": "2025-02-05",
    "ComponentCatalog": {
      "Id": 1,
      "Name": "text",
      "QuantityType": {
        "Id": 1,
        "Name": "text",
        "Code": "text",
        "ArgeCode": "text"
      },
      "IsMeteringDevice": true,
      "FacilityCatalogId": 1
    },
    "MeteringDevice": {
      "MeterSerialNumber": "text",
      "EndOfGaugingTerm": "2025-02-05",
      "InstallationDate": "2025-02-05",
      "InitialValueOfMeteringDevice": 1,
      "RemovalDate": "2025-02-05",
      "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/openwowi/v1.0/CommercialInventory/Component/{id}

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*number (decimal)

FacilityIsInactiveboolean

Offsetnullable all of

RepairRelevanceboolean

LeaseRelevanceboolean

Commentnullable string

AcquisitionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodnullable string

WarrantyEndnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsnullable string

Status*object

Positionnullable string

ValidFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

InsertAutomaticResubmissionboolean

ResubmissionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentCatalog*object

MeteringDevicenullable all of

FacilityIdinteger (int32)

BuildingIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

UnderComponentsnullable array of object

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.0/CommercialInventory/Component/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "FacilityIsInactive": true,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-02-05",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-02-05",
  "WarrantyConditions": "text",
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "Position": "text",
  "ValidFrom": "2025-02-05",
  "ValidTo": "2025-02-05",
  "InsertAutomaticResubmission": true,
  "ResubmissionDate": "2025-02-05",
  "ComponentCatalog": {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "EndOfGaugingTerm": "2025-02-05",
    "InstallationDate": "2025-02-05",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-02-05",
    "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/openwowi/v1.2/CommercialInventory/Facility

Authorization

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*integer (int32)

Inactive*boolean

FacilityCatalog*object

Offsetnullable all of

Status*object

BuildingIdnullable integer (int32)

PropertyIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.2/CommercialInventory/Facility', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "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/openwowi/v1.2/CommercialInventory/Facility/{id}

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*integer (int32)

Inactive*boolean

FacilityCatalog*object

Offsetnullable all of

Status*object

BuildingIdnullable integer (int32)

PropertyIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.2/CommercialInventory/Facility/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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/openwowi/v1.2/CommercialInventory/Component

Authorization

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*number (decimal)

FacilityIsInactiveboolean

Offsetnullable all of

RepairRelevanceboolean

LeaseRelevanceboolean

Commentnullable string

AcquisitionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodnullable string

WarrantyEndnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsnullable string

Status*object

Positionnullable string

ValidFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

InsertAutomaticResubmissionboolean

ResubmissionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentCatalog*object

MeteringDevicenullable all of

FacilityIdinteger (int32)

BuildingIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

UnderComponentsnullable array of object

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.2/CommercialInventory/Component', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "Id": 1,
    "Name": "text",
    "Count": 1,
    "FacilityIsInactive": true,
    "Offset": {
      "Id": 1,
      "Value": 1,
      "Description": "text"
    },
    "RepairRelevance": true,
    "LeaseRelevance": true,
    "Comment": "text",
    "AcquisitionDate": "2025-02-05",
    "WarrantyPeriod": "text",
    "WarrantyEnd": "2025-02-05",
    "WarrantyConditions": "text",
    "Status": {
      "Id": 1,
      "Name": "text"
    },
    "Position": "text",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "InsertAutomaticResubmission": true,
    "ResubmissionDate": "2025-02-05",
    "ComponentCatalog": {
      "Id": 1,
      "Name": "text",
      "QuantityType": {
        "Id": 1,
        "Name": "text",
        "Code": "text",
        "ArgeCode": "text"
      },
      "IsMeteringDevice": true,
      "FacilityCatalogId": 1
    },
    "MeteringDevice": {
      "MeterSerialNumber": "text",
      "EndOfGaugingTerm": "2025-02-05",
      "InstallationDate": "2025-02-05",
      "InitialValueOfMeteringDevice": 1,
      "RemovalDate": "2025-02-05",
      "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/openwowi/v1.2/CommercialInventory/Component/{id}

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

Body

Id*integer (int32)

Name*string

Count*number (decimal)

FacilityIsInactiveboolean

Offsetnullable all of

RepairRelevanceboolean

LeaseRelevanceboolean

Commentnullable string

AcquisitionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodnullable string

WarrantyEndnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsnullable string

Status*object

Positionnullable string

ValidFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

InsertAutomaticResubmissionboolean

ResubmissionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentCatalog*object

MeteringDevicenullable all of

FacilityIdinteger (int32)

BuildingIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

UseUnitIdnullable integer (int32)

UnderComponentsnullable array of object

AdditionalFieldsnullable array of object

Request

const response = await fetch('/openwowi/v1.2/CommercialInventory/Component/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "Id": 1,
  "Name": "text",
  "Count": 1,
  "FacilityIsInactive": true,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-02-05",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-02-05",
  "WarrantyConditions": "text",
  "Status": {
    "Id": 1,
    "Name": "text"
  },
  "Position": "text",
  "ValidFrom": "2025-02-05",
  "ValidTo": "2025-02-05",
  "InsertAutomaticResubmission": true,
  "ResubmissionDate": "2025-02-05",
  "ComponentCatalog": {
    "Id": 1,
    "Name": "text",
    "QuantityType": {
      "Id": 1,
      "Name": "text",
      "Code": "text",
      "ArgeCode": "text"
    },
    "IsMeteringDevice": true,
    "FacilityCatalogId": 1
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "EndOfGaugingTerm": "2025-02-05",
    "InstallationDate": "2025-02-05",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-02-05",
    "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"
    }
  ]
}