Alle Seiten
Bereitgestellt von GitBook
1 von 1

Loading...

nicht-personenbezogene Mitgliedsdaten

Abruf der Mitgliedschaften.

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



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.



Mitgliedschaft Kontenschreibung

Version 1.2



Bewegungen Mitgliedsanteile

Version 1.2



get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
includeLicenseAgreementbooleanOptionalDefault: false
activeOnstring · date-timeOptional
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.0/CooperativeManagement/CooperativeMemberships
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
cooperativeMembershipIdinteger · int32Optional
cooperativeMembershipIdNumstringOptional
activeOnstring · date-timeOptional
personIdinteger · int32Optional
personIdNumstringOptional
includeLicenseAgreementbooleanOptionalDefault: false
includeShareOverviewbooleanOptionalDefault: false
includeAdditionalFieldbooleanOptionalDefault: false
includeOrganAuthoritybooleanOptionalDefault: false
includePaymentAssignmentbooleanOptionalDefault: false
includeHousingSubsidybooleanOptionalDefault: false
includeRateAgreementsbooleanOptionalDefault: false
showNullValuesbooleanOptionalDefault: false
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
cooperativeMembershipIdinteger · int32Optional
cooperativeMembershipIdNumstringOptional
cooperativeMembershipActiveOnstring · date-timeOptional
balanceAtstring · date-timeOptional
personIdinteger · int32Optional
personIdNumstringOptional
showNullValuesbooleanOptionalDefault: false
get
Autorisierungen
OAuth2passwordErforderlich

Use username and password.

Token URL:
Abfrageparameter
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
cooperativeMembershipIdinteger · int32Optional
cooperativeMembershipIdNumstringOptional
cooperativeMembershipActiveOnstring · date-timeOptional
personIdinteger · int32Optional
personIdNumstringOptional
processTypeIdinteger · int32Optional
includeInactiveSharebooleanOptionalDefault: false
showNullValuesbooleanOptionalDefault: false
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CooperativeManagement/CooperativeMemberships
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CooperativeManagement/CooperativeMembershipBalances
Antworten
200

OK

400

Bad Request

401

Unauthorized

get
/openwowi/v1.2/CooperativeManagement/ProcessMemberships
GET /openwowi/v1.2/CooperativeManagement/CooperativeMemberships HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "IdNum": "text",
    "CreationDate": "2025-12-15",
    "AccessionDate": "2025-12-15",
    "ValidFrom": "2025-12-15",
    "ValidTo": "2025-12-15",
    "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-12-15",
      "DeclarationDateProcess": "2025-12-15",
      "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-12-15",
        "EndOfContract": "2025-12-15",
        "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-12-15",
        "ValidTo": "2025-12-15",
        "ElectedOn": "2025-12-15",
        "OrganAuthority": {
          "Id": 1,
          "Code": "text"
        },
        "ElectoralDistrict": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "PaymentAssignments": [
      {
        "Id": 1,
        "ValidFrom": "2025-12-15",
        "ValidTo": "2025-12-15",
        "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-12-15",
        "DateTo": "2025-12-15",
        "Info": "text",
        "ReasonForRateAgreement": "text",
        "Status": {
          "Id": 1,
          "Code": "text"
        },
        "Items": [
          {
            "Id": 1,
            "Date": "2025-12-15",
            "Amount": 1,
            "Status": {
              "Id": 1,
              "Code": "text"
            }
          }
        ]
      }
    ]
  }
]
GET /openwowi/v1.2/CooperativeManagement/CooperativeMembershipBalances HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "CooperativeMembership": {
      "Id": 1,
      "IdNum": "text",
      "CreationDate": "2025-12-15",
      "AccessionDate": "2025-12-15",
      "ValidFrom": "2025-12-15",
      "ValidTo": "2025-12-15"
    },
    "DayBalance": 1,
    "Balance": 1,
    "BalanceAt": "2025-12-15",
    "MasterAccountAreas": [
      {
        "MasterAccountArea": {
          "Id": 1,
          "Code": "text"
        },
        "DayBalance": 1,
        "Balance": 1
      }
    ]
  }
]
GET /openwowi/v1.2/CooperativeManagement/ProcessMemberships HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "CooperativeMembership": {
      "Id": 1,
      "IdNum": "text"
    },
    "ProcessType": {
      "Id": 1,
      "Code": "text"
    },
    "SharesState": {
      "Id": 1,
      "Code": "text"
    },
    "InvolvedMembership": {
      "Id": 1,
      "IdNum": "text"
    },
    "DeclarationDate": "2025-12-15",
    "AgreementDate": "2025-12-15",
    "ActiveDate": "2025-12-15",
    "CancellationDeclarationDate": "2025-12-15",
    "CancellationAgreementDate": "2025-12-15",
    "LetterDate": "2025-12-15",
    "RegistrationDate": "2025-12-15",
    "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"
        }
      }
    ]
  }
]
GET /openwowi/v1.0/CooperativeManagement/CooperativeMemberships HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "Id": 1,
    "IdNum": "text",
    "CreationDate": "2025-12-15",
    "AccessionDate": "2025-12-15",
    "ValidFrom": "2025-12-15",
    "ValidTo": "2025-12-15",
    "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-12-15",
        "EndOfContract": "2025-12-15",
        "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-12-15"
    },
    "ActiveMaritalMember": {
      "PersonId": 1,
      "BirthDate": "2025-12-15"
    },
    "LastProcessMembership": {
      "ActiveDateProcess": "2025-12-15",
      "DeclarationDateProcess": "2025-12-15",
      "ProcessType": "text",
      "ShareState": "text",
      "SharesIncrease": true,
      "SharesCount": 1,
      "Amount": 1,
      "Remark": "text"
    }
  }
]