Personendaten lesen

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "PersonsRead" und "PersonsReadCatalog".

Um lesend auf die Daten der Personen über die API zugreifen zu können, muss die Endpunktberechtigung "Personen lesen" aktiviert werden.

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

Personen abrufen

Version 1.0

get
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
personIdinteger · int32Optional
includeCommunicationbooleanOptionalDefault: false
includeAddressbooleanOptionalDefault: false
includeBankaccountbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.0/PersonsRead/Persons HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "IsNaturalPerson": true,
    "ValidFrom": "2025-06-27",
    "ValidTo": "2025-06-27",
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text",
      "ContractPersons": [
        {
          "Id": 1,
          "IdNum": "text",
          "FirstName": "text",
          "LastName": "text"
        }
      ]
    },
    "NaturalPerson": {
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "Title": "text",
      "BirthDate": "2025-06-27T09:23:54.044Z",
      "DeathDate": "2025-06-27T09:23:54.044Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    },
    "Addresses": [
      {
        "AddressTypeId": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "CountryId": 1,
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "Id": 1,
        "AddressType": "text",
        "CountryCode": "text",
        "StreetComplete": "text",
        "HouseNumberComplete": "text",
        "MainAddress": true
      }
    ],
    "Communications": [
      {
        "CommunicationTypeId": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "Id": 1,
        "CommunicationType": "text",
        "RelatedAddress": "text"
      }
    ],
    "PersonBankAccounts": [
      {
        "Id": 1,
        "BankAccountId": 1,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountUsageType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ]
  }
]

Version 1.2

get
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
personIdinteger · int32Optional
includeCommunicationbooleanOptionalDefault: false
includeAddressbooleanOptionalDefault: false
includeBankaccountbooleanOptionalDefault: false
includeAdditionalFieldbooleanOptionalDefault: false
includeContactRelationbooleanOptionalDefault: false
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/PersonsRead/Persons HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "IsNaturalPerson": true,
    "ValidFrom": "2025-06-27",
    "ValidTo": "2025-06-27",
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text",
      "ContractPersons": [
        {
          "Id": 1,
          "IdNum": "text",
          "FirstName": "text",
          "LastName": "text"
        }
      ]
    },
    "NaturalPerson": {
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "Title": "text",
      "BirthDate": "2025-06-27T09:23:54.044Z",
      "DeathDate": "2025-06-27T09:23:54.044Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    },
    "Addresses": [
      {
        "AddressTypeId": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "CountryId": 1,
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "Id": 1,
        "AddressType": "text",
        "CountryCode": "text",
        "StreetComplete": "text",
        "HouseNumberComplete": "text",
        "MainAddress": true
      }
    ],
    "Communications": [
      {
        "CommunicationTypeId": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "Id": 1,
        "CommunicationType": "text",
        "RelatedAddress": "text"
      }
    ],
    "PersonBankAccounts": [
      {
        "Id": 1,
        "BankAccountId": 1,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountUsageType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ]
  }
]

Personen "Zuordnungen" abrufen

Version 1.2

get
Authorizations
Path parameters
personIdinteger · int32Required
Query parameters
apiKeystringOptional
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/PersonsRead/Person/{personId}/Assignments HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "EntityCode": "text",
    "EntityName": "text",
    "EntityId": 1,
    "TextInfos": [
      "text"
    ],
    "Relations": [
      {
        "EntityId": 1,
        "EntityCode": "text",
        "DisplayText": "text"
      }
    ]
  }
]

Banken

Version 1.2

get
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
bankIdinteger · int32Optional
bicstringOptional
includeObsoletebooleanOptionalDefault: false
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/PersonsRead/Banks HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Code": "text",
    "Bic": "text",
    "Checksum": "text",
    "OwnCode": "text",
    "Town": "text",
    "Zip": "text",
    "IsObsolete": true,
    "Country": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    }
  }
]

Enumeratoren 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

PreviousKatalogeNextKataloge

Last updated