Wohnungsübergabe

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "HandoverEdit".

Um auf die Daten der Wohnungsübergaben über die API zugreifen zu können, muss die Endpunktberechtigung "Übergaben bearbeiten" aktiviert werden.

Hinweise zur Funktion

Eine Wohnungsübergabe findet allgemein in zwei oder mehr Terminen statt. Der Endpunkt für die Anlage einer Wohnungsübergabe erfolgt über POST "/openwowi/v1.2/HandoverEdit/Handover". Die Details zur Wohnungsübergabe, nach dem erfolgreichen Abschluss, können über den Endpunkt PUT "/openwowi/v1.2/HandoverEdit/Handover/{handoverId}/Data" hinzugefügt werden. Fotos und Dokumente zur Wohnungsübergabe sowie Mängel können später über die entsprechenden API Endpunkte erstellt und mit der Wohnungsübergabe verknüpft werden.

Die Endpunkte für die Abfrage der Wohnungsübergaben finden Sie hier.

Die Daten für Ableseergebnisse in den Wohnungsübergaben werden nicht in die Verbrauchsdaten übertragen. Die Endpunkte werden diesbezüglich ggf. noch überarbeitet.

Wohnungsübergaben anlegen

Version 1.2

---

POST/openwowi/v1.2/HandoverEdit/Handover

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

ExternalIdentificationNumbernullable string

LicenseAgreementIdinteger (int32)

ResponsibleOfficialIdinteger (int32)

HandoverTypeSpecificationIdinteger (int32)

HandoverTypeIdinteger (int32)

HandoverStateIdinteger (int32)

Datestring (date-time)

RequireNextHandoverboolean

ProtocolDeliveryViaMailboolean

Remarknullable string

KeyExchangeInfonullable string

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/HandoverEdit/Handover?apiKey=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "Id": 1,
  "IdNum": "text"
}

---

Wohnungsübergaben ändern

Version 1.2

---

PUT/openwowi/v1.2/HandoverEdit/Handover/{handoverId}

Authorization

Authorization

Path parameters

handoverId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

ExternalIdentificationNumbernullable string

LicenseAgreementIdinteger (int32)

ResponsibleOfficialIdinteger (int32)

HandoverTypeSpecificationIdinteger (int32)

HandoverTypeIdinteger (int32)

HandoverStateIdinteger (int32)

Datestring (date-time)

RequireNextHandoverboolean

ProtocolDeliveryViaMailboolean

Remarknullable string

KeyExchangeInfonullable string

ConsentRefusedboolean

AgreementDateContractornullable string (date)

Example: "2025-02-05"

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

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/HandoverEdit/Handover/{handoverId}?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "AgreementDateContractor": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text"
}

---

Wohnungsübergaben löschen

Version 1.2

---

DELETE/openwowi/v1.2/HandoverEdit/Handover/{handoverId}

Authorization

Authorization

Path parameters

handoverId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/HandoverEdit/Handover/{handoverId}?apiKey=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text"
}

---

Wohnungsübergaben Details hinzufügen

Version 1.2

---

PUT/openwowi/v1.2/HandoverEdit/Handover/{handoverId}/Data

Authorization

Authorization

Path parameters

handoverId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Datestring (date)

Example: "2025-02-05"

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

Remarknullable string

KeyExchangeInfonullable string

ConsentRefusedboolean

RequireNextHandoverboolean

ProtocolDeliveryViaMailboolean

AgreementDateContractornullable string (date)

Example: "2025-02-05"

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

ContractPartiesnullable array of object

Facilitiesnullable array of object

UseUnitKeysnullable array of object

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/HandoverEdit/Handover/{handoverId}/Data?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Date": "2025-02-05",
      "AgreementDateContractor": "2025-02-05",
      "ContractParties": [
        {}
      ],
      "Facilities": [
        {
          "Components": [
            {
              "MeteringValue": {}
            }
          ]
        }
      ],
      "UseUnitKeys": [
        {}
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text"
}

---