Bewerberübersichten
6 endpoints
Listen und Änderungsströme über den gesamten Bewerberbestand. Hier beginnt jede Anbindung: einmalig der Vollabzug über die Export-Endpunkte, danach ausschließlich Deltas über die Änderungsendpunkte. Enthält außerdem die Dublettenprüfung per E-Mail-Adresse.
Die Änderungsantwort ist bereits nach new, modified und deleted getrennt. Die deleted-Liste ist der einzige Weg, von gelöschten Bewerbern zu erfahren — es gibt keinen Löschendpunkt für Bewerber.
Beachten Sie: Diese Endpunkte kennen kein Paging. Grenzen Sie große Abfragen über Zeiträume ein.
Alle Bewerber auflisten
GET /candidates
Dieser Endpunkt gibt eine Liste von Bewerbern zurück.
Über die optionalen Query-Parameter startDate und endDate (Format: YYYY-MM-DD) kann die Ausgabe auf einen Zeitraum eingegrenzt werden. Ohne Angabe werden alle Bewerber zurückgegeben.
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 |
ReadAllCandidatesResponse[] | 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 aktiven Bewerber
GET /candidates/export/candidates
Dieser Endpunkt gibt alle aktiven Bewerber zurück.
Ohne officeId werden alle Bewerber über alle Niederlassungen zurück gegeben.
Mit officeId werden nur die Bewerber der jeweiligen Niederlassung zurück gegeben.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
officeId |
query | integer | no | Identifikation der Niederlassung |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
new |
CandidateChangesDetailsDto[] | no | Neue Bewerber |
modified |
CandidateChangesDetailsDto[] | no | Bearbeitete Bewerber |
deleted |
CandidateChangesDetailsDto[] | no | Gelöschte Bewerber |
Bewerberänderungen nach Zeitraum und Niederlassung
GET /candidates/export/candidates/changes
Dieser Endpunkt gibt die Änderungen der Bewerber in einem Zeitraum von Tagen zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Bewerber (new)
geänderte Bewerber (modified)
gelöschte Bewerber (deleted)
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 |
officeId |
query | integer | no | Identifikation der Niederlassung |
processStatusId |
query | CandidateProcessStatus | no |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
new |
CandidateChangesDetailsDto[] | no | Neue Bewerber |
modified |
CandidateChangesDetailsDto[] | no | Bearbeitete Bewerber |
deleted |
CandidateChangesDetailsDto[] | no | Gelöschte Bewerber |
Bewerberänderungen pro Tag
GET /candidates/export/candidates/changes/{date}
Dieser Endpunkt gibt die Änderungen der Bewerber pro Tag zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Bewerber (new)
geänderte Bewerber (modified)
gelöschte Bewerber (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date |
path | string | yes | Stichtag im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
new |
CandidateChangesDetailsDto[] | no | Neue Bewerber |
modified |
CandidateChangesDetailsDto[] | no | Bearbeitete Bewerber |
deleted |
CandidateChangesDetailsDto[] | no | Gelöschte Bewerber |
404 — Bewerber nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Bewerberänderungen pro Tag und Stunde
GET /candidates/export/candidates/changes/{date}/{hour}
Dieser Endpunkt gibt die Änderungen der Bewerber pro Tag und Stunde zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Bewerber (new)
geänderte Bewerber (modified)
gelöschte Bewerber (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date |
path | string | yes | Stichtag im Format YYYY-MM-DD |
hour |
path | integer | yes | Stunde des Tages (0–23) |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
new |
CandidateChangesDetailsDto[] | no | Neue Bewerber |
modified |
CandidateChangesDetailsDto[] | no | Bearbeitete Bewerber |
deleted |
CandidateChangesDetailsDto[] | no | Gelöschte Bewerber |
404 — Bewerber nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Existiert Bewerber mit Email
GET /candidates/exists
Dieser Endpunkt prüft ob ein Bewerber mit der Email existiert.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
email |
query | string | no | E-Mail-Adresse des Bewerbers |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
exists |
boolean | no | Bewerber vorhanden |
candidateId |
integer (int32) | null | no |
status |
string | null | no |
