> For the complete documentation index, see [llms.txt](https://docs.openwowi.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openwowi.de/schnittstelle-v1.x/personendaten.md). # Personendaten lesen {% hint style="warning" %} Um lesend auf die Daten der Personen über die API zugreifen zu können, muss die Endpunktberechtigung "Personen lesen" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Personen abrufen
HInweise zur Funktion Bitte beachten Sie, dass die Node "LegalPerson" derzeit die fehlerhaft bezeichete Node "ContractPerson" enthält. Diese müsste eigentlich "ContactPerson" lauten. Um die Datenstruktur in Produktivsystemen nicht zu stören, wird eine Behebung allerdings erst in der Version 1.3 erfolgen.
#### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/PersonsRead/Persons" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/PersonsRead/Persons" method="get" %} {% endopenapi %} *** ## Personen "Zuordnungen" abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/PersonsRead/Person/{personId}/Assignments" method="get" %} {% endopenapi %} *** ## Banken #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/PersonsRead/Banks" method="get" %} {% endopenapi %} *** ## SEPA Mandate #### Version 1.2 *** ## GET /openwowi/v1.2/PersonsRead/SepaMandate > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaMandateDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"MandateId":{"type":"string","nullable":true},"OriginalCreditorName":{"type":"string","nullable":true},"BankAccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountSlimDto"},"SepaMandateType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FIOSepaMandateTypeDto"},"FormerlyDirectDebit":{"type":"boolean"},"ValidFrom":{"type":"string","format":"date-time"},"ValidTo":{"type":"string","format":"date-time","nullable":true},"MultiplePaymentModes":{"type":"boolean"},"IsActive":{"type":"boolean"},"DateOfSignature":{"type":"string","format":"date-time","nullable":true},"PlaceOfSignature":{"type":"string","nullable":true},"Address":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"SepaCreditorIdentifierId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FIOSepaMandateTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/PersonsRead/SepaMandate":{"get":{"tags":["OpenWowi PersonsRead"],"operationId":"PersonsRead_GetSepaMandates","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"bankAccountId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"licenseAgreementId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"ValidFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"ValidTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaMandateDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaMandateDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaMandateDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## SEPA Gläubiger #### Version 1.2 *** ## GET /openwowi/v1.2/PersonsRead/SepaCreditorIdentifier > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaCreditorIdentifierDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/PersonsRead/SepaCreditorIdentifier":{"get":{"tags":["OpenWowi PersonsRead"],"operationId":"PersonsRead_GetSepaCreditorIdentifiers","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"idNum","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaCreditorIdentifierDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaCreditorIdentifierDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.SepaCreditorIdentifierDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## 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 | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.openwowi.de/schnittstelle-v1.x/personendaten.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.