Die Claims mehrerer Mitglieder

GET /members/claims

Status, Personendaten und Claims jeder Mitgliedsnummer in keys. Das Studio ruft diese Operation derzeit nicht auf.

Authentifizierung

appsolut_m2m (im Header x-api-key gesendet): Der „API-Schlüssel“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf gesendet. Das Studio speichert ihn verschlüsselt und zeigt ihn nie wieder an. Antworten Sie auf einen falschen Schlüssel mit 401 oder 403.

Parameter

Name	Ort	Pflicht	Typ	Beschreibung
`keys`	Query-Parameter	Ja	string[]	Die nachzuschlagenden Mitgliedsnummern, der Parameter für jede wiederholt: `?keys=100001&keys=100002`. Beispiel: `["100001","100002"]`.
`x-tenant-id`	Header	Ja	string	Die „Mandanten-ID“, die in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit die Organisationen unterscheiden, die es bedient. Beispiel: `pannoniqa`.
`x-custom-scope`	Header	Ja	string	Der „Scope“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit den Datenbestand wählen, aus dem es antwortet. Beispiel: `employees`.

Antworten

200

Ein Element pro gefundener Mitgliedsnummer. Ein Mitglied, zu dem das Register keine Daten führt, kann leere params und claims haben.

Inhaltstyp: application/json

Feld	Typ	Pflicht	Beschreibung
`[].memberCode`	string	Ja	Die Mitgliedsnummer, die Kennung der Person in der Organisation.
`[].source`	string	Ja	Der Name Ihrer Datenquelle, etwa „SAP HR“.
`[].status`	object	Ja
`[].status.statusCode`	string	Ja	Der Status des Mitglieds im Register. Filter in der Mitgliedschaftsdefinition und in Communities können ihn prüfen. Erlaubte Werte: `active`, `inactive`, `pending`.
`[].params`	object	Ja	Die Personendaten, die das Register führt. Im Vertrag ist jedes Feld optional, aber wo das Studio Angaben vergleicht, braucht es Vorname, Nachname und Geburtsdatum. Die Anschrift sind Mitgliedsdaten, die ein Frontend seinem angemeldeten Mitglied anzeigen darf.
`[].params.firstName`	string	Nein	Vorname.
`[].params.lastName`	string	Nein	Nachname.
`[].params.memberCode`	string	Nein	Die Mitgliedsnummer, wie das Register sie führt.
`[].params.birthDate`	string (date)	Nein	Geburtsdatum, JJJJ-MM-TT.
`[].params.zip`	string	Nein	Postleitzahl.
`[].params.city`	string	Nein	Ort.
`[].params.street`	string	Nein	Straße und Hausnummer.
`[].params.country`	string	Nein	Ländercode, etwa AT.
`[].claims`	object	Ja	Angaben über das Mitglied, nach denen die Mitgliedschaftsdefinition und Communities filtern können. Alle sind optional, und jede darf null sein, etwa für einen Claim, den das Register nicht kennt; was null bedeutet, legt der Claim fest (bei `leavingDate`: noch beschäftigt). Ein Register darf über diese hinaus eigene Claims senden.
`[].claims.entitled`	boolean oder null	Nein	Ob das Mitglied Anspruch auf Community-Vorteile hat.
`[].claims.discountLevel`	integer oder null	Nein	Rabattstufe in Prozent. Mindestens 0. Höchstens 100.
`[].claims.companyName`	string oder null	Nein	Das Unternehmen, für das das Mitglied arbeitet.
`[].claims.employeeGroup`	string oder null	Nein	Die Mitarbeitergruppe des Mitglieds.
`[].claims.employmentLevel`	integer oder null	Nein	Beschäftigungsausmaß in Prozent einer Vollzeitstelle. Mindestens 0. Höchstens 100.
`[].claims.leavingDate`	string (date) oder null	Nein	Das Austrittsdatum, JJJJ-MM-TT; ein Zeitstempel wird ebenfalls akzeptiert. Null während der Beschäftigung.
`[].claims.isAnnualSalaryAbove50k`	boolean oder null	Nein	Ob das Jahresgehalt über 50.000 liegt.
`[].claims.numberOfKids`	integer oder null	Nein	Anzahl der Kinder. Mindestens 0.
`[].claims.childAllowance`	boolean oder null	Nein	Ob das Mitglied Kinderbeihilfe bezieht.
`[].claims.soleEarner`	boolean oder null	Nein	Ob das Mitglied Alleinverdiener ist.
`[].claims.mealVoucher`	number oder null	Nein	Betrag des Essensgutscheins. Mindestens 0.

