4. Mailinglist
Content of this chapter
This chapter contains web service methods concerning the mailinglist management.
4.1. AddMailinglist
Namespace: http://agnitas.org/ws/schemas
Creates a new mailing list.
4.1.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| shortname | {http://www.w3.org/2001/XMLSchema}string | short name of a mailing list to be inserted |
| description | {http://www.w3.org/2001/XMLSchema}string | description of a mailing list to be inserted |
4.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| mailinglistID | {http://www.w3.org/2001/XMLSchema}int | ID of the inserted mailing list |
4.1.3. SOAP Faults
A SOAP fault is returned, if “shortname” request fields is missing.
4.2. GetMailinglist
Namespace: http://agnitas.com/ws/schemas
Retrieves a mailing list by ID.
4.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| mailinglistID | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing list in question |
4.2.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| id | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing list in question |
| shortname | {http://www.w3.org/2001/XMLSchema}string | short name of a mailing list to be inserted |
| description | {http://www.w3.org/2001/XMLSchema}string | description of a mailing list to be inserted |
4.2.3. SOAP Faults
A SOAP fault is returned, if the mailinglistID is not positive value, or there is no mailing list with the given ID.
4.3. ListMailinglists
Namespace: http://agnitas.org/ws/schemas
Retrieves a list of all mailing lists.
4.3.1. Request elements
Note: There’s no parameter given.
4.3.2. Response elements
| Element | Data type | Description |
|---|---|---|
| item | {http://agnitas.org/ws/schemas}Mailinglist | list of mailing lists, empty if there are no mailings |
4.4. UpdateMailinglist
Namespace: http://agnitas.org/ws/schemas
Updates a mailing list with the given ID. If there is no such mailing list a new list is created.
4.4.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| mailingListId | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing list in question |
| shortname | {http://www.w3.org/2001/XMLSchema}string | short name of a mailing list to be updated |
| description | {http://www.w3.org/2001/XMLSchema}string | description of a mailing list to be updated |
4.4.2. Response elements
Note: The response has no elements.
4.4.3. SOAP Faults
A SOAP fault is returned, if any of the mandatory request fields is missing or 'mailingListId' is not positive.
4.5. DeleteMailinglist
Namespace: http://agnitas.org/ws/schemas
Deletes a mailing list of the given ID.
4.5.1. Request elements
| Element | Data type | Description |
|---|---|---|
| mailinglistID | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing list to delete |
4.5.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean |
4.5.3. SOAP Faults
A SOAP fault is returned, if a mailing list with the given ID does not exist or ‘mailinglistID’ is empty.