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
Autorisierungen
Abfrageparameter
apiKeystringErforderlich
Rumpf
ExternalIdentificationNumberstring | nullfähigOptional
LicenseAgreementIdinteger · int32Optional
ResponsibleOfficialIdinteger · int32Optional
HandoverTypeSpecificationIdinteger · int32Optional
HandoverTypeIdinteger · int32Optional
HandoverStateIdinteger · int32Optional
Datestring · date-timeOptional
RequireNextHandoverbooleanOptional
ProtocolDeliveryViaMailbooleanOptional
Remarkstring | nullfähigOptional
KeyExchangeInfostring | nullfähigOptional
Antworten
201

Created

post
/openwowi/v1.2/HandoverEdit/Handover
POST /openwowi/v1.2/HandoverEdit/Handover?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "ExternalIdentificationNumber": "text",
  "LicenseAgreementId": 1,
  "ResponsibleOfficialId": 1,
  "HandoverTypeSpecificationId": 1,
  "HandoverTypeId": 1,
  "HandoverStateId": 1,
  "Date": "2025-10-31T11:50:32.147Z",
  "RequireNextHandover": true,
  "ProtocolDeliveryViaMail": true,
  "Remark": "text",
  "KeyExchangeInfo": "text"
}
{
  "Id": 1,
  "IdNum": "text"
}

Wohnungsübergaben ändern

Version 1.2

put
Autorisierungen
Pfadparameter
handoverIdinteger · int32Erforderlich
Abfrageparameter
apiKeystringErforderlich
Rumpf
ExternalIdentificationNumberstring | nullfähigOptional
LicenseAgreementIdinteger · int32Optional
ResponsibleOfficialIdinteger · int32Optional
HandoverTypeSpecificationIdinteger · int32Optional
HandoverTypeIdinteger · int32Optional
HandoverStateIdinteger · int32Optional
Datestring · date-timeOptional
RequireNextHandoverbooleanOptional
ProtocolDeliveryViaMailbooleanOptional
Remarkstring | nullfähigOptional
KeyExchangeInfostring | nullfähigOptional
ConsentRefusedbooleanOptional
AgreementDateContractorstring · date | nullfähigOptionalExample: 2025-10-31Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
Antworten
200

OK

put
/openwowi/v1.2/HandoverEdit/Handover/{handoverId}
PUT /openwowi/v1.2/HandoverEdit/Handover/{handoverId}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "ExternalIdentificationNumber": "text",
  "LicenseAgreementId": 1,
  "ResponsibleOfficialId": 1,
  "HandoverTypeSpecificationId": 1,
  "HandoverTypeId": 1,
  "HandoverStateId": 1,
  "Date": "2025-10-31T11:50:32.147Z",
  "RequireNextHandover": true,
  "ProtocolDeliveryViaMail": true,
  "Remark": "text",
  "KeyExchangeInfo": "text",
  "ConsentRefused": true,
  "AgreementDateContractor": "2025-10-31"
}
{
  "Id": 1,
  "IdNum": "text"
}

Wohnungsübergaben löschen

Version 1.2

delete
Autorisierungen
Pfadparameter
handoverIdinteger · int32Erforderlich
Abfrageparameter
apiKeystringErforderlich
Antworten
200

OK

delete
/openwowi/v1.2/HandoverEdit/Handover/{handoverId}
DELETE /openwowi/v1.2/HandoverEdit/Handover/{handoverId}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Wohnungsübergaben Details hinzufügen

Version 1.2

put
Autorisierungen
Pfadparameter
handoverIdinteger · int32Erforderlich
Abfrageparameter
apiKeystringErforderlich
Rumpf
Datestring · dateOptionalExample: 2025-10-31Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
Remarkstring | nullfähigOptional
KeyExchangeInfostring | nullfähigOptional
ConsentRefusedbooleanOptional
RequireNextHandoverbooleanOptional
ProtocolDeliveryViaMailbooleanOptional
AgreementDateContractorstring · date | nullfähigOptionalExample: 2025-10-31Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
Antworten
200

OK

put
/openwowi/v1.2/HandoverEdit/Handover/{handoverId}/Data
PUT /openwowi/v1.2/HandoverEdit/Handover/{handoverId}/Data?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 554

{
  "Date": "2025-10-31",
  "Remark": "text",
  "KeyExchangeInfo": "text",
  "ConsentRefused": true,
  "RequireNextHandover": true,
  "ProtocolDeliveryViaMail": true,
  "AgreementDateContractor": "2025-10-31",
  "ContractParties": [
    {
      "ContractualUseId": 1,
      "IsAttending": true
    }
  ],
  "Facilities": [
    {
      "FacilityId": 1,
      "Note": "text",
      "Components": [
        {
          "ComponentsId": 1,
          "RequiredWorkId": 1,
          "RestorationDutyId": 1,
          "IsContractual": true,
          "IsWorking": true,
          "Note": "text",
          "ShortDescription": "text",
          "MeteringValue": {
            "Number": "text",
            "Amount": 1
          }
        }
      ]
    }
  ],
  "UseUnitKeys": [
    {
      "UseUnitKeyId": 1,
      "ExchangedKeys": 1,
      "Note": "text"
    }
  ]
}
{
  "Id": 1,
  "IdNum": "text"
}
VorherigeKataloge

Zuletzt aktualisiert