11. Mailing Images
Content of this chapter
This chapter contains web service methods concerning images of a mailing.
11.1. AddMailingImage
Namespace: http://agnitas.org/ws/schemas
Add an image to a mailing
11.1.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of mailing, to which the image is added |
| content | {http://www.w3.org/2001/XMLSchema}string | Base64-encoded content |
| fileName | {http://www.w3.org/2001/XMLSchema}string | File name, which is used to reference image in mailing |
Optional elements:
| Elements | Data type | Description |
|---|---|---|
| description | {http://www.w3.org/2001/XMLSchema}string | Description of image |
| URL | {http://www.w3.org/2001/XMLSchema}string | Link for when clicking image |
| replaceExisting | {http://www.w3.org/2001/XMLSchema}boolean | When set to "true", an existing image with same name will be replaced. If not given, a valuie of "false" is assumed. In this case, the webservice returns a SOAP fault when an image with same name already exists. |
11.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| ID | {http://www.w3.org/2001/XMLSchema}int | ID of new image |
11.1.3. SOAP Faults
The webservice returns a SOAP fault if mailing ID is unknown or when an image with same name already exists.