Um die vorhandenen Daten eines Bewerbers einsehen zu können, wurde folgender Endpunkt konzipiert.
Dieser liefert als Antwort alle existierenden Daten zu einen Bewerber Objekt.

URL

https://rating.softgarden.io/rest/api/v1/sa/data/{referenceId}

Authentifizierung

Client Token oder Basic Authorization

HTTP Methode

GET

Query Paramenter

Keine

Path Parameter

{referenceId} => String => Die Id die bei der Erstellung der Daten mitgesendet wurde

Responses

Ereignis	Rückgabewert	Beschreibung
success	200	Die gespeicherten Daten des Bewerbers, sofern Zugriff auf diese möglich ist
authorization error	401 / 403	Siehe hier und hier für Details.
bad request	400	Falls die benötigten Informationen nicht mitgeliefert wurden

Beispiel cURL Aufruf

Anfrage

Antwort- Objekt

Antwort- Erläuterung

Key	Value
applicantData	(JSON Objekt) – Daten des Bewerbers
firstname	(String) – Vorname
lastname	(String) – Nachname
gender	(String) mit den Werten [‘MALE’, ‘FEMALE’, ‘NA’] – Geschlecht
email	(String) – Email Adresse des Bewerbers
referenceId	(String) – Referenz Id des Bewerbers
employeeStatus	(String) mit den Werten [‘APPLICANT’, ‘EMPLOYEE’, ‘EXEMPLOYEE’, ‘NA’] – Bewerberstatus innerhalb des Unternehmens
typeOfEmployment	(String) – Art der Anstellung
jobData	(JSON Objekt) – Daten zum Job
jobId	(String) – Referenz Id des Jobs
jobName	(String) – Name des Jobs
jobCategory	(String) – Kategorie des Jobs (Bankwesen, Medizin, IT ….)
jobLocation	(JSON Objekt) – Daten des Jobstandorts
name	(String) – Anzeigename des Standortes
city	(String) – Stadt des Standortes
state	(String) – Bundesland
country	(String) – Land
mailData	(JSON Array von Objekten) – Enthält Informationen zu den bevorstehenden bzw. versendeten Mails zu einem Bewerber
mailId	(String) – Die Id des generierten Mail Objektes, über diese Id können Modifikationen and diesem vorgenommen werden
mailType	(String) mit den Werten [‘INTERVIEWED’, ‘HIRED’, ‘REJECTED’] – Art des Feedbacktyps
sendTime	(Number) – Zeitpunkt des geplanten bzw. durchgeführten Mailversandes in Millisekunden
locale	(String) mit den Werten [‘de’, ‘en’] – Locale Tag
sendStatus	(String) – Der aktuelle Status des Mailversandes mit den Werten [‘SCHEDULED_TO_SEND’, ‘SENT’]