nicht-personenbezogene Mitgliedsdaten

Um auf die Daten der Mitgliederverwaltung (nicht personenbezogen) über die API zugreifen zu können, müssen die Endpunktberechtigungen "Mitgliederverwaltung ohne personenbezogene Details" aktiviert werden.

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

Mitgliedschaften abrufen

Version 1.0

---

GET/openwowi/v1.0/CooperativeManagement/CooperativeMemberships

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CreationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AccessionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

IsPayoutBlockAccountboolean

CooperativeAccountClearingLockboolean

SubsidyApplicationForSeveralFiscalYearsAllowedboolean

NoParticipationElectoralDistrictboolean

ActiveAmountSumnumber (decimal)

ActiveCountSumnumber (decimal)

MembershipStatusnullable all of

LicenseAgreementsnullable array of object

AdditionalFieldsnullable array of object

ElectoralDistrictnullable all of

ReasonPayoutBlockAccountnullable all of

MembershipEndReasonnullable all of

ActiveMainMembernullable all of

ActiveMaritalMembernullable all of

LastProcessMembershipnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/CooperativeManagement/CooperativeMemberships', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "CreationDate": "2025-02-05",
    "AccessionDate": "2025-02-05",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "IsPayoutBlockAccount": true,
    "CooperativeAccountClearingLock": true,
    "SubsidyApplicationForSeveralFiscalYearsAllowed": true,
    "NoParticipationElectoralDistrict": true,
    "ActiveAmountSum": 1,
    "ActiveCountSum": 1,
    "MembershipStatus": {
      "Id": 1,
      "Code": "text"
    },
    "LicenseAgreements": [
      {
        "Id": 1,
        "UseUnit": {
          "Id": 1,
          "UseUnitNumber": "text",
          "BuildingLandId": 1,
          "EconomicUnitId": 1,
          "EconomicUnit": "text"
        },
        "RestrictionsOfUse": {
          "Id": 1,
          "NodeId": 1,
          "Name": "text",
          "IsVacancy": true
        },
        "ContractStatus": {
          "Id": 1,
          "Name": "text"
        },
        "IdNum": "text",
        "StartContract": "2025-02-05",
        "EndOfContract": "2025-02-05",
        "PersonId": 1
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "ElectoralDistrict": {
      "Id": 1,
      "Code": "text"
    },
    "ReasonPayoutBlockAccount": {
      "Id": 1,
      "Code": "text"
    },
    "MembershipEndReason": {
      "Id": 1,
      "Code": "text"
    },
    "ActiveMainMember": {
      "PersonId": 1,
      "BirthDate": "2025-02-05"
    },
    "ActiveMaritalMember": {
      "PersonId": 1,
      "BirthDate": "2025-02-05"
    },
    "LastProcessMembership": {
      "ActiveDateProcess": "2025-02-05",
      "DeclarationDateProcess": "2025-02-05",
      "ProcessType": "text",
      "ShareState": "text",
      "SharesIncrease": true,
      "SharesCount": 1,
      "Amount": 1,
      "Remark": "text"
    }
  }
]

---

Version 1.2

Hinweise zur Funktion

Die Objekte "Address" und "TaxAdress" liefern nur Daten, wenn Sie auch die Rechte für "Mitgliederverwaltung mit personenbezogenen Details" aktivieren. Ansonsten werden die Daten nach den ersten drei Zeichen obfuskiert und können nur als Indiz für die Existenz von Daten genutzt werden.

---

GET/openwowi/v1.2/CooperativeManagement/CooperativeMemberships

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CreationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AccessionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

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

IsPayoutBlockAccountboolean

CooperativeAccountClearingLockboolean

SubsidyApplicationForSeveralFiscalYearsAllowedboolean

NoParticipationElectoralDistrictboolean

ActiveAmountSumnumber (decimal)

ActiveCountSumnumber (decimal)

MembershipStatusnullable all of

Addressnullable all of

TaxAddressnullable all of

