Bewerberdetails

Bewerberdetails

GET /candidates/export/candidates/{candidateId}

Dieser Endpunkt gibt ein spezifischer Bewerber zurück.

Parameters

Responses

200 — OK

404 — Bewerber nicht gefunden

Stammdaten anlegen

POST /candidates

Mit diesem Endpunkt kann man die Stammdaten eines Kandidaten anlegen.

Neu in V 3.4.0:

• contact.phoneNumber und contact.mobileNumber werden beide gespeichert. Bisher ging phoneNumber verloren, wenn beide Felder befüllt waren. Wer nur eines der beiden Felder sendet, ist nicht betroffen.

Angekündigt: Telefonnummern werden künftig gegen den internationalen Rufnummernkatalog geprüft. Derzeit wird nichts abgelehnt: Ein Wert, der keine existierende Rufnummer ist, wird gespeichert und nur protokolliert. Eine Ablehnung mit 400 und validationErrors wird vorher angekündigt. Festnetznummern sind zulässig; nicht bestehen würden Werte wie abc, 1 oder eine zu kurze Nummer wie 0171 123.

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

Bewerbung zu einem Bewerber anlegen

POST /candidates/{id}/apply

Mit diesem Endpunkt kann eine Bewerbung für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Die RecruiterId kann über die Benutzer ermittelt werden.

Optional kann noch eine jobAdId mitgeliefert werden, die auf einen existierenden JobAd verweisen muss.

Optional kann noch eine channelId mitgeliefert werden, die auf einen existierenden Kanal verweisen muss. Im Standard wird der Kanal "Import" (51) verwendet. Sowohl die jobAdId als auch die channelId sind als Ganzzahl anzugeben.

Wird eine jobAdId mitgeliefert, übernimmt die API den Berufstitel der Stellenanzeige als Schlagwort am Bewerber.

Neu in V 3.4.0:

• Das Schlagwort aus dem Berufstitel wird bei Bedarf angelegt. Bisher schlug der Aufruf mit INVALIDDATA fehl, wenn der Titel noch nicht als Schlagwort existierte, obwohl die Bewerbung bereits angelegt war, und ein zweiter Versuch lief in die Dublettenprüfung.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Email hinzufügen

POST /candidates/{id}/email

Mit diesem Endpunkt kann eine Email für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Sms hinzufügen

POST /candidates/{id}/sms

Mit diesem Endpunkt kann eine SMS für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Whats App hinzufügen

POST /candidates/{id}/whatsapp

Mit diesem Endpunkt kann eine WhatsApp Nachricht für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Profilbild hochladen

POST /candidates/{id}/pictures

Mit diesem Endpunkt kann ein Profilbild für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Das Bild muss als Base64 codierter String übergeben werden.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Berufe anlegen

POST /candidates/{id}/professions

Mit diesem Endpunkt kann ein Beruf für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Für die professionId ist die DKZID des BA Kataloges zu verwenden.

Neu in V 3.4.0:

• Ein bereits zugeordneter Beruf wird nicht doppelt angelegt, eine zuvor gelöschte Zuordnung wird reaktiviert. In beiden Fällen antwortet der Endpunkt mit 200 und derselben id wie beim ersten Anlegen: der DKZID, die auch DELETE /candidates/{id}/professions/{professionId} erwartet.

Parameters

Request body

Content type: application/json

Responses

200 — OK — id enthält die übergebene professionId (DKZID), nicht die Id der erzeugten Zuordnung (die liefert professionObjects[].id der Bewerberdetails). Das gilt bei jedem Aufruf — auch wenn die Zuordnung bereits bestand oder reaktiviert wurde. Die Id wird unverändert in DELETE /candidates/{id}/professions/{professionId} verwendet.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Keywords anlegen

POST /candidates/{id}/keywords

Mit diesem Endpunkt kann ein Keyword für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Neu in V 3.4.0:

• Ein bereits zugeordnetes Schlagwort wird nicht doppelt angelegt, eine zuvor gelöschte Zuordnung wird reaktiviert. In beiden Fällen antwortet der Endpunkt mit 200 und derselben id wie beim ersten Anlegen: der Id des Schlagwort-Stammsatzes, die auch DELETE /candidates/{candidateId}/keywords/{keywordId} erwartet.

Parameters

Request body

Content type: application/json

Responses

200 — OK — id ist die Id des Schlagworts (Stammsatz), nicht die Id der Zuordnung zum Bewerber. Sie ist bei jedem Aufruf mit demselben Schlagwort identisch — auch wenn die Zuordnung bereits bestand oder reaktiviert wurde — und wird unverändert in DELETE /candidates/{candidateId}/keywords/{keywordId} verwendet.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Qualifikation anlegen

POST /candidates/{id}/qualifications

Mit diesem Endpunkt kann eine Qualifikation für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Zusätzlich kann ein Score im Bereich von 1 bis 5 oder alternativ der Wert null angegeben werden.

Neu in V 3.4.0:

