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

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

Body

NodeIdinteger · int32Optional

IdNumstring · nullableOptional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullableOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

VipIdinteger · int32 · nullableOptional

ConfidentialbooleanOptional

TaxNumberstring · nullableOptional

TaxIdentificationNumberstring · nullableOptional

Antworten

201

Created

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

post/openwowi/v1.0/PersonsWrite/Person

POST /openwowi/v1.0/PersonsWrite/Person HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 796

{
  "NodeId": 1,
  "IdNum": "text",
  "IsNaturalPerson": true,
  "ValidFrom": "2026-08-19",
  "ValidTo": "2026-08-19",
  "VipId": 1,
  "Confidential": true,
  "TaxNumber": "text",
  "TaxIdentificationNumber": "text",
  "LegalPerson": {
    "LongName1": "text",
    "LongName2": "text",
    "VatId": "text",
    "CommercialRegisterNumber": "text",
    "CommercialRegisterTown": "text",
    "CompanyFormId": 1,
    "IndustryId": 1
  },
  "NaturalPerson": {
    "FirstName": "text",
    "LastName": "text",
    "BirthName": "text",
    "CareOf": "text",
    "Title": "text",
    "BirthDate": "2026-08-19",
    "DeathDate": "2026-08-19",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  },
  "FirstAddress": {
    "AddressTypeId": 1,
    "Zip": "text",
    "Town": "text",
    "Street": "text",
    "HouseNumber": "text",
    "HouseNumberAddition": "text",
    "CountryId": 1
  },
  "Communications": [
    {
      "CommunicationTypeId": 1,
      "Content": "text",
      "Explanation": "text"
    }
  ]
}

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

---

Version 1.2

---

post

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

Body

NodeIdinteger · int32Optional

IdNumstring · nullableOptional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullableOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

VipIdinteger · int32 · nullableOptional

ConfidentialbooleanOptional

TaxNumberstring · nullableOptional

TaxIdentificationNumberstring · nullableOptional

Antworten

201

Created

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

post/openwowi/v1.2/PersonsWrite/Person

POST /openwowi/v1.2/PersonsWrite/Person HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 796

{
  "NodeId": 1,
  "IdNum": "text",
  "IsNaturalPerson": true,
  "ValidFrom": "2026-08-19",
  "ValidTo": "2026-08-19",
  "VipId": 1,
  "Confidential": true,
  "TaxNumber": "text",
  "TaxIdentificationNumber": "text",
  "LegalPerson": {
    "LongName1": "text",
    "LongName2": "text",
    "VatId": "text",
    "CommercialRegisterNumber": "text",
    "CommercialRegisterTown": "text",
    "CompanyFormId": 1,
    "IndustryId": 1
  },
  "NaturalPerson": {
    "FirstName": "text",
    "LastName": "text",
    "BirthName": "text",
    "CareOf": "text",
    "Title": "text",
    "BirthDate": "2026-08-19",
    "DeathDate": "2026-08-19",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  },
  "FirstAddress": {
    "AddressTypeId": 1,
    "Zip": "text",
    "Town": "text",
    "Street": "text",
    "HouseNumber": "text",
    "HouseNumberAddition": "text",
    "CountryId": 1
  },
  "Communications": [
    {
      "CommunicationTypeId": 1,
      "Content": "text",
      "Explanation": "text"
    }
  ]
}

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

---

Personen ändern

Version 1.0

---

put

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Body

NodeIdinteger · int32Optional

IdNumstring · nullableOptional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullableOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

VipIdinteger · int32 · nullableOptional

ConfidentialbooleanOptional

TaxNumberstring · nullableOptional

TaxIdentificationNumberstring · nullableOptional

Antworten

200

OK

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

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

