Die Personendaten eines Mitglieds

GET /members/data/{memberCode}

Das Studio ruft ihn mit der Mitgliedsnummer, wie die Person sie eingegeben hat, beim Onboarding ohne Prüfcode und bei jeder Berechtigungsprüfung auf, außer ein Filter braucht Claims (dann ruft es „Die Claims eines Mitglieds“ auf), und vergleicht Vorname, Nachname und Geburtsdatum mit den Eingaben. Außerdem ruft es ihn mit der gespeicherten Mitgliedsnummer für die Mitgliedsdaten auf, die ein Frontend liest (mit einer Frist von 1,5 Sekunden), und mit der Test-Mitgliedsnummer im Verbindungstest. Antworten Sie mit 404 für eine Mitgliedsnummer, die das Register nicht führt.

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
`memberCode`	Pfad	Ja	string	Die Mitgliedsnummer, URL-codiert als ein Pfadsegment. Beispiel: `100001`.
`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

Status und Personendaten des Mitglieds. Für die Mitgliedschaftsprüfung sind Vorname, Nachname und Geburtsdatum erforderlich; fehlen sie, behandelt das Studio das Register als nicht erreichbar.

Inhaltstyp: application/json

Feld	Typ	Pflicht	Beschreibung
`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.

Beispiel: Eine aktive Mitarbeiterin

{
  "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"
  }
}

Beispiel: Ein Mitarbeiter im Ruhestand

{
  "source": "SAP HR",
  "status": {
    "statusCode": "inactive"
  },
  "params": {
    "firstName": "Johann",
    "lastName": "Novak",
    "memberCode": "100009",
    "birthDate": "1952-07-07",
    "zip": "7000",
    "city": "Eisenstadt",
    "street": "Beispielgasse 7",
    "country": "AT"
  }
}

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

404

Das Register führt kein Mitglied mit dieser Mitgliedsnummer. Das Studio behandelt die Person als in diesem Register nicht gefunden.

Inhaltstyp: text/plain

Typ: string

Beispiel

Not found

Die Personendaten eines Mitglieds

GET /members/data/{memberCode}

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
`memberCode`	Pfad	Ja	string	Die Mitgliedsnummer, URL-codiert als ein Pfadsegment. Beispiel: `100001`.
`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

Status und Personendaten des Mitglieds. Für die Mitgliedschaftsprüfung sind Vorname, Nachname und Geburtsdatum erforderlich; fehlen sie, behandelt das Studio das Register als nicht erreichbar.

Inhaltstyp: application/json

Feld	Typ	Pflicht	Beschreibung
`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.

Beispiel: Eine aktive Mitarbeiterin

{
  "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"
  }
}

Beispiel: Ein Mitarbeiter im Ruhestand

{
  "source": "SAP HR",
  "status": {
    "statusCode": "inactive"
  },
  "params": {
    "firstName": "Johann",
    "lastName": "Novak",
    "memberCode": "100009",
    "birthDate": "1952-07-07",
    "zip": "7000",
    "city": "Eisenstadt",
    "street": "Beispielgasse 7",
    "country": "AT"
  }
}

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

404

Das Register führt kein Mitglied mit dieser Mitgliedsnummer. Das Studio behandelt die Person als in diesem Register nicht gefunden.

Inhaltstyp: text/plain

Typ: string

Beispiel

Not found