Anlegen eines vollständigen Bewerber- Datensatzes (inkl. Mails)

Um das Anlegen eines vollständigen Datensatzes zu gewährleisten, wurde folgender Endpunkt konzipiert.

URL

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

Authentifizierung

Client Token oder Basic Authorization

HTTP Methode

POST

Query Paramenter

Keine

Path Parameter

Keine

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
applicantData	(*) JSON Objekt (Aufbau siehe Beispiel Objekt)
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
mailData	JSON Array von Objekten (Aufbau siehe Beispiel Objekt)
mailType	(*) String mit Wert => [‘INTERVIEWED’, ‘HIRED’, ‘REJECTED’]
sendTime	Long (Zeit in Millisekunden) => Wenn nicht angegeben wird die jetzige Zeit hinterlegt
locale	Language Tag => [‘de’, ‘en’] Wird eine Sprache abseits der beiden gewählt wird Englisch hinterlegt

Beispiel Objekt

{
  "applicantData": {
    "firstname": "F-name",
    "lastname": "L-name",
    "gender": "MALE",
    "email": "email@exampleEmail.de",
    "referenceId": "YourReferenceId 123",
    "employeeStatus": "EMPLOYEE",
    "typeOfEmployment": "internship",
    "jobData": {
      "jobId": "YourJobId",
      "jobName": "Example Job Name",
      "jobCategory": "sam42_banking",
      "jobLocation": {
        "name": "Berlin, Deutschland",
        "city": "Berlin",
        "state": "Berlin",
        "country": "Deutschland"
      }
    }
  },
  "mailData": [
    {
      "mailType": "INTERVIEWED",
      "sendTime": 1541819000000,
      "locale": "de"
    }
  ]
}

{

"applicantData": {

"firstname": "F-name",

"lastname": "L-name",

"gender": "MALE",

"email": "email@exampleEmail.de",

"referenceId": "YourReferenceId 123",

"employeeStatus": "EMPLOYEE",

"typeOfEmployment": "internship",

"jobData": {

"jobId": "YourJobId",

"jobName": "Example Job Name",

"jobCategory": "sam42_banking",

"jobLocation": {

"name": "Berlin, Deutschland",

"city": "Berlin",

"state": "Berlin",

"country": "Deutschland"

}

"mailData": [

{

"mailType": "INTERVIEWED",

"sendTime": 1541819000000,

"locale": "de"

}

]

}

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

curl -X POST \
 https://rating.softgarden.io/rest/api/v1/sa/data \
 -H 'Authorization: Basic &lt;Base64 Basic String&gt;' \
 -H 'Content-Type: application/json' \
 -H 'Postman-Token: 219e1761-0cbe-4c2f-a9b3-b3446ef32a82' \
 -H 'cache-control: no-cache' \
 -d '{
 "applicantData": {
 "firstname": "R F-name",
 "lastname": "L-name",
 "gender": "MALE",
 "email": "email@exampleEmail.de",
 "referenceId": "YourReferenceId12345",
 "employeeStatus": "EMPLOYEE",
 "typeOfEmployment": "internship",
 "jobData": {
 "jobId": "YourJobId",
 "jobName": "Example Job Name",
 "jobCategory": "sam42_banking",
 "jobLocation": {
 "name": "Berlin, Deutschland",
 "city": "Berlin",
 "state": "Berlin",
 "country": "Deutschland"
 }
 }
 },
 "mailData": [{
 "mailType": "INTERVIEWED",
 "sendTime": 1541819000000,
 "locale": "de"
 }]
}'

curl -X POST \

https://rating.softgarden.io/rest/api/v1/sa/data \

-H 'Authorization: Basic <Base64 Basic String>' \

-H 'Content-Type: application/json' \

-H 'Postman-Token: 219e1761-0cbe-4c2f-a9b3-b3446ef32a82' \

-H 'cache-control: no-cache' \

-d '{