Beispiel

[
  {
    "memberCode": "100001",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Anna",
      "lastName": "Berger",
      "memberCode": "100001",
      "birthDate": "1979-02-02",
      "zip": "7100",
      "city": "Neusiedl am See",
      "street": "Musterweg 3",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 2,
      "employeeGroup": "Production",
      "isAnnualSalaryAbove50k": false,
      "discountLevel": 10,
      "employmentLevel": 100,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100002",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Markus",
      "lastName": "Horvath",
      "memberCode": "100002",
      "birthDate": "1985-11-23",
      "zip": "7000",
      "city": "Eisenstadt",
      "street": "Beispielgasse 12",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 0,
      "employeeGroup": "Administration",
      "isAnnualSalaryAbove50k": true,
      "discountLevel": 10,
      "employmentLevel": 80,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100004",
    "source": "SAP HR",
    "status": {
      "statusCode": "inactive"
    },
    "params": {},
    "claims": {}
  }
]

400

Das Register konnte die Anfrage nicht verarbeiten. Das Studio behandelt das Register dann als nicht erreichbar und liest den Inhalt nicht.

Inhaltstyp: text/plain

Typ: string

Beispiel

Bad request

401

Der API-Schlüssel ist falsch. Das Studio meldet die Zugangsdaten als abgelehnt (ebenso bei 403) und behandelt das Register als nicht erreichbar.

Inhaltstyp: text/plain

Typ: string

Beispiel

Unauthorized

Die Claims mehrerer Mitglieder

GET /members/claims

Status, Personendaten und Claims jeder Mitgliedsnummer in keys. Das Studio ruft diese Operation derzeit nicht auf.

Authentifizierung

appsolut_m2m (im Header x-api-key gesendet): Der „API-Schlüssel“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf gesendet. Das Studio speichert ihn verschlüsselt und zeigt ihn nie wieder an. Antworten Sie auf einen falschen Schlüssel mit 401 oder 403.

Parameter

Name	Ort	Pflicht	Typ	Beschreibung
`keys`	Query-Parameter	Ja	string[]	Die nachzuschlagenden Mitgliedsnummern, der Parameter für jede wiederholt: `?keys=100001&keys=100002`. Beispiel: `["100001","100002"]`.
`x-tenant-id`	Header	Ja	string	Die „Mandanten-ID“, die in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit die Organisationen unterscheiden, die es bedient. Beispiel: `pannoniqa`.
`x-custom-scope`	Header	Ja	string	Der „Scope“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit den Datenbestand wählen, aus dem es antwortet. Beispiel: `employees`.

Antworten

200

Ein Element pro gefundener Mitgliedsnummer. Ein Mitglied, zu dem das Register keine Daten führt, kann leere params und claims haben.

Inhaltstyp: application/json

Feld	Typ	Pflicht	Beschreibung
`[].memberCode`	string	Ja	Die Mitgliedsnummer, die Kennung der Person in der Organisation.
`[].source`	string	Ja	Der Name Ihrer Datenquelle, etwa „SAP HR“.
`[].status`	object	Ja
`[].status.statusCode`	string	Ja	Der Status des Mitglieds im Register. Filter in der Mitgliedschaftsdefinition und in Communities können ihn prüfen. Erlaubte Werte: `active`, `inactive`, `pending`.
`[].params`	object	Ja	Die Personendaten, die das Register führt. Im Vertrag ist jedes Feld optional, aber wo das Studio Angaben vergleicht, braucht es Vorname, Nachname und Geburtsdatum. Die Anschrift sind Mitgliedsdaten, die ein Frontend seinem angemeldeten Mitglied anzeigen darf.
`[].params.firstName`	string	Nein	Vorname.
`[].params.lastName`	string	Nein	Nachname.
`[].params.memberCode`	string	Nein	Die Mitgliedsnummer, wie das Register sie führt.
`[].params.birthDate`	string (date)	Nein	Geburtsdatum, JJJJ-MM-TT.
`[].params.zip`	string	Nein	Postleitzahl.
`[].params.city`	string	Nein	Ort.
`[].params.street`	string	Nein	Straße und Hausnummer.
`[].params.country`	string	Nein	Ländercode, etwa AT.
`[].claims`	object	Ja	Angaben über das Mitglied, nach denen die Mitgliedschaftsdefinition und Communities filtern können. Alle sind optional, und jede darf null sein, etwa für einen Claim, den das Register nicht kennt; was null bedeutet, legt der Claim fest (bei `leavingDate`: noch beschäftigt). Ein Register darf über diese hinaus eigene Claims senden.
`[].claims.entitled`	boolean oder null	Nein	Ob das Mitglied Anspruch auf Community-Vorteile hat.
`[].claims.discountLevel`	integer oder null	Nein	Rabattstufe in Prozent. Mindestens 0. Höchstens 100.
`[].claims.companyName`	string oder null	Nein	Das Unternehmen, für das das Mitglied arbeitet.
`[].claims.employeeGroup`	string oder null	Nein	Die Mitarbeitergruppe des Mitglieds.
`[].claims.employmentLevel`	integer oder null	Nein	Beschäftigungsausmaß in Prozent einer Vollzeitstelle. Mindestens 0. Höchstens 100.
`[].claims.leavingDate`	string (date) oder null	Nein	Das Austrittsdatum, JJJJ-MM-TT; ein Zeitstempel wird ebenfalls akzeptiert. Null während der Beschäftigung.
`[].claims.isAnnualSalaryAbove50k`	boolean oder null	Nein	Ob das Jahresgehalt über 50.000 liegt.
`[].claims.numberOfKids`	integer oder null	Nein	Anzahl der Kinder. Mindestens 0.
`[].claims.childAllowance`	boolean oder null	Nein	Ob das Mitglied Kinderbeihilfe bezieht.
`[].claims.soleEarner`	boolean oder null	Nein	Ob das Mitglied Alleinverdiener ist.
`[].claims.mealVoucher`	number oder null	Nein	Betrag des Essensgutscheins. Mindestens 0.

Beispiel

[
  {
    "memberCode": "100001",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Anna",
      "lastName": "Berger",
      "memberCode": "100001",
      "birthDate": "1979-02-02",
      "zip": "7100",
      "city": "Neusiedl am See",
      "street": "Musterweg 3",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 2,
      "employeeGroup": "Production",
      "isAnnualSalaryAbove50k": false,
      "discountLevel": 10,
      "employmentLevel": 100,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100002",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Markus",
      "lastName": "Horvath",
      "memberCode": "100002",
      "birthDate": "1985-11-23",
      "zip": "7000",
      "city": "Eisenstadt",
      "street": "Beispielgasse 12",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 0,
      "employeeGroup": "Administration",
      "isAnnualSalaryAbove50k": true,
      "discountLevel": 10,
      "employmentLevel": 80,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100004",
    "source": "SAP HR",
    "status": {
      "statusCode": "inactive"
    },
    "params": {},
    "claims": {}
  }
]

400

Das Register konnte die Anfrage nicht verarbeiten. Das Studio behandelt das Register dann als nicht erreichbar und liest den Inhalt nicht.

Inhaltstyp: text/plain

Typ: string

Beispiel

Bad request

401

Der API-Schlüssel ist falsch. Das Studio meldet die Zugangsdaten als abgelehnt (ebenso bei 403) und behandelt das Register als nicht erreichbar.

Inhaltstyp: text/plain

Typ: string

Beispiel

Unauthorized