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

Achtung: Sollte ein Bewerber bereits eine Email erhalten haben, ist eine Bearbeitung nicht mehr möglich

URL

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

Authentifizierung

Client Token oder Basic Authorization

HTTP Methode

PUT

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
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

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

Antwort