Bewerberdokumente
8 endpoints
Lebenslauf, Zeugnisse und sonstige Unterlagen eines Bewerbers hochladen und abrufen.
Dokumente haben einen eigenen Änderungsstrom. Ein Bewerber kann unverändert bleiben, während ein Dokument dazukommt — wer nur den Bewerberstrom abfragt, verpasst neue Lebensläufe und Zeugnisse. Fragen Sie beide Ströme ab, wenn Sie Dokumente spiegeln.
Bewerberdokumentenänderungen nach Zeitraum und Niederlassung
GET /candidates/export/documents/changes
Dieser Endpunkt gibt die Änderungen der Bewerberdokumente in einem Zeitraum zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Dokumente (new)
geänderte Dokumente (modified)
gelöschte Dokumente (deleted)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endDate |
query | string | no | Ende des Zeitraums im Format YYYY-MM-DD |
officeId |
query | integer | no | Identifikation der Niederlassung |
startDate |
query | string | no | Beginn des Zeitraums im Format YYYY-MM-DD |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
new |
DocumentChangesDetailsDto[] | no | Liste neu hinzugefügter Dokumente |
modified |
DocumentChangesDetailsDto[] | no | Liste geänderter Dokumente |
deleted |
DocumentChangesDetailsDto[] | no | Liste gelöschter Dokumente |
Bewerberdokumentenänderungen pro Tag
GET /candidates/export/documents/changes/{date}
Dieser Endpunkt gibt die Änderungen der Bewerberdokumente pro Tag zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Dokumente (new)
geänderte Dokumente (modified)
gelöschte Dokumente (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 |
DocumentChangesDetailsDto[] | no | Liste neu hinzugefügter Dokumente |
modified |
DocumentChangesDetailsDto[] | no | Liste geänderter Dokumente |
deleted |
DocumentChangesDetailsDto[] | no | Liste gelöschter Dokumente |
404 — Bewerberdokumente nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Bewerberdokumentenänderungen pro Tag und Stunde
GET /candidates/export/documents/changes/{date}/{hour}
Dieser Endpunkt gibt die Änderungen der Bewerberdokumente pro Tag und Stunde zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Änderungen sind:
neue Dokumente (new)
geänderte Dokumente (modified)
gelöschte Dokumente (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 |
DocumentChangesDetailsDto[] | no | Liste neu hinzugefügter Dokumente |
modified |
DocumentChangesDetailsDto[] | no | Liste geänderter Dokumente |
deleted |
DocumentChangesDetailsDto[] | no | Liste gelöschter Dokumente |
404 — Bewerberdokumente nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Dokumentenliste pro Bewerber
GET /candidates/export/candidates/{candidateId}/documents
Dieser Endpunkt gibt eine Liste aller Dokumente pro Bewerber zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
candidateId |
path | string | yes | Identifikation des Bewerbers |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
candidateDocuments |
CandidateDocumentListDetailsDto[] | no | Liste der Dokumente des Bewerbers |
404 — Bewerber nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Bewerberdokument
GET /candidates/export/documents/{documentId}
Dieser Endpunkt gibt ein spezifisches Dokument eines Bewerbers zurück.
ACHTUNG! Dies sind sensible Daten welche gemäß der DSGVO besonders vertraulich behandelt werden müssen.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
documentId |
path | string | yes | Identifikation des Dokuments |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Identifikation des Dokumentes |
candidateId |
integer (int32) | no | Identifikation des Bewerbers |
originalFileName |
string | null | no |
createdAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher das Dokument angelegt wurde |
modifiedAtUtc |
string (date-time) | no | Datum und Uhrzeit zu welcher das Dokument das letzte Mal geändert wurde |
documentCategory |
DocumentCategoryDto | no | Kategorie des Dokuments |
documentBlob |
string | null | no |
404 — Dokument nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Lebenslauf hochladen
POST /candidates/{candidateId}/documents/cv
Lebenslauf hochladen
Mit diesem Endpunkt kann ein Lebenslauf für einen Kandidaten angelegt werden.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Das File muss als Base64 codierter String übergeben werden.
Das Feld 'shouldParseCV' gibt an, ob der CV Parser gestartet werden soll. Bitte false angeben, wenn die Lebenslaufdaten über die anderen Endpunkte übergeben werden, da die Daten ansonsten ggf. doppelt erzeugt werden.
Dokument als Lebenslauf hinzufügen
Mit diesem Endpunkt kann ein Lebenslauf an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als Lebenslauf angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
candidateId |
path | integer | yes | Identifikation des Bewerbers |
Request body
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
filename |
string | null | no |
base64File |
string | null | no |
shouldParseCV |
boolean | no | Gibt an, ob der Lebenslauf analysiert werden soll |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Eindeutige Identifikation des erzeugten Datensatzes |
400 — Ungültige Anfrage oder Validierungsfehler
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
404 — Bewerber nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Dokument als sonstiges Dokument hinzufügen
POST /candidates/{candidateId}/documents/other
Mit diesem Endpunkt kann ein Dokument an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als sonstiges angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
candidateId |
path | integer | yes | Identifikation des Bewerbers |
Request body
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
filename |
string | null | no |
base64File |
string | null | no |
shouldParseCV |
boolean | no | Gibt an, ob der Lebenslauf analysiert werden soll |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Eindeutige Identifikation des erzeugten Datensatzes |
400 — Ungültige Anfrage oder Validierungsfehler
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
404 — Bewerber nicht gefunden
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
Dokument als Führerschein hinzufügen
POST /candidates/{candidateId}/documents/{documentCategory}
Dokument als Führerschein hinzufügen
Mit diesem Endpunkt kann ein Dokument an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als Führerschein angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Dokument als Bewerbung hinzufügen
Mit diesem Endpunkt kann ein Dokument an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als Bewerbung angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Dokument als Arbeitserlaubnis hinzufügen
Mit diesem Endpunkt kann ein Dokument an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als Arbeitserlaubnis angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Dokument als Führungszeugnis hinzufügen
Mit diesem Endpunkt kann ein Dokument an einen Bewerber angehängt werden..
Dieses Dokument wird dann bei einem Bewerber unter Dokumente als Führungszeugnis angezeigt.
Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
candidateId |
path | integer | yes | Identifikation des Bewerbers |
documentCategory |
path | string | yes | Kategorie des Dokuments |
Request body
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
filename |
string | null | no |
base64File |
string | null | no |
shouldParseCV |
boolean | no | Gibt an, ob der Lebenslauf analysiert werden soll |
Responses
200 — OK
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) | no | Eindeutige Identifikation des erzeugten Datensatzes |
400 — Ungültige Anfrage oder Validierungsfehler
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |
404 — Bewerber nicht gefunden oder unbekannte Dokumentkategorie
| Property | Type | Required | Description |
|---|---|---|---|
messageGuid |
string (uuid) | null | no |
message |
string | null | no |
validationErrors |
ValidationError[] | no | Liste der Validierungsfehler |