Last Update: 2024-03-21
<?xml version="1.0" encoding="utf-8"?> <getnewsletterdetail id="" customerid="" />
| Element | Format | Description |
|---|---|---|
getnewsletterdetail | ||
↳ @id | int | ID of desired newsletter |
↳ @customerid | int | Optional; ID of customer where newsletter is from (needs API username/password of Suite-Manager). |
<data>
<senddatetime>_____</senddatetime>
<titleinternal>_____</titleinternal>
<language></language>
<subject>_____</subject>
<fromname>_____</fromname>
<fromemail>_____</fromemail>
<replyto>_____</replyto>
<templateid>_____</templateid>
<previewurl>_____</previewurl>
<fields>
<title type="Textarea"><![CDATA[_____]]></title>
<preheader type="Textarea"><![CDATA[_____]]></preheader>
<header type="Textarea"><![CDATA[_____]]></header>
<headermedia type="MediaItem">_____</headermedia>
<footer type="Textarea"><![CDATA[_____]]></footer>
<custom1 type="{type}">_____</custom1>
...
<custom10 type="{type}">_____</custom10>
</fields>
<arealist>
<area num="_____">
<group num="_____">
<name><![CDATA[_____]]></name>
<itemlist>
<item id1="_____" source1="_____" id2="_____" source2="_____" filterid="_____" />
...
</itemlist>
</group>
...
</area>
...
</arealist>
<contentlist>
<content id="_____">
<fields>
<title type="Textarea"><![CDATA[_____]]></title>
<opener type="Textarea"><![CDATA[_____]]></opener>
<media type="MediaItem">_____</media>
<detailurl type="Link">_____</detailurl>
<detail type="Textarea"><![CDATA[_____]]></detail>
<custom1 type="{type}">_____</custom1>
...
<custom10 type="{type}">_____</custom10>
</fields>
<created>_____</created>
<topics />
<sharelist />
</content>
...
</contentlist>
<medialist>
<media id="_____">
<name>_____</name>
<url>_____</url>
<size>_____</size>
<type>_____</type>
<width>_____</width>
<height>_____</height>
<copyright>_____</copyright>
</media>
...
</medialist>
</data>
| Element | Format | Description |
|---|---|---|
data | ||
↳ senddatetime | YYYY-mm-dd HH:ii:ss | |
↳ titleinternal | varchar(255) | |
↳ language | 2-letter code | Example: "de" or "en" |
↳ subject | varchar(255) | |
↳ fromname | varchar(255) | |
↳ fromemail | varchar(255) | |
↳ replyto | varchar(255) | Email address |
↳ templateid | int | |
↳ previewurl | URL of the unpersonalized preview | |
↳ fields | List of all newsletter fields | |
↳ title | varchar(255) | Title |
↳ preheader | varchar(255) | Preheader |
↳ header | text | Header text (editorial) |
↳ headermediaitemid | int | ID of header picture listed in data->medialist->media |
↳ footer | varchar | Footer text |
↳ footermediaitemid | int | ID of footer picture |
↳ custom1..10 | depends on @type | Value of custom field |
↳ @type |
Types:
|
|
↳ arealist | List of article areas | |
↳ area | An article area | |
↳ @num | Number of area (starting with zero) | |
↳ group | A article group within an area (even if there is no grouping within an area, technically the articles are in one group) | |
↳ @num | Number of group (starting with zero) | |
↳ name | Name of group (empty if there is no grouping) | |
↳ itemlist | List of articles of group | |
↳ item | Articles of group | |
↳ @id1 | ID of article | |
↳ @source1 | Source of article (Content, Event, Form, Survey, Sweepstake)Currently only "Content" is implemented. | |
↳ @id2 | ID of alternative article (see @filterid) | |
↳ @source2 | Source of alternative article (Content, Event, Form, Survey, Sweepstake)Currently only "Content" is implemented. | |
↳ @filterid | ID of filter (if contact matches filter, than article with "id1" is displayed and otherwise article with "id2". | |
↳ contentlist | List of articles in use | |
↳ content | Article | |
↳ @id | ID of article | |
↳ fields | List of all article fields | |
↳ title | varchar(255) | Title |
↳ opener | text | Teaser text |
↳ media | int | ID of teaser picture listed in data->medialist->media |
↳ detailurl | varchar(255) | URL of Click-Through-Link |
↳ detail | text | Landingpage text if Click-Through-Link does not link somewhere else |
↳ custom1..10 | depends on @type | Value of custom field (@type see custom newsletter-fields) |
↳ medialist | List of pictures in use | |
↳ media | Picture | |
↳ @id | int | ID of picture |
↳ name | varchar(255) | Name |
↳ url | URL | |
↳ size | int | File size in bytes |
↳ type | gif,jpg,png | |
↳ width | int | Width in pixels |
↳ height | int | Height in pixels |
↳ copyright | text | Copyright text |
↳ alttext | text | Alt text |