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

Authorizations

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger · int32Optional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

VipIdinteger · int32 | nullableOptional

ConfidentialbooleanOptional

TaxNumberstring | nullableOptional

TaxIdentificationNumberstring | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

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

{
  "NodeId": 1,
  "IsNaturalPerson": true,
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "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": "2025-06-27",
    "DeathDate": "2025-06-27",
    "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"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

---

Version 1.2

---

post

Authorizations

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger · int32Optional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

VipIdinteger · int32 | nullableOptional

ConfidentialbooleanOptional

TaxNumberstring | nullableOptional

TaxIdentificationNumberstring | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

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

{
  "NodeId": 1,
  "IsNaturalPerson": true,
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "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": "2025-06-27",
    "DeathDate": "2025-06-27",
    "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"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

---

Personen ändern

Version 1.0

---

put

Authorizations

Path parameters

personIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger · int32Optional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

VipIdinteger · int32 | nullableOptional

ConfidentialbooleanOptional

TaxNumberstring | nullableOptional

TaxIdentificationNumberstring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

HTTPcURLJavaScriptPython

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

{
  "NodeId": 1,
  "IsNaturalPerson": true,
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "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": "2025-06-27",
    "DeathDate": "2025-06-27",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  }
}

application/jsontext/jsonapplication/*+json

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

---

Version 1.2

---

put

Authorizations

Path parameters

personIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

NodeIdinteger · int32Optional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

VipIdinteger · int32 | nullableOptional

ConfidentialbooleanOptional

TaxNumberstring | nullableOptional

TaxIdentificationNumberstring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

HTTPcURLJavaScriptPython

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

{
  "NodeId": 1,
  "IsNaturalPerson": true,
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "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": "2025-06-27",
    "DeathDate": "2025-06-27",
    "GenderId": 1,
    "MaritalTypeId": 1,
    "NationalityId": 1,
    "PersonInCareId": 1
  }
}

application/jsontext/jsonapplication/*+json

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

---

Personen löschen

Version 1.0

---

delete

Authorizations

Path parameters

personIdinteger · int32Required

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

HTTPcURLJavaScriptPython

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

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

---

Version 1.2

---

delete

Authorizations

Path parameters

personIdinteger · int32Required

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

HTTPcURLJavaScriptPython

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

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

---

Kontaktpersonen zu Firmen anlegen

Version 1.2

---

post

Authorizations

Path parameters

personIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

ContactPersonIdinteger · int32Optional

UpdateAddress3booleanOptional

UpdateAddressLineTitlebooleanOptional

Infostring | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

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

---

Kontaktpersonen zu Firmen löschen

Version 1.2

---

delete

Authorizations

Path parameters

personIdinteger · int32Required

contactPersonIdinteger · int32Required

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.2/PersonsWrite/Person/{personId}/DeleteLegalPersonContact/{contactPersonId} HTTP/1.1
Host: 
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