• Eine bereits zugeordnete Qualifikation wird nicht doppelt angelegt, eine zuvor gelöschte Zuordnung wird reaktiviert. In beiden Fällen antwortet der Endpunkt mit 200 und derselben id wie beim ersten Anlegen: der Id des Qualifikations-Stammsatzes, die auch DELETE /candidates/{id}/qualifications/{qualificationId} erwartet.

Parameters

Request body

Content type: application/json

Responses

200 — OK — id ist die Id der Qualifikation (Stammsatz, dieselbe Id wie in qualificationsWithScore[].id der Bewerberdetails), nicht die Id der Zuordnung zum Bewerber. Sie ist bei jedem Aufruf mit derselben Qualifikation identisch — auch wenn die Zuordnung bereits bestand oder reaktiviert wurde — und wird unverändert in DELETE /candidates/{id}/qualifications/{qualificationId} verwendet.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Sprache anlegen

POST /candidates/{id}/languages

Mit diesem Endpunkt kann eine Sprache für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Folgende languageIds sind gültig:

Folgende languageLevelIds sind gültig:

Parameters

Request body

Content type: application/json

Responses

200 — OK — id enthält die übergebene languageId, nicht die Id der erzeugten Sprachkenntnis (die liefert languages[].id der Bewerberdetails).

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Führerschein anlegen

POST /candidates/{id}/driverslicences

Mit diesem Endpunkt kann ein Führerschein für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Folgende driverLicenceIds sind gültig:

Parameters

Request body

Content type: application/json

Responses

200 — OK — id enthält die übergebene driversLicenseId, nicht die Id der erzeugten Zuordnung.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Beruflichen Werdegang anlegen

POST /candidates/{id}/resume/jobs

Mit diesem Endpunkt kann einen beruflichen Werdegang für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Berufsausbildung anlegen

POST /candidates/{id}/resume/professioneducations

Mit diesem Endpunkt kann eine Berufsausbildung für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Schulbildung anlegen

POST /candidates/{id}/resume/schooleducations

Mit diesem Endpunkt kann eine Schule für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Weiterbildung anlegen

POST /candidates/{id}/resume/educations

Mit diesem Endpunkt kann eine Weiterbildung für einen Kandidaten angelegt werden.

Es wird die KandidatenId benötigt, welche beim Anlegen der Stammdaten zurück gegeben wird.

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Bewerberstammdaten ändern

PUT /candidates/{candidateId}

Ändert die Stammdaten eines Bewerbers. Es werden ausschließlich die im Request-Body übermittelten Felder geändert — nicht übermittelte Felder bleiben unverändert. Das gilt auch innerhalb der Sub-Objekte (contact, location, birth …): Ein übermitteltes Sub-Objekt ersetzt nicht den ganzen Block, sondern nur dessen enthaltene Felder. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt. Listenartige Angaben wie Berufe, Sprachen, Qualifikationen oder Führerscheine werden hierüber nicht gepflegt, dafür gibt es eigene Endpunkte unter /candidates/{id}/…. Der Bewerberstatus wird über PUT /candidates/{id}/status gesetzt. Die zulässigen Werte der Katalog-Ids (genderId, levelId, driversLicenseId, professionId, countryId …) liefern die Stammdaten-Endpunkte unter /masterdata/….

Neu in V 3.4.0:

• contact.phoneNumber wird beim Ändern ausgewertet; bisher wurde das Feld ohne Fehlermeldung ignoriert. Beide Telefonnummern werden gespeichert. Ein nicht übermitteltes Telefonfeld behält seine gespeicherte Nummer, ein Teil-Update verwirft die andere Nummer also nicht.

Angekündigt: Telefonnummern werden künftig gegen den internationalen Rufnummernkatalog geprüft. Derzeit wird nichts abgelehnt: Ein Wert, der keine existierende Rufnummer ist, wird gespeichert und nur protokolliert. Eine Ablehnung mit 400 und validationErrors wird vorher angekündigt. Geprüft werden nur die im Request übermittelten Telefonfelder; eine bereits gespeicherte Nummer führt nie zu einem Fehler. Festnetznummern sind zulässig.

Parameters

Request body

Required.

Zu ändernde Bewerberstammdaten. Nur die übermittelten Felder werden geändert.

Content type: application/json

Responses

204 — Request successful, no content returned

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Bewerber archivieren/ablehnen/qualifizieren/einstellen

PUT /candidates/{id}/status

Mit diesem Endpunkt kann man einzelne Bewerber archivieren, ablehnen oder qualifizieren.

Erlaubte Status Ids sind

• 23 (archiviert)

• 2003 (einstellen)

• 2004 (abgelehnt)

• 2005 (qualifiziert)

Parameters

Request body

Content type: application/json

Responses

200 — OK

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Bewerber Arbeitsvertrag

PUT /candidates/{candidateId}/workcontract

Pflegt die Arbeitsvertragsdaten eines Bewerbers: ob der Vertrag unterzeichnet ist (isWorkContractSigned), wann er unterzeichnet wurde (workContractSignedAtUtc) und ob der Bewerber die Stelle nicht angetreten hat (didNotShowUpForWork). Das Ende der Einsatzzeit wird über PUT /candidates/{candidateId}/endofoperation gesetzt, der Bewerberstatus über PUT /candidates/{id}/status.

