Beschreibung
Diese Funktion bieten die Möglichkeit einen Robinsoneintrag im System zu hinterlegen. Dabei können eine oder mehrere E-Mail-Adressen hinzugefügt werden. Standardmäßig wird der Robinsoneintrag immer in der festen Robinsonliste hinterlegt. Um den oder die Einträge in der temporären Robinsonliste hinzuzufügen können Sie das Flag addToTemporaryRobinson setzen.
Um die Funktion aufzurufen müssen Sie folgende Parameter angeben:
- ID des Mandanten
- API-Key (optionale Authentifizierung, wenn nicht angegeben, dann wird die Authentifizierung über die IP-Adressen vorgenommen)
- E-Mail Adressen als Array
Optional können Sie noch angeben, ob die E-Mail Adressen auf die temporäre Liste anstatt die feste Liste gesetzt werden sollen.
Als Ergebnis bekommen Sie die Information, ob die Aktion erfolgreich verlaufen ist. Zusätzlich bekommen Sie die Information, wie viele Ihrer Einträge auf die Liste gesetzt worden sind, und wie viele Einträge schon existiert haben.
Folgende Fehlermeldungen können bei fehlerhaften Requests auftreten:
- No emailaddress are given for adding to robinson list! => Es sind keine Adressen angegeben worden, die auf die Robinsonliste gesetzt werden sollen.
- Mandator-ID can not be lower than 0! => Es wurde eine ungültige Mandanten-ID angegeben.
Beispiel
$client = new SoapClient($wsdlUrl);
$request = new StdClass();
$request->mandatorId = 0;
$request->addToTemporaryRobinson = false;
$request->subscriberEmails = array();
array_push($request->subscriberEmails, "user@example.com");
try {
$result = $client->addRobinsonEntry($request);
var_dump($result);
} catch (Exception $e) {
echo "Fehler aufgetreten: " . $e->getMessage() . "\r\n";
}
object(stdClass)#2 (3) {
["success"]=>
bool(true)
["numAdded"]=>
int(0)
["numAlreadyExists"]=>
int(2)
}
Quellcode
Um ein funktionsfähiges Beispiel testen können, steht hier der Quellcode zum Download zur Verfügung.