12. Blacklist
Content of this chapter
This chapter contains web service methods concerning the blacklist.
12.1. AddBlacklist
Namespace: http://agnitas.org/ws/schemas
Adds an email to the blacklist.
12.1.1. Request elements
| Element | Data type | Description |
|---|---|---|
| {http://www.w3.org/2001/XMLSchema}string | email to be added to the blacklist | |
| reason | {http://www.w3.org/2001/XMLSchema}string | reason (free text) |
Optional elements:
| Elements | Default behavior, if not specified |
|---|---|
| reason | Reason remains empty |
12.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean | true if email was added |
12.1.3. SOAP Faults
A SOAP fault is returned, when the 'email' is not a valid email address, or it is already in the list.
12.2. CheckBlacklist
Namespace: http://agnitas.org/ws/schemas
Checks if an email is in the blacklist.
12.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| {http://www.w3.org/2001/XMLSchema}string | email to check |
12.2.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean | true if email is in the blacklist |
12.2.3. SOAP Faults
A SOAP fault is returned, when the 'email' is not a valid email address.
12.3. GetBlacklistItems
Namespace: http://agnitas.org/ws/schemas
Gets all emails from the blacklist.
12.3.1. Request elements
Note: There’s no parameter given.
12.3.2. Response elements
| Element | Data type | Description |
|---|---|---|
| {http://www.w3.org/2001/XMLSchema}string | 0 or more emails |
12.4. DeleteBlacklist
Namespace: http://agnitas.org/ws/schemas
Deletes an email from the blacklist.
12.4.1. Request elements
| Element | Data type | Description |
|---|---|---|
| {http://www.w3.org/2001/XMLSchema}string | email to delete from the blacklist |
12.4.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean | true if email is deleted |
12.4.3. SOAP Faults
A SOAP fault is returned, when the 'email' is not a valid email address.