Adressen ändern

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

Hinweise zur Funktion

Eine Person kann über mehrere Anschriften verfügen. Wenn Sie eine neue Anschrift erfassen, wird die alte Anschrift hierdurch nicht automatisch ungültig.

Anstatt eine ungültige Adresse zu löschen, empfehlen wir, die alte Adresse mit einem Enddatum zu versehen. Diese Eigenschaft kann im Feld "ValidTo" hinterlegt werden.

Hierdurch wird die Nachvollziehbarkeit in WOWIPORT für alte Anschriften gewährleistet.

Eine neue Adresse zur Person erfassen

Version 1.0

---

POST/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

AddressTypeIdnullable integer (int32)

Zipnullable string

Townnullable string

Streetnullable string

HouseNumbernullable string

HouseNumberAdditionnullable string

CountryIdnullable integer (int32)

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

Response

201400401

Created

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

201400

1

---

Version 1.2

---

POST/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

AddressTypeIdnullable integer (int32)

Zipnullable string

Townnullable string

Streetnullable string

HouseNumbernullable string

HouseNumberAdditionnullable string

CountryIdnullable integer (int32)

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

Response

201400401

Created

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

201400

1

---

Eine bestehende Adresse ändern

Version 1.0

---

PUT/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses/{childId}

Authorization

Authorization

Path parameters

personId*integer (int32)

childId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

AddressTypeIdnullable integer (int32)

Zipnullable string

Townnullable string

Streetnullable string

HouseNumbernullable string

HouseNumberAdditionnullable string

CountryIdnullable integer (int32)

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

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses/{childId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

1

---

Version 1.2

---

PUT/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses/{childId}

Authorization

Authorization

Path parameters

personId*integer (int32)

childId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

AddressTypeIdnullable integer (int32)

Zipnullable string

Townnullable string

Streetnullable string

HouseNumbernullable string

HouseNumberAdditionnullable string

CountryIdnullable integer (int32)

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

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses/{childId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

1

---

Eine bestehende Adresse löschen

Version 1.0

---

DELETE/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses/{childId}

Authorization

Authorization

Path parameters

personId*integer (int32)

childId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/PersonsWrite/Person/{personId}/Addresses/{childId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

1

---

Version 1.2

---

DELETE/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses/{childId}

Authorization

Authorization

Path parameters

personId*integer (int32)

childId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

integer (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/PersonsWrite/Person/{personId}/Addresses/{childId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

1

---