Personendaten ändern

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

Um auf die Daten der Personenbearbeitung über die API zugreifen zu können, muss die Endpunktberechtigung "Personen schreiben/löschen" aktiviert werden.

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

Personen ablegen

Version 1.0

---

POST/openwowi/v1.0/PersonsWrite/Person

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger (int32)

IsNaturalPersonboolean

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

VipIdnullable integer (int32)

Confidentialboolean

TaxNumbernullable string

TaxIdentificationNumbernullable string

LegalPersonnullable all of

NaturalPersonnullable all of

FirstAddressnullable all of

Communicationsnullable array of object

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/PersonsWrite/Person', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "LegalPerson": {},
      "NaturalPerson": {
        "BirthDate": "2025-02-05",
        "DeathDate": "2025-02-05"
      },
      "FirstAddress": {},
      "Communications": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201400

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

---

Version 1.2

---

POST/openwowi/v1.2/PersonsWrite/Person

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger (int32)

IsNaturalPersonboolean

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

VipIdnullable integer (int32)

Confidentialboolean

TaxNumbernullable string

TaxIdentificationNumbernullable string

LegalPersonnullable all of

NaturalPersonnullable all of

FirstAddressnullable all of

Communicationsnullable array of object

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/PersonsWrite/Person', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "LegalPerson": {},
      "NaturalPerson": {
        "BirthDate": "2025-02-05",
        "DeathDate": "2025-02-05"
      },
      "FirstAddress": {},
      "Communications": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201400

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

---

Personen ändern

Version 1.0

---

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

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger (int32)

IsNaturalPersonboolean

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

VipIdnullable integer (int32)

Confidentialboolean

TaxNumbernullable string

TaxIdentificationNumbernullable string

LegalPersonnullable all of

NaturalPersonnullable all of

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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

---

Version 1.2

---

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

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger (int32)

IsNaturalPersonboolean

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

VipIdnullable integer (int32)

Confidentialboolean

TaxNumbernullable string

TaxIdentificationNumbernullable string

LegalPersonnullable all of

NaturalPersonnullable all of

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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

---

Personen löschen

Version 1.0

---

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

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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

---

Version 1.2

---

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

Authorization

Authorization

Path parameters

personId*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/PersonsWrite/Person/{personId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

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

---

Kontaktpersonen zu Firmen anlegen

Version 1.2

---

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

Authorization

Authorization

Path parameters

personId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

ContactPersonIdinteger (int32)

UpdateAddress3boolean

UpdateAddressLineTitleboolean

Infonullable string

Response

201400401

Created

Body

text/plainapplication/jsontext/json

LegalPersonnullable all of

RelatedContactPersonsnullable array of object

Request

JavaScriptCurlPythonHTTP

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

Response

201400

{
  "LegalPerson": {
    "Id": 1,
    "IdNum": "text"
  },
  "RelatedContactPersons": [
    {
      "Id": 1,
      "IdNum": "text"
    }
  ]
}

---

Kontaktpersonen zu Firmen löschen

Version 1.2

---

DELETE/openwowi/v1.2/PersonsWrite/Person/{personId}/DeleteLegalPersonContact/{contactPersonId}

Authorization

Authorization

Path parameters

personId*integer (int32)

contactPersonId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

LegalPersonnullable all of

RelatedContactPersonsnullable array of object

Request

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "LegalPerson": {
    "Id": 1,
    "IdNum": "text"
  },
  "RelatedContactPersons": [
    {
      "Id": 1,
      "IdNum": "text"
    }
  ]
}

---

Enumerationen für "MaritalTypeId"

ID	Type
1	Single
2	Married
3	CivilPartnered
4	Divorced
5	Widowed
6	InACommune
7	Separated
8	SeparatedCivilPartner
9	SurvivingCivilPartner
10	MaritalStatusUnknown