Ausstattungselemente

Über diese Endpunkte können Ausstattungselemente verändert werden.

Hinweise zur Funktion

Ausstattungselemente sind bewegliche Dinge im oder am Objekt. Sie müssen immer einer Ausstattungsgruppenart zugeordnet sein.

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

Zu den Endpunkten besteht noch ein offener User-Request, welcher die Struktur des Datenobjektes betrifft.

Ausstattungselement anlegen

Version 1.0

---

POST/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component

Authorization

Authorization

Path parameters

facilityId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Name*string

Count*number (decimal)

Pattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

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

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])

ComponentStatusId*integer (int32)

ComponentCatalogId*integer (int32)

Offsetnullable all of

MeteringDevicenullable all of

UnderComponentIdsnullable array of integer (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "text",
      "Count": 1,
      "AcquisitionDate": "2025-02-05",
      "WarrantyEnd": "2025-02-05",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "ComponentStatusId": 1,
      "ComponentCatalogId": 1,
      "Offset": {
        "Value": 1
      },
      "MeteringDevice": {
        "MeterSerialNumber": "text",
        "EndOfGaugingTerm": "2025-02-05",
        "InstallationDate": "2025-02-05",
        "RemovalDate": "2025-02-05",
        "Virtual": true
      },
      "UnderComponentIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

201400

1

---

Version 1.2

---

POST/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component

Authorization

Authorization

Path parameters

facilityId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Name*string

Count*number (decimal)

Pattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

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

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])

ComponentStatusId*integer (int32)

ComponentCatalogId*integer (int32)

Offsetnullable all of

MeteringDevicenullable all of

UnderComponentIdsnullable array of integer (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "text",
      "Count": 1,
      "AcquisitionDate": "2025-02-05",
      "WarrantyEnd": "2025-02-05",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "ComponentStatusId": 1,
      "ComponentCatalogId": 1,
      "Offset": {
        "Value": 1
      },
      "MeteringDevice": {
        "MeterSerialNumber": "text",
        "EndOfGaugingTerm": "2025-02-05",
        "InstallationDate": "2025-02-05",
        "RemovalDate": "2025-02-05",
        "Virtual": true
      },
      "UnderComponentIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

201400

1

---

Ausstattungselement ändern

Version 1.0

---

PUT/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

Authorization

Authorization

Path parameters

facilityId*integer (int32)

componentId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Name*string

Count*number (decimal)

Pattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

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

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])

ComponentStatusId*integer (int32)

ComponentCatalogId*integer (int32)

Offsetnullable all of

MeteringDevicenullable all of

UnderComponentIdsnullable array of integer (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "text",
      "Count": 1,
      "AcquisitionDate": "2025-02-05",
      "WarrantyEnd": "2025-02-05",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "ComponentStatusId": 1,
      "ComponentCatalogId": 1,
      "Offset": {
        "Value": 1
      },
      "MeteringDevice": {
        "MeterSerialNumber": "text",
        "EndOfGaugingTerm": "2025-02-05",
        "InstallationDate": "2025-02-05",
        "RemovalDate": "2025-02-05",
        "Virtual": true
      },
      "UnderComponentIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

200400

1

---

Version 1.2

---

PUT/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

Authorization

Authorization

Path parameters

facilityId*integer (int32)

componentId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Name*string

Count*number (decimal)

Pattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

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

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])

ComponentStatusId*integer (int32)

ComponentCatalogId*integer (int32)

Offsetnullable all of

MeteringDevicenullable all of

UnderComponentIdsnullable array of integer (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "text",
      "Count": 1,
      "AcquisitionDate": "2025-02-05",
      "WarrantyEnd": "2025-02-05",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "ComponentStatusId": 1,
      "ComponentCatalogId": 1,
      "Offset": {
        "Value": 1
      },
      "MeteringDevice": {
        "MeterSerialNumber": "text",
        "EndOfGaugingTerm": "2025-02-05",
        "InstallationDate": "2025-02-05",
        "RemovalDate": "2025-02-05",
        "Virtual": true
      },
      "UnderComponentIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

200400

1

---

Ausstattungselement löschen

Version 1.0

---

DELETE/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

Authorization

Authorization

Path parameters

facilityId*integer (int32)

componentId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

1

---

Version 1.2

---

DELETE/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

Authorization

Authorization

Path parameters

facilityId*integer (int32)

componentId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

1

---

Enumerationen für FacilityStatusId

Id	Type
1	Unaudited
2	Audited
3	Automatic

Enumerationen für "MeteringDeviceTypeId"

Id	Type
1	HeatCostAllocatorEvaporation
2	HeatCostAllocatorElectronic
3	HeatMeterHeatingWarmwater
4	MeterColdwater
5	MeterWarmwater
6	HeatMeterWarmwater
7	HeatMeterHeating
8	WarmwaterAllocatorEvaporation
9	WarmwaterAllocatorMechanical
10	CondensateMeterHeating
11	CondensateMeterWarmwater
12	MeterOil
13	MeterPower
14	MeterGas
15	PipeHeatEmission