Um das Anlegen der Kerndaten eines Bewerbers zu gewährleisten, wurde folgender Endpunkt konzipiert.

URL

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

Authentifizierung

Client Token oder Basic Authorization

HTTP Methode

PUT

Query Paramenter

Keine

Path Parameter

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

Request Body

Der Body, der bei einer Anfrage mitgesendet werden muss, muss sich an die folgenden Bedingungen halten, damit er vom Server akzeptiert wird.

Type

application/json

Objekt Beschreibung

(*) Pflichtfeld => Die Anfrage muss dieses Feld enthalten

Key Value
 firstname  String
 lastname  String
 gender  String mit Wert => [‘MALE’, ‘FEMALE’, ‘NA’] Default: ‘NA’
 email  (*) String
 referenceId  (*) String
 employeeStatus  String mit Wert => [‘APPLICANT’, ‘EMPLOYEE’, ‘EXEMPLOYEE’, ‘NA’]
 typeOfEmployment  String
 jobData  (*) JSON Objekt (Aufbau siehe Beispiel Objekt)
jobId  (*) String
jobName  (*) String
jobCategory  (*) String
jobLocation  (*) JSON Objekt (Aufbau siehe Beispiel Objekt)
name  (*) String
city  String
state  String
country  String

 

Beispiel Objekt

Responses

Ereignis Rückgabewert Beschreibung
success 200 Die Referenz Id über welche die Daten wieder abgerufen bzw bearbeitet
werden können
authorization error 401 / 403 Siehe hier und hier für Details.
bad request 400 Falls das Objekt nicht die erforderten Daten beinhaltet

Beispiel cURL Aufruf

Anfrage

Antwort

Comments

Comments are closed.