Parameters

Request body

Required.

Zu ändernde Arbeitsvertragsdaten des Bewerbers.

Content type: application/json

Responses

204 — Arbeitsvertrag gespeichert, die API antwortet ohne Inhalt.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Bewerber Ende der Einsatzzeit

PUT /candidates/{candidateId}/endofoperation

Setzt das Ende der Einsatzzeit eines Bewerbers. Übergeben wird ausschließlich endOfOperationAtUtc, der Zeitpunkt des Einsatzendes in UTC. Der Bewerberstatus wird dadurch nicht verändert — dafür dient PUT /candidates/{id}/status. Die Meldung eines unterzeichneten Vertrags läuft über PUT /candidates/{candidateId}/workcontract.

Parameters

Request body

Content type: application/json

Responses

204 — Ende der Einsatzzeit gespeichert, die API antwortet ohne Inhalt.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber nicht gefunden

Sprache ändern

PUT /candidates/{candidateId}/languages/{languageId}

Ändert das Sprachniveau einer bereits erfassten Sprachkenntnis eines Bewerbers. Übergeben wird ausschließlich levelId; die Sprache selbst lässt sich nicht tauschen — dafür den Eintrag über DELETE /candidates/{candidateId}/languages/{languageId} löschen und per POST /candidates/{id}/languages neu anlegen. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt.

Parameters

Request body

Required.

Neues Sprachniveau der zu ändernden Sprachkenntnis.

Content type: application/json

Responses

204 — Request successful, no content returned

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber oder Sprachkenntnis nicht gefunden

Schlagwort löschen

DELETE /candidates/{candidateId}/keywords/{keywordId}

Neu in V 3.4.0: Entfernt ein Schlagwort von einem Bewerber. Bisher war das nur für Qualifikationen und Berufe möglich.

keywordId ist die Schlagwort-Id (der Stammsatz), nicht die Id der Zuordnung, genauso wie bei den Löschendpunkten für Qualifikationen und Berufe.

Gelöscht wird als Soft-Delete: Die Zuordnung wird deaktiviert, der Schlagwort-Stammsatz bleibt bestehen. Ein erneutes POST /candidates/{id}/keywords mit demselben Schlagwort reaktiviert die Zuordnung. Der Bewerber wird aus der Volltextsuche des gelöschten Schlagworts entfernt.

Ein nicht zugeordnetes oder bereits inaktives Schlagwort ergibt 404.

Parameters

Responses

204 — Schlagwort entfernt — die API antwortet ohne Inhalt.

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber oder Schlagwort nicht gefunden — auch dann, wenn das Schlagwort dem Bewerber nicht zugeordnet oder die Zuordnung bereits inaktiv ist.

Sprache löschen

DELETE /candidates/{candidateId}/languages/{languageId}

Löscht eine Sprachkenntnis eines Bewerbers. candidateId adressiert den Bewerber, languageId die Sprache — also dieselbe Id, die beim Anlegen über POST /candidates/{id}/languages übergeben wurde (aus /masterdata/languages), nicht die interne Kennung aus languages[].id der Bewerberdetails. Soll nur das Niveau geändert werden, dient PUT /candidates/{candidateId}/languages/{languageId}. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt.

Parameters

Responses

204 — Request successful, no content returned

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber oder Sprachkenntnis nicht gefunden

Berufe löschen

DELETE /candidates/{id}/professions/{professionId}

Entfernt die Zuordnung eines Berufs bzw. Einsatzgebiets von einem Bewerber. Der Beruf selbst bleibt als Stammdatum erhalten und kann weiterhin anderen Bewerbern zugeordnet sein. Zugeordnet werden Berufe über POST /candidates/{id}/professions. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt.

Parameters

Responses

204 — Request successful, no content returned

404 — Bewerber oder Beruf nicht gefunden

Führerschein löschen

DELETE /candidates/{candidateId}/driverslicences/{driversLicenseId}

Löscht einen Führerschein-Eintrag eines Bewerbers. candidateId adressiert den Bewerber, driversLicenseId die zu entfernende Führerscheinklasse — also dieselbe Katalog-Id aus GET /masterdata/driverslicenses, die beim Anlegen übermittelt wurde, und nicht die Id des Zuordnungsdatensatzes. Angelegt werden Führerscheine über POST /candidates/{id}/driverslicences. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt.

Parameters

Responses

204 — Request successful, no content returned

400 — Ungültige Anfrage oder Validierungsfehler

404 — Bewerber oder Führerschein nicht gefunden

Qualifikationen löschen

DELETE /candidates/{id}/qualifications/{qualificationId}

Entfernt die Zuordnung einer Qualifikation von einem Bewerber. Die Qualifikation selbst bleibt als Stammdatum erhalten. Zugeordnet werden Qualifikationen über POST /candidates/{id}/qualifications. Ein erfolgreicher Aufruf liefert 204 ohne Inhalt.

Parameters

Responses

204 — Request successful, no content returned

404 — Bewerber oder Qualifikation nicht gefunden