Folgende SOAP-Methoden werden speziell für die Interaktion mit Blacklisten bereitgestellt.
addToBlacklist
Blacklisteintrag hinzufügen
bool addToBlacklist(int mandator_id, string entry, string comment = '')
Details
Parameter
- int mandator_id: ID des Mandanten, in welchem der Blacklisteintrag getätigt werden soll. Bei globalen Usern wird mit der ID 0 die globale Blacklist angesprochen, bei Mandanten-Benutzern die Blacklist, welche dem Mandanten zugeordnet ist.
Bitte beachten Sie, dass globale Benutzer, welche über die Systemoberfläche in einen Mandanten gewechselt haben, von dem Zeitpunkt als Mandanten-Benutzer gelten und den Parameter mandator_id ignorieren, bis der globale Benutzer über die Systemoberfläche wieder auf die “Globale Übersicht” gewechselt hat. - string entry: E-Mail-Adresse (z. B. mustermann@example.com) oder E-Mail-Domain (z. B. @example.com), welche in die Blacklist eingetragen werden soll
- string comment: Optionaler Kommentar
Rückgabewert
- bool: true im Falle eines erfolgreichen Eintrages, false wenn der Eintrag bereits existiert
Benötigte Rechte
Blacklist editieren
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:blac="https://scnem.com/soap.php/soap/blacklist">
<soapenv:Header/>
<soapenv:Body>
<blac:addToBlacklist>
<mandator_id>MANDTOR_ID</mandator_id>
<entry>BLACKLIST_ENTRY</entry>
<comment>BLACKLIST_ENTRY_COMMENT</comment>
</blac:addToBlacklist>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/blacklist">
<SOAP-ENV:Body>
<ns1:addToBlacklistResponse>
<addToBlacklistResult>true</addToBlacklistResult>
</ns1:addToBlacklistResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>