Abrufen eines Bewerber- Datensatzes
Um die vorhandenen Daten eines Bewerbers einsehen zu können, wurde folgender Endpunkt konzipiert.
Dieser liefert als Antwort die Kerndaten für den Bewerber.
URL
https://rating.softgarden.io/rest/api/v1/sa/applicantData/{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 / 204 | Die gespeicherten Stammdaten des Bewerbers, sofern Zugriff auf diese möglich ist. Ansonsten eine leere Antwort |
| 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
|
1 2 3 4 5 |
curl -X GET \ https://rating.softgarden.io/rest/api/v1/sa/applicantData/YourReferenceId321-new \ -H 'Authorization: Basic SXRXaWxsRmFpbDplNDZiZmFjMzZkYTA0NmRhYTQwMzA0YjdhNzQ1YjJiMw==' \ -H 'Postman-Token: 4c0a5294-da42-474c-94fb-293535f28a7e' \ -H 'cache-control: no-cache' |
Antwort- Objekt
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "firstname": "R F-name", "lastname": "L-name", "gender": "MALE", "email": "email@exampleEmail.de", "referenceId": "YourReferenceId321-new", "employeeStatus": "EMPLOYEE", "typeOfEmployment": "internship", "jobData": { "jobId": "YourJobId", "jobName": "Example Job Name", "jobCategory": "sam42_banking", "jobLocation": { "name": "Berlin, Deutschland", "city": "Berlin", "state": "Berlin", "country": "Deutschland" } } } |
Antwort- Erläuterung
| Key | Value |
|---|---|
| firstname | (String) – Vorname |
| lastname | (String) – Nachname |
| gender | (String) mit den Werten [‘MALE’, ‘FEMALE’, ‘NA’] – Geschlecht |
| (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 |