Benutzer
5 endpoints
Die Benutzer des Mandanten und ihre Zuständigkeiten.
Gebraucht überall dort, wo ein Datensatz einer verantwortlichen Person zugeordnet werden soll — etwa beim Anlegen einer Firma oder eines Bewerbers über das Feld responsibility.
Alle Benutzer
GET /users
Listet die Benutzer des Mandanten. Über die optionalen Query-Parameter startDate und endDate (Format YYYY-MM-DD) lässt sich die Ergebnismenge auf einen Zeitraum eingrenzen; ohne Angabe wird der vollständige Bestand geliefert. Für neue Integrationen ist GET /users/all als neuere Variante vorgesehen.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
startDate |
query | string | no | Beginn des Zeitraums im Format YYYY-MM-DD |
endDate |
query | string | no | Ende des Zeitraums im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
isFaulty |
boolean | no | Gibt an, ob die Verarbeitung fehlerhaft war |
data |
ReadAllUsersResponse[] | no | Nutzdaten der Antwort |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
serviceAlerts |
ServiceAlertDto[] | no | Liste der Service-Hinweise |
statusCode |
integer (int32) | no | HTTP-Statuscode der Antwort |
messageGuid |
string (uuid) | null | no |
Alle verantwortliche Benutzer
GET /users/responsibilities
Liefert die Benutzer samt ihrer Zuständigkeiten. Die hier gelieferten Benutzer sind die zulässigen Werte für die responsibility-Angaben an Bewerbern, Firmen, Betriebsstätten und Ansprechpartnern. Der Endpunkt benötigt keine Parameter.
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
users |
UserResponsibilityDto[] | no | Liste der Benutzer und ihrer Zuständigkeiten |
Alle Benutzer (Neue Version)
GET /users/all
Listet die Benutzer des Mandanten — die neuere Variante von GET /users. Die Antwort ist flacher aufgebaut: die Benutzer stehen direkt unter users, statt in den generischen Antwortumschlag mit isFaulty, statusCode und serviceAlerts eingebettet zu sein. Über die optionalen Query-Parameter startDate und endDate (Format YYYY-MM-DD) lässt sich die Ergebnismenge auf einen Zeitraum eingrenzen.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endDate |
query | string | no | Ende des Zeitraums im Format YYYY-MM-DD |
startDate |
query | string | no | Beginn des Zeitraums im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
users |
ReadAllUsers2Dto[] | no | Liste der Benutzer |
Benutzer abrufen
GET /users/{userId}
Dieser Endpunkt gibt einen einzelnen Benutzer anhand der numerischen userId zurück.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userId |
path | integer | yes | Numerische Identifikation des Benutzers |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Eindeutige Identifikation des Benutzers |
rowGuid |
string (uuid) | no | Eindeutige Kennung des Datensatzes (GUID) |
firstName |
string | null | no |
lastName |
string | null | no |
userFullName |
string | null | no |
userZvooveId |
string | null | no |
userSince |
string | null | no |
licences |
ReadUserByIdLicenceDto[] | no | Liste der zugeordneten Lizenzen |
assignedOffices |
ReadUserByIdAssignedOfficeDto[] | no | Liste der zugeordneten Niederlassungen |
404 — Benutzer nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Benutzerdetails lesen (Guid)
GET /users/{userGuid}
Liest die Detaildaten eines Benutzers anhand seiner GUID (rowGuid), einschließlich der zugeordneten Lizenzen und Niederlassungen. Für den Zugriff über die numerische Id steht GET /users/{userId} zur Verfügung.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userGuid |
path | string | yes | GUID des Benutzers |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Eindeutige Identifikation des Benutzers |
rowGuid |
string (uuid) | no | Eindeutige Kennung des Datensatzes (GUID) |
firstName |
string | null | no |
lastName |
string | null | no |
userFullName |
string | null | no |
userZvooveId |
string | null | no |
userSince |
string | null | no |
licences |
ReadUserByIdLicenceDto[] | no | Liste der zugeordneten Lizenzen |
assignedOffices |
ReadUserByIdAssignedOfficeDto[] | no | Liste der zugeordneten Niederlassungen |
404 — Benutzer nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |