The following SOAP methods are provided specifically for interaction with blacklists.
add
Add blacklist entry
bool add( int customer_id, string entry, string comment = '' )
Details
Parameters
- int customer_id: ID of the client in which the blacklist entry is to be made. For global users, the global blacklist is addressed with the ID 0, for client users, the blacklist that is assigned to the client.
Please note that global users who have switched to a client via the system interface are considered client users from that point on and ignore the parameter mandator_id until the global user has switched back to the "Global Overview" via the system interface. - string email: E-mail address (e.g. mustermann@example.com) or e-mail domain (e.g. @example.com) to be added to the blacklist
- string description: Optional comment
Return value
- nothing: no response in case of a successful entry, error message if the entry already exists
Required rights
Edit Blacklist
Use
<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
Show blacklist entries
bool get( int customer_id )
Details
Parameters
- int customer_id: ID of the client in which the blacklist entry is to be made. For global users, the global blacklist is addressed with the ID 0, for client users the blacklist which is assigned to the client.
Please note that global users who have switched to a client via the system interface are considered client users from that point on and ignore the parameter mandator_id until the global user has switched back to the "Global Overview" via the system interface.
Return value
- email: listed eMail address
- description: Reason for listing if available.
Required rights
Edit Blacklist
Use
<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
Remove blacklist entry
bool remove( int customer_id )
Details
Parameters
- int customer_id: ID of the client in which the blacklist entry is to be made. For global users, the global blacklist is addressed with the ID 0, for client users the blacklist which is assigned to the client.
Please note that global users who have switched to a client via the system interface are considered client users from that point on and ignore the parameter mandator_id until the global user has switched back to the "Global Overview" via the system interface.
Return value
- nothing: no response in case of a successful entry, error message if the entry was not found
Required rights
Edit Blacklist
Use
<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>