ElectoralDistrictnullable all of

ReasonPayoutBlockAccountnullable all of

MembershipEndReasonnullable all of

ActiveMainMembernullable all of

Descriptionnullable string

ActiveMaritalMembernullable all of

LastProcessMembershipnullable all of

ResponsibleOfficialnullable all of

LicenseAgreementsnullable array of object

AdditionalFieldsnullable array of object

ShareTypeOverviewnullable array of object

OrganAuthoritiesnullable array of object

PaymentAssignmentsnullable array of object

HousingSubsidiesnullable array of object

RateAgreementsnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CooperativeManagement/CooperativeMemberships', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "CreationDate": "2025-02-05",
    "AccessionDate": "2025-02-05",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "IsPayoutBlockAccount": true,
    "CooperativeAccountClearingLock": true,
    "SubsidyApplicationForSeveralFiscalYearsAllowed": true,
    "NoParticipationElectoralDistrict": true,
    "ActiveAmountSum": 1,
    "ActiveCountSum": 1,
    "MembershipStatus": {
      "Id": 1,
      "Code": "text"
    },
    "Address": {
      "Greeting": "text",
      "Address1": "text",
      "Address2": "text",
      "Address3": "text",
      "Address4": "text",
      "Address5": "text",
      "Address6": "text"
    },
    "TaxAddress": {
      "Greeting": "text",
      "Address1": "text",
      "Address2": "text",
      "Address3": "text",
      "Address4": "text",
      "Address5": "text",
      "Address6": "text"
    },
    "ElectoralDistrict": {
      "Id": 1,
      "Code": "text"
    },
    "ReasonPayoutBlockAccount": {
      "Id": 1,
      "Code": "text"
    },
    "MembershipEndReason": {
      "Id": 1,
      "Code": "text"
    },
    "ActiveMainMember": {
      "PersonId": 1,
      "IdNum": "text"
    },
    "Description": "text",
    "ActiveMaritalMember": {
      "PersonId": 1,
      "IdNum": "text"
    },
    "LastProcessMembership": {
      "ActiveDateProcess": "2025-02-05",
      "DeclarationDateProcess": "2025-02-05",
      "ProcessType": "text",
      "ShareState": "text",
      "SharesIncrease": true,
      "SharesCount": 1,
      "Amount": 1,
      "Remark": "text"
    },
    "ResponsibleOfficial": {
      "Id": 1,
      "CodeShort": "text",
      "PersonId": 1
    },
    "LicenseAgreements": [
      {
        "Id": 1,
        "UseUnit": {
          "Id": 1,
          "UseUnitNumber": "text",
          "BuildingLandId": 1,
          "EconomicUnitId": 1,
          "EconomicUnit": "text"
        },
        "RestrictionsOfUse": {
          "Id": 1,
          "NodeId": 1,
          "Name": "text",
          "IsVacancy": true
        },
        "ContractStatus": {
          "Id": 1,
          "Name": "text"
        },
        "IdNum": "text",
        "StartContract": "2025-02-05",
        "EndOfContract": "2025-02-05",
        "PersonId": 1
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "ShareTypeOverview": [
      {
        "ShareType": {
          "Id": 1,
          "Code": "text"
        },
        "SharesDeclaredQuantity": 1,
        "SharesDeclaredAmount": 1,
        "SharesApprovedQuantity": 1,
        "SharesApprovedAmount": 1,
        "SharesActiveQuantity": 1,
        "SharesActiveAmount": 1
      }
    ],
    "OrganAuthorities": [
      {
        "Id": 1,
        "ValidFrom": "2025-02-05",
        "ValidTo": "2025-02-05",
        "ElectedOn": "2025-02-05",
        "OrganAuthority": {
          "Id": 1,
          "Code": "text"
        },
        "ElectoralDistrict": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "PaymentAssignments": [
      {
        "Id": 1,
        "ValidFrom": "2025-02-05",
        "ValidTo": "2025-02-05",
        "Amount": 1,
        "UsageText": "text",
        "RecipientPerson": {
          "Id": 1,
          "IdNum": "text"
        },
        "AssignmentOfObjectDto": {
          "Id": 1,
          "Code": "text"
        },
        "AssignmentReason": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccount": {
          "Id": 1,
          "Iban": "text",
          "Bic": "text"
        }
      }
    ],
    "HousingSubsidies": [
      {
        "Id": 1,
        "CooperativeFiscalYear": {
          "Id": 1,
          "Code": "text"
        },
        "TaxAuthority": {
          "Id": 1,
          "Code": "text"
        },
        "ApplicationAsCouple": true,
        "HousingSubsidyApplicationSentToMember": true,
        "HousingSubsidyApplicationComplete": true,
        "ManuallyHousingSubsidyRelevantCapital": 1
      }
    ],
    "RateAgreements": [
      {
        "Id": 1,
        "Amount": 1,
        "DateFrom": "2025-02-05",
        "DateTo": "2025-02-05",
        "Info": "text",
        "ReasonForRateAgreement": "text",
        "Status": {
          "Id": 1,
          "Code": "text"
        },
        "Items": [
          {
            "Id": 1,
            "Date": "2025-02-05",
            "Amount": 1,
            "Status": {
              "Id": 1,
              "Code": "text"
            }
          }
        ]
      }
    ]
  }
]

---

Mitgliedschaft Kontenschreibung

Version 1.2

---

GET/openwowi/v1.2/CooperativeManagement/CooperativeMembershipBalances

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

CooperativeMembershipnullable all of

DayBalancenumber (decimal)

Balancenumber (decimal)

BalanceAtstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

MasterAccountAreasnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CooperativeManagement/CooperativeMembershipBalances', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "CooperativeMembership": {
      "Id": 1,
      "IdNum": "text",
      "CreationDate": "2025-02-05",
      "AccessionDate": "2025-02-05",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05"
    },
    "DayBalance": 1,
    "Balance": 1,
    "BalanceAt": "2025-02-05",
    "MasterAccountAreas": [
      {
        "MasterAccountArea": {
          "Id": 1,
          "Code": "text"
        },
        "DayBalance": 1,
        "Balance": 1
      }
    ]
  }
]

