GetPromotionalMailingTypes

Initial Build	2013.01
xWeb	Web Method
Response Type	Mailing List

The GetPromotionalMailingTypes web method returns a list of promotional mailing types. When working with Email Opt Outs and Managing Mail Preferences, these codes will tell you what the various mailing types are.

Parameters

This web method has no parameters.

Response

An array of MailingList objects.

Sample Request

                <soapenv:Envelope   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"   
xmlns:ns="http://www.avectra.com/2005/">    
 <soapenv:Header>      
  <ns:AuthorizationToken>         
   <ns:Token>*******</ns:Token>       
  </ns:AuthorizationToken>   
 </soapenv:Header>   
 <soapenv:Body>      
  <ns:GetPromotionalMailingTypes/>   
 </soapenv:Body>
</soapenv:Envelope>

Sample Response

Important! The sample for this method contains sample data. Do not assume that the specific data you see on this page, particularly the keys, are the same data that will exist in the NetForum site in which you're developing an integration. Moreover, if you are developing an integration that will work against multiple netFORUM sites for multiple customers, be aware that the data for each customer, including setup data, will differ. See netFORUM Data for more.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>43f57483-0caf-4518-9bf8-5715864f0c04</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<GetPromotionalMailingTypesResponse xmlns="http://www.avectra.com/2005/">
<GetPromotionalMailingTypesResult>
<MailingList>
<primary_key>c76d2eda-d622-47d7-8f84-177ae5e5a057</primary_key>
<name>cm - mt - 01</name>
<category>cm - mlt - 01</category>
</MailingList>
<MailingList>
<primary_key>1024f008-3003-4398-a9a2-30af75e20db7</primary_key>
<name>eweb-1</name>
<category>eweb</category>
</MailingList>
<MailingList>
<primary_key>bda7dc84-5732-44fa-9fb9-3429adebf9b9</primary_key>
<name>eweb-0</name>
<category>eweb</category>
</MailingList>
<MailingList>
<primary_key>7bb97902-e4ab-4cb0-918d-3868d1709540</primary_key>
<name>cm - mt - 012</name>
<category>cm - mlt - 02</category>
</MailingList>
<MailingList>
<primary_key>047a1e12-1917-468f-af0d-6ff41cb88de9</primary_key>
<name>Membership Paper Invocie</name>
<category>eweb</category>
</MailingList>
<MailingList>
<primary_key>48d15511-2581-443e-b8ef-7ff698b28f2f</primary_key>
<name>promo with mailing list type</name>
<category>mlt</category>
</MailingList>
<MailingList>
<primary_key>2ec8fe0e-35ba-4491-aabe-823dd082c4a6</primary_key>
<name>no comm type</name>
<category>mlt</category>
</MailingList>
<MailingList>
<primary_key>6051ac28-9f82-48b3-8482-b3a925cbb332</primary_key>
<name>Test 8840</name>
<category>eweb</category>
</MailingList>
</GetPromotionalMailingTypesResult>
</GetPromotionalMailingTypesResponse>
</soap:Body>
</soap:Envelope>

JSON Method

POST /xWeb/JSON/GetPromotionalMailingTypes

DATA: JSON
{
    "GetPromotionalMailingTypes" : null
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
[
    {
        "primary_key": "bfc8729b-7e0c-4f5a-a9d7-35fd5e4b84e2",
        "name": "September Special Promo",
        "category": "Monthly Newsletter"
    },
    {
        "primary_key": "c2016fa8-0bfb-4ede-a62c-7c9c7daf13dd",
        "name": "Super Promo",
        "category": "Promotional"
    },
    {
        "primary_key": "d527e48e-ce6d-45bb-96e8-a41c3ba7e282",
        "name": "ABC Mailing Type",
        "category": "Newsletters"
    }
]

Related Web Methods

• GetSubscriptionMailingTypes - Get available subscription mailing types available.
• GetCustomerCommunicationPreference - Retrieve an individual's communication preference for a single mailing type.
• GetAllCustomerCommunicationPreferences - Retrieve all of an individual's communication preferences.
• SetCustomerCommunicationPreferences - Set an individual's communication preferences.

Recommendations

Information about mailing types rarely changes. Therefore we recommend you cache these results and get a new list on a regular interval, especially in a high-traffic application that calls this method frequently. For more information, see Data Caching