PUT /openwowi/v1.0/PersonsWrite/Person/{personId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 571

{
  "NodeId": 1,
  "IdNum": "text",
  "IsNaturalPerson": true,
  "ValidFrom": "2026-08-19",
  "ValidTo": "2026-08-19",
  "VipId": 1,
  "Confidential": true,
  "TaxNumber": "text",
  "TaxIdentificationNumber": "text",
  "LegalPerson": {
    "LongName1": "text",
    "LongName2": "text",
    "VatId": "text",
    "CommercialRegisterNumber": "text",
    "CommercialRegisterTown": "text",
    "CompanyFormId": 1,
    "IndustryId": 1
  },
  "NaturalPerson": {
    "FirstName": "text",
    "LastName": "text",
    "BirthName": "text",
    "CareOf": "text",
    "Title": "text",
    "BirthDate": "2026-08-19",
    "DeathDate": "2026-08-19",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  }
}

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

---

Version 1.2

---

put

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Body

NodeIdinteger · int32Optional

IdNumstring · nullableOptional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullableOptionalExample: 2026-08-19Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

VipIdinteger · int32 · nullableOptional

ConfidentialbooleanOptional

TaxNumberstring · nullableOptional

TaxIdentificationNumberstring · nullableOptional

Antworten

200

OK

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

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

PUT /openwowi/v1.2/PersonsWrite/Person/{personId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 571

{
  "NodeId": 1,
  "IdNum": "text",
  "IsNaturalPerson": true,
  "ValidFrom": "2026-08-19",
  "ValidTo": "2026-08-19",
  "VipId": 1,
  "Confidential": true,
  "TaxNumber": "text",
  "TaxIdentificationNumber": "text",
  "LegalPerson": {
    "LongName1": "text",
    "LongName2": "text",
    "VatId": "text",
    "CommercialRegisterNumber": "text",
    "CommercialRegisterTown": "text",
    "CompanyFormId": 1,
    "IndustryId": 1
  },
  "NaturalPerson": {
    "FirstName": "text",
    "LastName": "text",
    "BirthName": "text",
    "CareOf": "text",
    "Title": "text",
    "BirthDate": "2026-08-19",
    "DeathDate": "2026-08-19",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  }
}

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

---

Personen löschen

Version 1.0

---

delete

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

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

DELETE /openwowi/v1.0/PersonsWrite/Person/{personId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

---

Version 1.2

---

delete

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

Idinteger · int32Optional

IdNumstring · nullableOptional

400

Bad Request

401

Unauthorized

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

DELETE /openwowi/v1.2/PersonsWrite/Person/{personId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

---

Kontaktpersonen zu Firmen anlegen

Hinweise zur Funktion

"UpdateAddress3" und "UpdateAddressLineTitle" wurden technisch aus WOWIPORT übernommen. Ihre Übersetzung lautet "Übernahme ins Adressfeld" und "Übernahme in Anrede".

Durch Aktivierung von „Übernahme ins Adressfeld“ und „Übernahme in Anrede“ steuern Sie, ob der Name des Ansprechpartners ins Adressfeld bzw. in die Anrede in Geschäftsbriefen übernommen werden soll.

Die Übernahme ins Adressfeld bzw. die Anschrift kann für max. einen Ansprechpartner ausgewählt werden und erfolgt automatisch, wenn in den Modulen Verträge, Fremdverwaltung bzw. Mitgliederverwaltung die Checkbox „Adressdaten aktualisieren“ aktiviert ist.

Wir empfehlen deshalb diese Felder standardmäßig auf "false" zu setzen".

Version 1.2

---

post

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Body

ContactPersonIdinteger · int32Optional

UpdateAddress3booleanOptional

UpdateAddressLineTitlebooleanOptional

Infostring · nullableOptional

Antworten

201

Created

400

Bad Request

401

Unauthorized

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

POST /openwowi/v1.2/PersonsWrite/Person/{personId}/AssignLegalPersonContact HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "ContactPersonId": 1,
  "UpdateAddress3": true,
  "UpdateAddressLineTitle": true,
  "Info": "text"
}

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

---

Kontaktpersonen zu Firmen löschen

Version 1.2

---

delete

Autorisierungen

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

contactPersonIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

400

Bad Request

401

Unauthorized

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

DELETE /openwowi/v1.2/PersonsWrite/Person/{personId}/DeleteLegalPersonContact/{contactPersonId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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