---

Bewegungen Mitgliedsanteile

Version 1.2

---

GET/openwowi/v1.2/CooperativeManagement/ProcessMemberships

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

CooperativeMembershipnullable all of

ProcessTypenullable all of

SharesStatenullable all of

InvolvedMembershipnullable all of

DeclarationDatestring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AgreementDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ActiveDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CancellationDeclarationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CancellationAgreementDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

LetterDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

RegistrationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Remarknullable string

InformationInvolvedMembernullable string

Sharesnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CooperativeManagement/ProcessMemberships', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "CooperativeMembership": {
      "Id": 1,
      "IdNum": "text"
    },
    "ProcessType": {
      "Id": 1,
      "Code": "text"
    },
    "SharesState": {
      "Id": 1,
      "Code": "text"
    },
    "InvolvedMembership": {
      "Id": 1,
      "IdNum": "text"
    },
    "DeclarationDate": "2025-02-05",
    "AgreementDate": "2025-02-05",
    "ActiveDate": "2025-02-05",
    "CancellationDeclarationDate": "2025-02-05",
    "CancellationAgreementDate": "2025-02-05",
    "LetterDate": "2025-02-05",
    "RegistrationDate": "2025-02-05",
    "Remark": "text",
    "InformationInvolvedMember": "text",
    "Shares": [
      {
        "Id": 1,
        "ProcessMembershipReversalOfId": 1,
        "SharesCount": 1,
        "Amount": 1,
        "TotalAmount": 1,
        "SharesType": {
          "Id": 1,
          "Code": "text"
        },
        "SharesCategory": {
          "Id": 1,
          "Code": "text"
        }
      }
    ]
  }
]

---