Abrufen eines Mail-Datensatzes für einen Bewerber

Um die vorhandenen Mail-Daten eines Bewerbers einsehen zu können, wurde folgender Endpunkt konzipiert.
Dieser liefert als Antwort den existierenden Mail- Datensatz für eine mitgegebene Id falls dieser vorhanden ist.

URL

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

Authentifizierung

Client Token oder Basic Authorization

HTTP Methode

GET

Query Paramenter

Keine

Path Parameter

{referenceId} => String => Die Id des Mail-Datensatzes

Responses

Ereignis	Rückgabewert	Beschreibung
success	200 / 204	Die gespeicherten Mail- Daten, sofern Zugriff 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

curl -X GET \
 https://rating.softgarden.io/rest/api/v1/sa/mailData/testMailDataId \
 -H 'Authorization: Basic &lt;Basic Base64 Token&gt;' \
 -H 'Postman-Token: 7faffb48-2b1b-4724-995a-f371fefe40b6' \
 -H 'cache-control: no-cache'

curl -X GET \

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

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

-H 'Postman-Token: 7faffb48-2b1b-4724-995a-f371fefe40b6' \

-H 'cache-control: no-cache'

Antwort- Objekt

{
 "mailId": "testMailDataId",
 "mailType": "HIRED",
 "sendTime": 1541819000000,
 "locale": "de",
 "sendStatus": "SCHEDULED_TO_SEND"
}

{

"mailId": "testMailDataId",

"mailType": "HIRED",

"sendTime": 1541819000000,

"locale": "de",

"sendStatus": "SCHEDULED_TO_SEND"

}

Antwort- Erläuterung

Key	Value
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’]