Anlegen eines Mail-Datensatzes für einen Bewerber

Um das Anlegen einer Mail für einen bestehenden Bewerber zu ermöglichen, wurde folgender Endpunkt konzipiert.

URL

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

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
referenceId	(*) String => Referenz Id des existierenden Bewerbers
mailData	JSON Objekt (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

{
  "referenceId": "YourReferenceId321-new",
  "mailData": {
    "mailType": "HIRED",
    "sendTime": 1541819000000,
    "locale": "de"
  }
}

{

"referenceId": "YourReferenceId321-new",

"mailData": {

"mailType": "HIRED",

"sendTime": 1541819000000,

"locale": "de"

}

Responses

Ereignis	Rückgabewert	Beschreibung
success	200	Die Referenz Id über welche die Mail Informationen bearbeiten 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/mailData \
 -H 'Authorization: Basic &lt;Basic Base64 Toke&gt;' \
 -H 'Content-Type: application/json' \
 -H 'Postman-Token: 49d2646b-d8ab-4b47-a7df-414702db9dfa' \
 -H 'cache-control: no-cache' \
 -d '{
 "referenceId": "YourReferenceId321-new",
 "mailData": 
 {
 "mailType": "HIRED",
 "sendTime": 1541819000000,
 "locale": "de"
 }
}'

curl -X POST \

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

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

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

-H 'Postman-Token: 49d2646b-d8ab-4b47-a7df-414702db9dfa' \

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

-d '{

"referenceId": "YourReferenceId321-new",

"mailData":

{

"mailType": "HIRED",

"sendTime": 1541819000000,

"locale": "de"

}

Antwort

{ "mailId": "b435da4b-b364-4b19-8cea-c33eaa169b0e" }

1	{ "mailId": "b435da4b-b364-4b19-8cea-c33eaa169b0e" }