8. Mailing Content
Content of this chapter
This chapter contains web service methods concerning the content of a mailing.
8.1. AddContentBlock
Namespace: http://agnitas.org/ws/schemas
Adds a content block to a mailing.
8.1.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | mailing's ID to add the content to |
| blockName | {http://www.w3.org/2001/XMLSchema}string | the name of the content block |
| targetID | {http://www.w3.org/2001/XMLSchema}int | ID of a target content is used for |
| content | {http://www.w3.org/2001/XMLSchema}string | dynamic content |
| order | {http://www.w3.org/2001/XMLSchema}int | order of the content block in the content block sequence |
8.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | ID of a newly added content block |
8.1.3. SOAP Faults
A SOAP fault is returned, when
- “mailingID” or “order” is not positive,
- “targetID” is negative,
- one of the mandatory attributes is missing,
- there is no mailing with the given ID,
- there is no content block with given name or
- a content block with the same order value already exists.
8.2. GetContentBlock
Namespace: http://agnitas.org/ws/schemas
Retrieves a content block by ID.
8.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | contend ID |
8.2.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | content ID |
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing the content block pertains to |
| name | {http://www.w3.org/2001/XMLSchema}string | the name of the content block |
| targetID | {http://www.w3.org/2001/XMLSchema}int | ID of a target content is used for |
| content | {http://www.w3.org/2001/XMLSchema}string | dynamic content |
| order | {http://www.w3.org/2001/XMLSchema}int | order of the content block in the content block sequence |
8.2.3. SOAP Faults
A SOAP fault is returned,if 'contentID' is not positive or there is no content block with the given ID.
8.3. ListContentBlocks
Namespace: http://agnitas.org/ws/schemas
Retrieves a list of content blocks for a particular mailing.
8.3.1. Request elements
| Element | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | mailing ID |
8.3.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | content ID |
| name | {http://www.w3.org/2001/XMLSchema}string | name of the content block |
| targetID | {http://www.w3.org/2001/XMLSchema}int | ID of a target content is used for |
| order | {http://www.w3.org/2001/XMLSchema}int | order of the content block in the content block sequence |
8.3.3. SOAP Faults
A SOAP fault is returned, if 'mailingID' is not positive or there is no mailing with the given ID.
8.4. UpdateContentBlock
Namespace: http://agnitas.org/ws/schemas
Updates a content block by ID.
8.4.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | ID of the content to update |
| content | {http://www.w3.org/2001/XMLSchema}string | dynamic content |
| targetID | {http://www.w3.org/2001/XMLSchema}int | ID of a target content is used for |
| order | {http://www.w3.org/2001/XMLSchema}int | order of the content block in the content block sequence |
8.4.2. Response elements
Note: The response has no elements.
8.4.3. SOAP Faults
A SOAP fault is returned, if any of mandatory request fields is missing, 'contentID' or 'order' is not positive or 'targetID' is negative or when there is no correspondent target, mailing or a content block name.
8.5. DeleteContentBlock
Namespace: http://agnitas.org/ws/schemas
Deletes a content block by ID.
8.5.1. Request elements
| Element | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | ID of a content block to delete |
8.5.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean | true if a content block is deleted |
8.5.3. SOAP Faults
A SOAP fault is returned, when contentID is not positive.
8.6. ListContentBlockNames
Namespace: http://agnitas.org/ws/schemas
Retrieves names of all text modules that belong to a particular mailing.
8.6.1. Request elements
| Element | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of a mailing in question |
8.6.2. Response elements
| Element | Data type | Description |
|---|---|---|
| ContentBlockName | {http://www.w3.org/2001/XMLSchema}element | 0 or more elements nameID: name's ID name: actual name |
8.6.3. SOAP Faults
A SOAP fault is returned, when the 'mailingID' is not positive or when there is no mailing with such ID.
8.7. ImportMailingContent (only EMM)
Namespace: http://agnitas.org/ws/schemas
Imports data out of a XML content source into a mailing.
8.7.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| contentID | {http://www.w3.org/2001/XMLSchema}int | ID of the content source |
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of the mailing the content should be assigned to |
| minDate | {http://www.w3.org/2001/XMLSchema}dateTime | Timestamp to limit the inputs of the content source |
The format of the timestamp is YYYY-MM-DDThh:mm:ss (optional with time zone)
8.7.2. Response elements
| Element | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}boolean | Delivers true, when import is carried out correctly |
8.7.3. SOAP Faults
A SOAP fault is delivered, when an error occurs during the implementation.