The following SOAP methods are provided specifically for interaction with e-mailings.
Methods
addArticles
Add articles to a mailing template or modify existing articles.
EvalancheMailingTemplateArticles[] addArticles( int mailing_template_id, int id, int article_id, int targetgroup_id, int html_preset_id, int text_preset_id, int landingpage_preset_id, int pdf_preset_id, int mobile_preset_id, int sort_pos, int slot )
Parameters
- int mailing_template_id: Id of the mailing template
- int id: Id of the article reference of the article in the mailing. Necessary if an article reference already in the direct mailing template is to be changed. If the ID is 0 or not available, the article is set to a new article reference.
- int article_id: Id of the article
- int targetgroup_id: Id of the target group, if the article is to be visible only to a limited extent.
- int html_preset_id: Id of the article template for EMAIL/HTML
- int text_preset_id: Id of the article template for TEXT
- int landingpage_preset_id: Id of the article template for LP/HTML
- int pdf_preset_id: Id of the article template for PDF
- int mobile_preset_id: Id of the article template for WEB/MOBILE
- int sort_pos:
- int slot: Id of the slot
Return value
- EvalancheMailingtemplateArticles: Object (SOAP) or array with the following attributes:
- int id: Id of the article reference of the article in the mailing.
- int article_id: Id of the article
- int targetgroup_id: Id of the target group, if the article is to be visible only to a limited extent.
- int html_preset_id: Id of the article template for EMAIL/HTML
- int text_preset_id: Id of the article template for TEXT
- int landingpage_preset_id: Id of the article template for LP/HTML
- int pdf_preset_id: Id of the article template for PDF
- int mobile_preset_id: Id of the article template for WEB/MOBILE
- int sort_pos:
- int slot: Id of the slot
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:addArticles>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<articles> <!--Zero or more
repetitions:--> <item>
<!
--You may enter the following 10 items in any order--> <id>ARTICLE_MAILING_ID/0</id>
<article_id>ARTICLE_ID</article_id>
<targetgroup_id>
TARGETGROUP_ID</targetgroup_id> <html_preset_id>ARTICLE_TEMPLATE_HTML/0</html_preset_id>
<text_preset_id>ARTICLE_TEMPLATE_TEXT/0</text_preset_id>
<landingpage_preset_id>ARTICLE_TEMPLATE_LP/0</landingpage_preset_id> <pdf_preset_id>ARTICLE_TEMPLATE_PDF/0</pdf_preset_id>
<mobile_preset_id>
ARTICLE_TEMPLATE_WEBMOBILE/0</mobile_preset_id> <sort_pos>SORT_POS</sort_pos>
<slot>SLOT_ID</slot>
</item> </articles> </mail:
addArticles> </soapenv
:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
addArticlesResponse> <addArticlesResult>
<item> <id>ARTICLE_MAILING_ID/0</id>
<article_id>ARTICLE_ID</article_id>
targetgroup_id>TARGETGROUP_ID</targetgroup_id> <html_preset_id>ARTICLE_TEMPLATE_HTML/0</html_preset_id>
<text_preset_id>ARTICLE_TEMPLATE_TEXT/0<
/text_preset_id> <landingpage_preset_id>ARTICLE_TEMPLATE_LP/0</landingpage_preset_id>
<pdf_preset_id>ARTICLE_TEMPLATE_PDF/0</pdf_preset_id>
<mobile_preset_id>ARTICLE_TEMPLATE_WEBMOBILE/0</mobile_preset_id> <sort_pos>SORT_POS</sort_pos>
<slot>SLOT_ID</slot> </item>
[.
..]</SOAP-ENV
:Envelope>
addSlot
Inserts a slot in a mailing template.
EvalancheMailingtemplateSlots[] getImpressions( int mailing_template_id, int slot_number )
Parameters
- int mailing_template_id: Id of the mailing template
- int slot_number: Id of the new slot
Return value
- EvalancheMailingSlot: List of objects with the following attributes:
- int id: Id of the added slot
- string name: Default name of the added slot
- int slot_number: Id of the added slot
- int sort_type_id: Id of slot sorting
- int sort_type_value: Value of the slot sort order (not equal to 0 if top-x sorting was selected)
- EvalancheMailingTemplateSlotItems[]:
- int article_type_id: Id of the article type
- email_article_template_id: Id of the article template for EMAIL/HTML
- text_article_template_id: Id of the article template for TEXT
- landingpage_article_template_id: Id of the article template for LANDINGPAGE
- pdf_article_template_id: Id of the article template for PDF
- web_article_template_id: Id of the article template for WEB/MOBILE
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
addSlot> <mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<slot_number>SLOT_NUMBER</slot_number>
</mail:addSlot> </soapenv:
Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
addSlotResponse> <addSlotResult>
<id>SLOT_ID</id>
<name>SLOT_NAME</name>
<slot_number>SLOT_NUMBER</slot_number>
<sort_type_id>SORT_TYPE_ID</sort_type_id>
<sort_type_value>SORT_TYPE_VALUE</sort_type_value> <items>
<item> <article_type_id>ARTICLE_TYPE_ID</article_type_id>
<email_article_template_id>ARTICLE_TEMPLATE_ID<
/email_article_template_id> <text_article_template_id>ARTICLE_TEMPLATE_ID</text_article_template_id>
<landingpage_article_template_id>ARTICLE_TEMPLATE_ID</landingpage_article_template_id>
<
pdf_article_template_id>ARTICLE_TEMPLATE_ID</pdf_article_template_id> <web_article_template_id>ARTICLE_TEMPLATE_ID</web_article_template_id>
</item> </items> </addSlotResult>
</ns1
:
addSlotResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
addTemplatesToSlot
Inserts article templates into the standard article template configuration, existing slots.
EvalancheMailingTemplateSlot[] addTemplatesToSlots( int mailing_template_id, int slot_id, int[] templateSlotData[] )
Parameters
- int mailing_template_id: Id of the mailing template
- int slot_id: Id of the slot
- EvalancheMailingTemplateSlotData
- int key: Id of the article template type
- 1 = EMAIL / HTML
- 2 = PDF
- 3 = TEXT
- 4 = WEB / MOBILE
- 5 = LANDING PAGE
- int Value: Id of the article template
- int key: Id of the article template type
Return value
- EvalancheMailingTemplateSlotData[]: List of objects with the following attributes:
- int article_type_id: Id of the article type (fallback = 0)
- int email_article_template_id: Id of the article template for EMAIL/HTML
- int text_article_template_id: Id of article Template for TEXT
- int landingpage_article_template_id: Id of article template for LANDINGPAGE
- int pdf_article_template_id: Id of article template for PDF
- int web_article_template_id: Id of the article template for WEB/MOBILE
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
addTemplatesToSlot> <mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<slot_id>SLOT_ID</slot_id>
<data> <items> <!
--Zero or more repetitions:--> <item>
<!--You
may enter the following 2 items in any order--> <key>ARTICLE_TEMPLATE_TYPE_ID</key>
<value>ARTICLE_TEMPLATE_ID</value>
</item> [.
..]
</items> [...] </data>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
</mail:addTemplatesToSlot>
</soapenv:Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
addTemplatesToSlotResponse> <addTemplatesToSlotResult>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
<email_article_template_id>
EMAIL_ARTICLE_TEMPLATE_ID</email_article_template_id> <text_article_template_id>TEXT_ARTICLE_TEMPLATE_ID</text_article_template_id>
<
landingpage_article_template_id>LANDINGPAGE_ARTICLE_TEMPLATE_ID</landingpage_article_template_id> <pdf_article_template_id>PDF_ARTICLE_TEMPLATE_ID<
/pdf_article_template_id> <web_article_template_id>WEB_ARTICLE_TEMPLATE_ID</web_article_template_id>
</addTemplatesToSlotResult>
</ns1:
addTemplatesToSlotResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
applyTemplate
Applies a mailing template to a list of e-mailings.
EvalancheMailingTemplate applyTemplate( int mailing_template_id, int[] mailing_ids )
Parameters
- int mailing_template_id: Id of dispatch
- int[] mailing__id: List of eMailing Ids
Return value
- bool: In case of success true
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv:
Body> <mail:applyTemplate>
<mailing_template_id>MAILIGN_TEMPLATE_ID</mailing_template_id>
<mailing_ids> <!
--Zero or more repetitions:--> <item>MAILING_ID</item>
[...] </mailing_ids>
</mail:applyTemplate>
</soapenv:Body> </soapenv:
Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
applyTemplateResponse> <applyTemplateResult>true</applyTemplateResult>
</ns1:applyTemplateResponse>
</SOAP-ENV:Body> </SOAP-ENV:Envelope>
getAll
Outputs all mailing templates of a client.
EvalancheMailingTemplates getAll( int mandator_id )
Parameters
- int mandator_id: Id of the client
Return value
- EvalancheMailingTemplates[]: List of data of the updated eMailings
- string url: URL of the e-mailing
- int type_id: Type-ID of the e-mailing
- int category_id: Folder ID of the e-mailing
- int customer_id: ID of the client
- int id: ID of the e-mailing
- string name: Name of the e-mailing
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getAll> <mandator_id>MANDATOR_ID</mandator_id>
</mail:getAll> </soapenv:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getAllResponse> <getAllResult>
<item> <url>MAILING_URL</url>
<type_id>MAILINT_TYPE</type_id>
<category_id>CATEGORY_ID<
/category_id> <customer_id>MANDATOR_ID</customer_id>
<id>MAILING_ID</id>
<name>MAILING_NAME</name> </item>
[.
...]
</getAllResult> </ns1
:getAllResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope>
getArticles
Outputs all preconfigured articles of the mailing template.
EvalancheMailingTemplateArticles[] getStatus( int mailing_template_id )
Parameters
- int mailing_template_id: Id of the mailing template
Return value
- EvalancheMailingTemplateArticles[]: List of objects (SOAP) or arrays with the following attributes:
- int id: Id of the article reference in the mailing template
- int article_id: Id of the article
- int targetgroup_id: Id of the restriction target groups
- int html_preset_id: Id of the article template EMAIL/HTML
- int text_preset_id: Id of article Template for TEXT
- int landingpage_preset_id: Id of article template for LANDINGPAGE
- int pdf_preset_id: Id of article template for PDF
- int mobile_preset_id: Id of the article template for WEB/MOBILE
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getArticles>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
</mail:
getArticles> </soapenv
:Body> </soapenv
:Envelope></soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getArticlesResponse> <getArticlesResult>
<item> <id>ARTICLE_UNIQUE</id>
<article_id>ARTICLE_ID</article_id>
<
targetgroup_id>TARGETGROUP_ID</targetgroup_id> <html_preset_id>HTML_PRESET_ID</html_preset_id>
<text_preset_id>TEXT_PRESET_ID<
/text_preset_id> <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
<pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
<mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id> <sort_pos>SORT_POS</sort_pos>
<slot>SLOT_ID</slot> </item>
[.
...]
</getArticlesResult> </ns1
:getArticlesResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope>
getByCategory
Outputs all mailing templates in a folder.
EvalancheMailingTemplates[] getByCategory( int category_id )
Parameters
- int category_id: Id of the folder
Return value
- EvalancheMailingTemplates[]: List of objects with the following attributes:
- string url: URL of the mailing template
- int type_id: Type-ID of the mailing template
- int category_id: Folder ID of the mailing template
- int customer_id: ID of the mailing template
- int id: ID of the mailing template
- string name: Name of the mailing template
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getByCategory>
<category_id>CATEGORY_ID</category_id>
</mail:
getByCategory> </soapenv
:Body> </soapenv
:Envelope> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getByCategoryResponse> <getByCategoryResult>
<item> <url>MAILING_TEMPLATE_URL</url>
<type_id>MAILING_TEMPLATE_TYPE_ID</type_id>
<category_id>CATEGORY_ID<
/category_id> <customer_id>CUSTOMER_ID</customer_id>
<id>MAILING_TEMPLATE_ID</id>
<name>MAILING_TEMPLATE_NAME</name>
</item> </getByCategoryResult> </ns1:
getByCategoryResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope></SOAP-ENV:Envelope>
getByExternalId
Outputs all direct mailing templates with a given EXTERNAL_ID. Currently no usage scenario, since External ID does not yet exist.
EvalancheMailingTemplates[] getByExternalId ( string external_id )
Parameters
- string external_id: Mailing templates
Return value
- EvalancheMailingTemplates[]: List of objects with the following attributes:
- string url: URL of the mailing template
- int type_id: Type-ID of the mailing template
- int category_id: Folder ID of the mailing template
- int customer_id: ID of the mailing template
- int id: ID of the mailing template
- string name: Name of the mailing template
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getByExternalId>
<external_id>EXTERNAL_ID</external_id>
</mail:getByExternalId> </soapenv
:Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getByExternalIdResponse> <getByExternalIdResult>
<item> <url>MAILING_TEMPLATE_URL</url>
<type_id>MAILING_TEMPLATE_TYPE_ID</type_id>
<category_id>CATEGORY_ID<
/category_id> <customer_id>CUSTOMER_ID</customer_id>
<id>MAILING_TEMPLATE_ID</id>
<name>MAILING_TEMPLATE_NAME</name>
</item> </getByExternalIdResult> </ns1
:
getByExternalIdResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope></SOAP-ENV:Envelope>
getConfiguration
Selects a mailing template based on the ID.
EvalancheMailingTemplate getConfiguration ( int mailing_template_id )
Parameters
- int mailing_template_id: Id of the mailing template
Return value
- EvalancheMailingTemplateConfiguration: Object with the following attributes:
- string external_trackingcode: Value of the field External tracking code
- string campaign_id: Value of the field Campaign Id
- string externalxml_url: Value of the field URL to external XML
- string salutation_female: Value of the field Individualised form of address: Ms
- string salutation_male: Value of the field Individualized salutation: Mr
- string salutation_company: Value of the field Individualized salutation: Company
- string salutation_family: Value of the field Individualized form of address: Family
- string salutation_other: Value of the field Individualized salutation: Not specified
- string sender_email: Value of the field Return address
- string sender_name: Value of the field Sender
- string reply_email: Value of the field Reply to
- string reply_name: Value of the field reply to
- string grant_url: Value of the field Confirmation URL for entries
- string revoke_url: Value of the field Confirmation URL in case of a cancellation
- string inputfield_0: Value of the field INPUT FIELD 0
- string inputfield_1: Value of the field INPUT FIELD 1
- string inputfield_2: Value of the field INPUTFIELD 2
- string inputfield_3: Value of the field INPUTFIELD 3
- string inputfield_4: Value of the field INPUTFIELD 4
- string inputfield_5: Value of the field INPUT FIELD 5
- string inputfield_6: Value of the field INPUTFIELD 6
- string inputfield_7: Value of the field INPUTFIELD 7
- string inputfield_8: Value of the field INPUTFIELD 8
- string inputfield_9: Value of the field INPUT FIELD 9
- string textarea_0: Value of the field TEXTAREA 0
- string textarea_1: Value of the field TEXTAREA 1
- string textarea_2: Value of the field TEXTAREA 2
- string textarea_3: Value of the field TEXTAREA 3
- string textarea_4: Value of the field TEXTAREA 4
- string textarea_5: Value of the field TEXTAREA 5
- string textarea_6: Value of the field TEXTAREA 6
- string textarea_7: Value of the field TEXTAREA 7
- string textarea_8: Value of the field TEXTAREA 8
- string textarea_9: Value of the field TEXTAREA 9
- string htmlarea_0: Value of the field HTMLAREA 0 - Valid XHTML is mandatory!
- string htmlarea_1: Value of the field HTMLAREA 1 - Valid XHTML is mandatory!
- string htmlarea_2: Value of the field HTMLAREA 2 - Valid XHTML is mandatory!
- string htmlarea_3: Value of the field HTMLAREA 3 - Valid XHTML is mandatory!
- string htmlarea_4: Value of the field HTMLAREA 4 - Valid XHTML is mandatory!
- string htmlarea_5: Value of the field HTMLAREA 5 - Valid XHTML is mandatory!
- string htmlarea_6: Value of the field HTMLAREA 6 - Valid XHTML is mandatory!
- string htmlarea_7: Value of the field HTMLAREA 7 - Valid XHTML is mandatory!
- string htmlarea_8: Value of the field HTMLAREA 8 - Valid XHTML is mandatory!
- string htmlarea_9: Value of the field HTMLAREA 9 - Valid XHTML is mandatory!
Required rights
Display template
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getConfiguration>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
</mail:
getConfiguration> </soapenv
:Body> </soapenv
:Envelope></soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getConfigurationResponse> <getConfigurationResult>
<external_trackingcode/>
<campaign_id/>
<externalxml_url/> <salutation_female/>
<salutation_male/>
<salutation_company/>
<salutation_family/>
<salutation_other/> <sender_email>
SENDER_NAME</sender_email> <sender_name>SENDER_NAME</sender_name>
<reply_name>REPLY_NAME</reply_name>
<
reply_email>REPLY_EMIL</reply_email> <grant_url>GRANT_URL</grant_url>
<revoke_url>REVOKE_URL</revoke_url>
<
inputfield_0>INPUTFIELD_CONTENT</inputfield_0> <inputfield_1>INPUTFIELD_CONTENT</inputfield_1>
<inputfield_2>
INPUTFIELD_CONTENT</inputfield_2> <inputfield_3>INPUTFIELD_CONTENT</inputfield_3>
<inputfield_4>INPUTFIELD_CONTENT</inputfield_4>
<inputfield_5>INPUTFIELD_CONTENT</inputfield_5> <inputfield_6>INPUTFIELD_CONTENT</inputfield_6>
<inputfield_7>
INPUTFIELD_CONTENT</inputfield_7> <inputfield_8>INPUTFIELD_CONTENT</inputfield_8>
<inputfield_9>INPUTFIELD_CONTENT
/inputfield_9> <textarea_0>TEXTAREA_CONTENT</textarea_0>
<textarea_1>TEXTAREA_CONTENT</textarea_1>
<textarea_2>
TEXTAREA_CONTENT</textarea_2> <textarea_3>TEXTAREA_CONTENT</textarea_3>
<textarea_4>TEXTAREA_CONTENT</textarea_4>
<textarea_5>TEXTAREA_CONTENT</textarea_5> <textarea_6>TEXTAREA_CONTENT</textarea_6>
<textarea_7>TEXTAREA_CONTENT<
/textarea_7> <textarea_8>TEXTAREA_CONTENT</textarea_8>
<textarea_9>TEXTAREA_CONTENT</textarea_9>
<
htmlarea_0>HTMLAREA_CONTENT</htmlarea_0> <htmlarea_1>HTMLAREA_CONTENT</htmlarea_1>
<htmlarea_2>HTMLAREA_CONTENT
/htmlarea_2> <htmlarea_3>HTMLAREA_CONTENT</htmlarea_3>
<htmlarea_4>HTMLAREA_CONTENT</htmlarea_4>
<htmlarea_5>
HTMLAREA_CONTENT</htmlarea_5> <htmlarea_6>HTMLAREA_CONTENT</htmlarea_6>
<htmlarea_7>HTMLAREA_CONTENT</htmlarea_7>
<
htmlarea_8>HTMLAREA_CONTENT</htmlarea_8> <htmlarea_9>HTMLAREA_CONTENT</htmlarea_9>
</getConfigurationResult>
</ns1:
getConfigurationResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope></SOAP-ENV:Envelope>
getSlotConfiguration
Read slot configuration of a mailing template
EvalancheMailingTemplateSlotConfiguration getSlotConfiguration( int mailing_template_id )
Parameters
- int mailing_template_id: Id of the mailing template
Return value
- EvalancheSlotConfiguration Object with the following attributes:
- int id: Id of the slot
- string name: Name of the slot
- int slot_number: Position of the slot
- int sort_type_id: Id of the slot sorting
- int sort_type_value: Value of the slot sort order
- EvalancheSlotItems[]: Object with the following attributes
- int article_type_id: Id of the article type (fallback = 0)
- int email_article_template_id: Id of the article template EMAIL/HTML
- int text_article_template_id: Id of the article template TEXT
- int landingpage_article_template_id: Id of the article template LANDINGPAGE
- int pdf_article_template_id: Id of the article template PDF
- int web_article_template_id: Id of the article template WEB
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getSlotConfiguration>
<mailing_template_id>28</mailing_template_id>
</mail:getSlotConfiguration> </soapenv
:Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getSlotConfigurationResponse> <getSlotConfigurationResult>
<items> <item>
<id>1</id>
<name>SLOT_NAME</name>
<slot_number>SLOT_NUMBER</slot_number>
<sort_type_id>SORT_TYPE_ID<
/sort_type_id> <sort_type_value>SORT_TYPE_VALUE</sort_type_value>
<items> <item>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
<email_article_template_id>EMAIL_ARTICLE_TEMPLATE_ID<
/email_article_template_id> <text_article_template_id>TEXT_ARTICLE_TEMPLATE_ID</text_article_template_id>
<landingpage_article_template_id>LANDINGPAGE_ARTICLE_TEMPLATE_ID</landingpage_article_template_id>
<pdf_article_template_id>PDF_ARTICLE_TEMPLATE_ID</pdf_article_template_id> <web_article_template_id>WEB_ARTICLE_TEMPLATE_ID</web_article_template_id>
</item> </items> </item>
[.
..]
</getSlotConfigurationResult> </ns1
:getSlotConfigurationResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope> </SOAP-ENV
:Envelope>
getSources
Set configuration of a direct mailing
bool getSources( int mailing_template_id )
Parameters
- int mailing_template_id: Id of the mailing template
Return value
- string email: Source text of the EMAIL/HTML template
- string text: Source text of the TEXT template
- string web: Source code of the WEB/MOBILE template
- string pdf: Source code of the PDF template
- string landingpage: Source code of the LANDINGPAGE template
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:getSources>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
</mail:getSources> </soapenv:
Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
getSourcesResponse> <getSourcesResult>
<email>EMAIL/HTML
SOURCE</email> <text>TEXT SOURCE</text>
<web>
WEB SOURCE</web> <pdf>PDF
SOURCE</pdf> <landingpage>LANDINGPAGE
SOURCE</landingpage> </getSourcesResult> </ns1:
getSourcesResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
removeAllArticles
Removes all standard articles from a mailing template
bool removeAllArticles( int mailing_template_id )
Parameters
- int mailing_template_id: Id of the mailing template
Return value
- bool: true if successful
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:removeAllArticles>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
</mail:removeAllArticles> </soapenv
:Body> </soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
removeAllArticlesResponse> <removeAllArticlesResult> TRUE</removeAllArticlesResult>
</ns1:removeAllArticlesResponse>
</SOAP-ENV:Body> </SOAP-ENV:Envelope>
removeArticles
Removes articles from a mailing template using your reference IDs.
bool removeArticles( int mailing_template_id, int[] reference_ids )
Parameters
- int mailing_template_id: Id of the mailing template
- int[] reference_ids: Id of the article references
Return value
- EvalancheMailingTemplateArticles[]: List of objects with the following attributes:
- int id: Id of the article reference in the mailing template
- int article_id: Id of the article
- int targetgroup_id: Id of the restriction target groups
- int html_preset_id: Id of the article template EMAIL/HTML
- int text_preset_id: Id of article Template for TEXT
- int landingpage_preset_id: Id of article template for LANDINGPAGE
- int pdf_preset_id: Id of article template for PDF
- int mobile_preset_id: Id of the article template for WEB/MOBILE
Required rights
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv:
Body> <mail:removeArticles>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<reference_ids> <!
--Zero or more repetitions:--> <item>ARTICLE_REFERENCE_ID</item>
[...] </reference_ids>
</mail:removeArticles>
</soapenv:Body> </soapenv:
Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
removeArticlesResponse> <removeArticlesResult>
<item> <id>ARTICLE_UNIQUE</id>
<article_id>ARTICLE_ID</article_id>
<
targetgroup_id>TARGETGROUP_ID</targetgroup_id> <html_preset_id>HTML_PRESET_ID</html_preset_id>
<text_preset_id>TEXT_PRESET_ID<
/text_preset_id> <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
<pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
<mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id> <sort_pos>SORT_POS</sort_pos>
<slot>SLOT_ID</slot> </item>
[.
...]
</removeArticlesResult> </ns1
:removeArticlesResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope>
removeSlot
Removes a slot from a mailing template
EvalancheMailingTemplateSlots removeSlot( int mailing_template_id, int slot_id )
Parameters
- int mailing_template_id: Id of the mailing template
- int slot_id: Id of the slot to be deleted
Return value
- no return
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
removeSlot> <mailing_template_id>mailing_template_id</mailing_template_id>
<slot_id>SLOT_ID</slot_id>
</mail:removeSlot> </soapenv
:Body> </soapenv:Envelope>
...
removeTemplateFromSlot
Removes a standard article template from a slot
EvalancheMailingTemplateSlots[] removeTemplateFromSlot( int template_mailing_id, int slot_id, int template_type, int article_type_id )
Parameters
- int mailing_template_id: Id of the mailing template
- int slot_id: Id of the slot
- int template_type: Id of the template type
- int article_type_id: Id of the article type
Return value
- None
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
removeTemplateFromSlot> <mailing_template_id>87</mailing_template_id>
<slot_id>13</slot_id>
<template_type>1</template_type>
<article_type_id>0</article_type_id> </mail
:
removeTemplateFromSlot> </soapenv
:Body> </soapenv
:Envelope>
...
setConfiguration
Sets default contents of a mailing template
EvalancheMailingTemplateConfiguration removeAllArticles( int mailing_template_id, configuration[] configuration )
Parameters
- int mailing_template_id: Id of the mailing template
- EvalancheMailingTemplateConfiguration[]:
- string external_trackingcode: Value of the field External tracking code
- string campaign_id: Value of the field Campaign Id
- string externalxml_url: Value of the field URL to external XML
- string salutation_female: Value of the field Individualised form of address: Ms
- string salutation_male: Value of the field Individualized salutation: Mr
- string salutation_company: Value of the field Individualized salutation: Company
- string salutation_family: Value of the field Individualized form of address: Family
- string salutation_other: Value of the field Individualized salutation: Not specified
- string sender_email: Value of the field Return address
- string sender_name: Value of the field Sender
- string reply_email: Value of the field Reply to
- string reply_name: Value of the field reply to
- string grant_url: Value of the field Confirmation URL for entries
- string revoke_url: Value of the field Confirmation URL in case of a cancellation
- string inputfield_0: Value of the field INPUT FIELD 0
- string inputfield_1: Value of the field INPUT FIELD 1
- string inputfield_2: Value of the field INPUTFIELD 2
- string inputfield_3: Value of the field INPUTFIELD 3
- string inputfield_4: Value of the field INPUTFIELD 4
- string inputfield_5: Value of the field INPUT FIELD 5
- string inputfield_6: Value of the field INPUTFIELD 6
- string inputfield_7: Value of the field INPUTFIELD 7
- string inputfield_8: Value of the field INPUTFIELD 8
- string inputfield_9: Value of the field INPUT FIELD 9
- string textarea_0: Value of the field TEXTAREA 0
- string textarea_1: Value of the field TEXTAREA 1
- string textarea_2: Value of the field TEXTAREA 2
- string textarea_3: Value of the field TEXTAREA 3
- string textarea_4: Value of the field TEXTAREA 4
- string textarea_5: Value of the field TEXTAREA 5
- string textarea_6: Value of the field TEXTAREA 6
- string textarea_7: Value of the field TEXTAREA 7
- string textarea_8: Value of the field TEXTAREA 8
- string textarea_9: Value of the field TEXTAREA 9
- string htmlarea_0: Value of the field HTMLAREA 0 - Valid XHTML is mandatory!
- string htmlarea_1: Value of the field HTMLAREA 1 - Valid XHTML is mandatory!
- string htmlarea_2: Value of the field HTMLAREA 2 - Valid XHTML is mandatory!
- string htmlarea_3: Value of the field HTMLAREA 3 - Valid XHTML is mandatory!
- string htmlarea_4: Value of the field HTMLAREA 4 - Valid XHTML is mandatory!
- string htmlarea_5: Value of the field HTMLAREA 5 - Valid XHTML is mandatory!
- string htmlarea_6: Value of the field HTMLAREA 6 - Valid XHTML is mandatory!
- string htmlarea_7: Value of the field HTMLAREA 7 - Valid XHTML is mandatory!
- string htmlarea_8: Value of the field HTMLAREA 8 - Valid XHTML is mandatory!
- string htmlarea_9: Value of the field HTMLAREA 9 - Valid XHTML is mandatory!
Return value
- EvalancheMailingTemplateConfiguration: List with the following attributes:
- string external_trackingcode: Value of the field External tracking code
- string campaign_id: Value of the field Campaign Id
- string externalxml_url: Value of the field URL to external XML
- string salutation_female: Value of the field Individualised form of address: Ms
- string salutation_male: Value of the field Individualized salutation: Mr
- string salutation_company: Value of the field Individualized salutation: Company
- string salutation_family: Value of the field Individualized form of address: Family
- string salutation_other: Value of the field Individualized salutation: Not specified
- string sender_email: Value of the field Return address
- string sender_name: Value of the field Sender
- string reply_email: Value of the field Reply to
- string reply_name: Value of the field reply to
- string grant_url: Value of the field Confirmation URL for entries
- string revoke_url: Value of the field Confirmation URL in case of a cancellation
- string inputfield_0: Value of the field INPUT FIELD 0
- string inputfield_1: Value of the field INPUT FIELD 1
- string inputfield_2: Value of the field INPUTFIELD 2
- string inputfield_3: Value of the field INPUTFIELD 3
- string inputfield_4: Value of the field INPUTFIELD 4
- string inputfield_5: Value of the field INPUT FIELD 5
- string inputfield_6: Value of the field INPUTFIELD 6
- string inputfield_7: Value of the field INPUTFIELD 7
- string inputfield_8: Value of the field INPUTFIELD 8
- string inputfield_9: Value of the field INPUT FIELD 9
- string textarea_0: Value of the field TEXTAREA 0
- string textarea_1: Value of the field TEXTAREA 1
- string textarea_2: Value of the field TEXTAREA 2
- string textarea_3: Value of the field TEXTAREA 3
- string textarea_4: Value of the field TEXTAREA 4
- string textarea_5: Value of the field TEXTAREA 5
- string textarea_6: Value of the field TEXTAREA 6
- string textarea_7: Value of the field TEXTAREA 7
- string textarea_8: Value of the field TEXTAREA 8
- string textarea_9: Value of the field TEXTAREA 9
- string htmlarea_0: Value of the field HTMLAREA 0 - Valid XHTML is mandatory!
- string htmlarea_1: Value of the field HTMLAREA 1 - Valid XHTML is mandatory!
- string htmlarea_2: Value of the field HTMLAREA 2 - Valid XHTML is mandatory!
- string htmlarea_3: Value of the field HTMLAREA 3 - Valid XHTML is mandatory!
- string htmlarea_4: Value of the field HTMLAREA 4 - Valid XHTML is mandatory!
- string htmlarea_5: Value of the field HTMLAREA 5 - Valid XHTML is mandatory!
- string htmlarea_6: Value of the field HTMLAREA 6 - Valid XHTML is mandatory!
- string htmlarea_7: Value of the field HTMLAREA 7 - Valid XHTML is mandatory!
- string htmlarea_8: Value of the field HTMLAREA 8 - Valid XHTML is mandatory!
- string htmlarea_9: Value of the field HTMLAREA 9 - Valid XHTML is mandatory!
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
setConfiguration> <mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<external_trackingcode/>
<campaign_id/> <externalxml_url/>
<salutation_female/>
<salutation_male/>
<salutation_company/>
<salutation_family/>
salutation_other/> <sender_email>SENDER_NAME</sender_email>
<sender_name>SENDER_NAME</sender_name>
<reply_name>
REPLY_NAME</reply_name> <reply_email>REPLY_EMAIL</reply_email>
<grant_url>GRANT_URL</grant_url>
<revoke_url>REVOKE_URL<
/revoke_url> <inputfield_0>INPUTFIELD_CONTENT</inputfield_0>
<inputfield_1>INPUTFIELD_CONTENT</inputfield_1>
<inputfield_2>
INPUTFIELD_CONTENT</inputfield_2> <inputfield_3>INPUTFIELD_CONTENT</inputfield_3>
<inputfield_4>INPUTFIELD_CONTENT
/inputfield_4> <inputfield_5>INPUTFIELD_CONTENT</inputfield_5>
<inputfield_6>INPUTFIELD_CONTENT</inputfield_6>
<inputfield_7>INPUTFIELD_CONTENT</inputfield_7> <inputfield_8>INPUTFIELD_CONTENT</inputfield_8>
<inputfield_9>
INPUTFIELD_CONTENT</inputfield_9> <textarea_0>TEXTAREA_CONTENT</textarea_0>
<textarea_1>TEXTAREA_CONTENT</textarea_1>
<textarea_2>TEXTAREA_CONTENT</textarea_2> <textarea_3>TEXTAREA_CONTENT</textarea_3>
<textarea_4>TEXTAREA_CONTENT<
/textarea_4> <textarea_5>TEXTAREA_CONTENT</textarea_5>
<textarea_6>TEXTAREA_CONTENT</textarea_6>
<textarea_7>
TEXTAREA_CONTENT</textarea_7> <textarea_8>TEXTAREA_CONTENT</textarea_8>
<textarea_9>TEXTAREA_CONTENT</textarea_9>
<
htmlarea_0>HTMLAREA_CONTENT</htmlarea_0> <htmlarea_1>HTMLAREA_CONTENT</htmlarea_1>
<htmlarea_2>HTMLAREA_CONTENT</htmlarea_2>
<htmlarea_3>HTMLAREA_CONTENT</htmlarea_3> <htmlarea_4>HTMLAREA_CONTENT</htmlarea_4>
<htmlarea_5>HTMLAREA_CONTENT
/htmlarea_5> <htmlarea_6>HTMLAREA_CONTENT</htmlarea_6>
<htmlarea_7>HTMLAREA_CONTENT</htmlarea_7>
<htmlarea_8>
HTMLAREA_CONTENT</htmlarea_8> <htmlarea_9>HTMLAREA_CONTENT</htmlarea_9>
<overwrite>OVERWRITE</overwrite>
</mail:
setConfiguration> </soapenv
:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
setConfigurationResponse> <setConfigurationResult>
<external_trackingcode/>
<campaign_id/>
<externalxml_url/> <salutation_female/>
<salutation_male/>
<salutation_company/>
<salutation_family/>
<salutation_other/> <sender_email>
SENDER_NAME</sender_email> <sender_name>SENDER_NAME</sender_name>
<reply_name>REPLY_NAME</reply_name>
<
reply_email>REPLY_EMIL</reply_email> <grant_url>GRANT_URL</grant_url>
<revoke_url>REVOKE_URL</revoke_url>
<
inputfield_0>INPUTFIELD_CONTENT</inputfield_0> <inputfield_1>INPUTFIELD_CONTENT</inputfield_1>
<inputfield_2>
INPUTFIELD_CONTENT</inputfield_2> <inputfield_3>INPUTFIELD_CONTENT</inputfield_3>
<inputfield_4>INPUTFIELD_CONTENT</inputfield_4>
<inputfield_5>INPUTFIELD_CONTENT</inputfield_5> <inputfield_6>INPUTFIELD_CONTENT</inputfield_6>
<inputfield_7>
INPUTFIELD_CONTENT</inputfield_7> <inputfield_8>INPUTFIELD_CONTENT</inputfield_8>
<inputfield_9>INPUTFIELD_CONTENT
/inputfield_9> <textarea_0>TEXTAREA_CONTENT</textarea_0>
<textarea_1>TEXTAREA_CONTENT</textarea_1>
<textarea_2>
TEXTAREA_CONTENT</textarea_2> <textarea_3>TEXTAREA_CONTENT</textarea_3>
<textarea_4>TEXTAREA_CONTENT</textarea_4>
<textarea_5>TEXTAREA_CONTENT</textarea_5> <textarea_6>TEXTAREA_CONTENT</textarea_6>
<textarea_7>TEXTAREA_CONTENT<
/textarea_7> <textarea_8>TEXTAREA_CONTENT</textarea_8>
<textarea_9>TEXTAREA_CONTENT</textarea_9>
<
htmlarea_0>HTMLAREA_CONTENT</htmlarea_0> <htmlarea_1>HTMLAREA_CONTENT</htmlarea_1>
<htmlarea_2>HTMLAREA_CONTENT
/htmlarea_2> <htmlarea_3>HTMLAREA_CONTENT</htmlarea_3>
<htmlarea_4>HTMLAREA_CONTENT</htmlarea_4>
<htmlarea_5>
HTMLAREA_CONTENT</htmlarea_5> <htmlarea_6>HTMLAREA_CONTENT</htmlarea_6>
<htmlarea_7>HTMLAREA_CONTENT</htmlarea_7>
<
htmlarea_8>HTMLAREA_CONTENT</htmlarea_8> <htmlarea_9>HTMLAREA_CONTENT</htmlarea_9>
</setConfigurationResult>
</ns1:
setConfigurationResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
setSource
Overwrites the design source texts of the mailing template
EvalancheMailingTemplateSources setSource( int mailing_template_id, sources[] sources, bool overwrite )
Parameters
- int mailing_template_id: Id of the mailing template
- sources[] sources: List with the following attributes:
- string email: Source code for EMAIL / HTML
- string text: Source code for TEXT
- string web: Source code for WEB / MOBILE
- string pdf: Source code for PDF
- string landingpage: Source code for LANDINGPAGE
- bool overwrite: Determines whether empty values should also be overwritten
Return value
- sources[] sources: List with the following attributes:
- string email: Source code for EMAIL / HTML
- string text: Source code for TEXT
- string web: Source code for WEB / MOBILE
- string pdf: Source code for PDF
- string landingpage: Source code for LANDINGPAGE
Required rights
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv:
Body> <mail:setSources>
<mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<sources> <!
--You may enter the following 5 items in any order--> <email></email>
<text></text> <web></web>
<pdf></pdf> <landingpage></landingpage>
</sources> <overwrite>0</overwrite>
</mail:
setSources> </soapenv
:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
setSourcesResponse> <setSourcesResult>
<email></email>
<text></text> <web></web>
<pdf></pdf> <landingpage></landingpage>
</setSourcesResult>
</ns1:
setSourcesResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
updateSlot
Updates an existing slot
EvalancheMailingTemplateSlotConfiguration updateSlot( int mailing_template_id, int slot_id, int slot_number, string name, int sort_type_id, int sort_value )
Parameters
- int mailing_template_id: Id of the mailing template
- int slot_id: Id of the slot to be updated
- int slot_numbers: new slot position
- string name: new slot name
- int sort_type_id: Slot Sorting Type-Id
- int sort_value: Value of slot sort type
Return value
- int id: Id of the slot
- string name: Name of the slot
- int slot_number: Position of the slot
- int sort_type_id: Id of the slot sorting
- int sort_type_value: Value of the slot sort order
- EvalancheSlotItems[]: Object with the following attributes
- int article_type_id: Id of the article type (fallback = 0)
- int email_article_template_id: Id of the article template EMAIL/HTML
- int text_article_template_id: Id of the article template TEXT
- int landingpage_article_template_id: Id of the article template LANDINGPAGE
- int pdf_article_template_id: Id of the article template PDF
- int web_article_template_id: Id of the article template WEB
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
updateSlot> <mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<slot_id>SLOT_ID</slot_id>
<slot_number>SLOT_NUMBER<
/slot_number> <name>SLOT_NAME</name>
<sort_type_id>SORT_TYPE_ID</sort_type_id>
<sort_value>SORT_VALUE</sort_value>
</mail:
updateSlot> </soapenv
:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
updateSlotResponse> <updateSlotResult>
<id>SLOT_ID</id>
<name>SLOT_NAME</name>
<
slot_number>SLOT_NUMBER</slot_number> <sort_type_id>SORT_TYPE_ID</sort_type_id>
<sort_type_value>
SORT_TYPE_VALUE</sort_type_value> <items>
<item> <article_type_id>ARTICLE_TYPE_ID</article_type_id>
<email_article_template_id>EMAIL_ARTICLE_TEMPLATE_ID</email_article_template_id>
<text_article_template_id>TEXT_ARTICLE_TEMPLATE_ID</text_article_template_id> <landingpage_article_template_id>LANDINGPAGE_ARTICLE_TEMPLATE_ID</landingpage_article_template_id>
<pdf_article_template_id>
PDF_ARTICLE_TEMPLATE_ID</pdf_article_template_id> <web_article_template_id>WEB_ARTICLE_TEMPLATE_ID</web_article_template_id>
</item> </items> </updateSlotResult>
</ns1:
updateSlotResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
updateSlotTemplates
Updates the article templates of an existing slot
EvalancheMailingInformation updateSlotTemplates( int mailing_template_id, int slot_id, string[] data, int article_type_id )
Parameters
- int mailing_template_id: Id of the mailing template
- EvalancheMailingTemplateSlotData
- int key: Id of the article template type
- 1 = EMAIL / HTML
- 2 = PDF
- 3 = TEXT
- 4 = WEB / MOBILE
- 5 = LANDING PAGE
- int Value: Id of the article template
- int key: Id of the article template type
- int article_type_id: Id of the article type (fallback = 0)
Return value
- EvalancheMailingTemplateSlotData[]: List of objects with the following attributes:
- int article_type_id: Id of the article type (fallback = 0)
- int email_article_template_id: Id of the article template for EMAIL/HTML
- int text_article_template_id: Id of article Template for TEXT
- int landingpage_article_template_id: Id of article template for LANDINGPAGE
- int pdf_article_template_id: Id of article template for PDF
- int web_article_template_id: Id of the article template for WEB/MOBILE
Required rights
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <soapenv
:Header/> <soapenv
:Body> <mail:
updateSlotTemplates> <mailing_template_id>MAILING_TEMPLATE_ID</mailing_template_id>
<slot_id>SLOT_ID</slot_id>
<data> <items> <!
--Zero or more repetitions:--> <item>
<!
--You may enter the following 2 items in any order--> <key>ARTICLE_TEMPLATE_TYPE_ID</key>
<value>ARTICLE_TEMPLATE_ID<
/value> </item>
</items>
</data> <article_type_id>ARTICLE_TYPE_ID</article_type_id>
</mail:
updateSlotTemplates> </soapenv
:Body> </soapenv
:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate"> <SOAP-ENV
:Body> <ns1:
updateSlotTemplatesResponse> <updateSlotTemplatesResult>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
<email_article_template_id>
EMAIL_ARTICLE_TEMPLATE_ID</email_article_template_id> <text_article_template_id>TEXT_ARTICLE_TEMPLATE_ID</text_article_template_id>
<
landingpage_article_template_id>LANDINGPAGE_ARTICLE_TEMPLATE_ID</landingpage_article_template_id> <pdf_article_template_id>PDF_ARTICLE_TEMPLATE_ID<
/pdf_article_template_id> <web_article_template_id>WEB_ARTICLE_TEMPLATE_ID</web_article_template_id>
</updateSlotTemplatesResult>
</ns1:
updateSlotTemplatesResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>