Folgende SOAP-Methoden werden speziell für die Interaktion mit Blacklisten bereitgestellt.
add
Blacklisteintrag hinzufügen
bool add(int customer_id, string entry, string comment = '')
Details
Parameter
- int customer_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 email: E-Mail-Adresse (z. B. mustermann@example.com) oder E-Mail-Domain (z. B. @example.com), welche in die Blacklist eingetragen werden soll
- string description: Optionaler Kommentar
Rückgabewert
- nothing: keine Response im Falle eines erfolgreichen Eintrages, Fehlermeldung wenn der Eintrag bereits existiert
Benötigte Rechte
Blacklist editieren
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:evalanche:soap:v1:blacklist">
<soapenv:Header/>
<soapenv:Body>
<urn:AddIn>
<CustomerId>MANDANTEN_ID</CustomerId>
<Item>
<Email>EMAIL</Email>
</Item>
</urn:AddIn>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<parameters/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
get
Blacklisteinträge anzeigen
bool get(int customer_id)
Details
Parameter
- int customer_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.
Rückgabewert
- email: gelistete eMail-Adresse
- description: Grund der Listung sofern vorhanden.
Benötigte Rechte
Blacklist editieren
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:evalanche:soap:v1:blacklist">
<soapenv:Header/>
<soapenv:Body>
<urn:GetIn>
<CustomerId>MANDANTEN_ID</CustomerId>
</urn:GetIn>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:evalanche:soap:v1:blacklist">
<SOAP-ENV:Body>
<ns1:GetOut>
<CustomerId>13888</CustomerId>
<Item>
<Email>EMAIL</Email>
<Description>DESCRIPTION</Description>
</Item>
[...]
</ns1:GetOut>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
remove
Blacklisteintrag entfernen
bool remove(int customer_id)
Details
Parameter
- int customer_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.
Rückgabewert
- nothing: keine Response im Falle eines erfolgreichen Eintrages, Fehlermeldung wenn der Eintrag nicht gefunden wurde
Benötigte Rechte
Blacklist editieren
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:evalanche:soap:v1:blacklist">
<soapenv:Header/>
<soapenv:Body>
<urn:RemoveIn>
<CustomerId>MANDANTEN_ID</CustomerId>
<Email>EMAIL</Email>
</urn:RemoveIn>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<parameters/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>