Der Status eines Mitglieds
GET /members/status/{memberCode}
Das Studio ruft ihn bei jeder Anmeldeprüfung eines Mitglieds auf, dessen Mitgliedschaft mit diesem Register verknüpft ist, mit der gespeicherten Mitgliedsnummer, außer die Mitgliedschaftsdefinition oder eine Community filtert nach einem Claim (dann ruft es stattdessen „Die Claims eines Mitglieds“ auf). Antworten Sie mit 404 für eine Mitgliedsnummer, die das Register nicht führt.
Authentifizierung
- appsolut_m2m (im Header
x-api-keygesendet): 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
Der Status des Mitglieds.
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. |
Beispiel: Eine aktive Mitarbeiterin
{
"source": "SAP HR",
"status": {
"statusCode": "active"
}
}
Beispiel: Ein Mitarbeiter im Ruhestand
{
"source": "SAP HR",
"status": {
"statusCode": "inactive"
}
}
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