MailingListSetting Type
The MailingListSetting is a complex Type in xWeb used to manage a customer's communication preferences. This type is used in the following web methods:
- GetAllCustomerCommunicationPreferences
- GetCustomerCommunicationPreference
- SetCustomerCommunicationPreferences
| Name | Type | Occurs | Description |
|---|---|---|---|
| mailing_list_key | string | 1..0 | The key of the mailing list. |
| mailing_list_name | string | 1..0 | The name of the list. |
| mailing_list_category | string | 1..0 | The category of the mailing list. |
| status | MailingPerferenceStatus | 1..1 | The status. Will be OptOut, OptIn or Undefined. |
| email_key | string | 1..0 | The email key, if any. |
| address_key | string | 1..0 | The key of the address, if any. |
| phone_key | string | 1..0 | The key of the phone, if any. |
| fax_key | string | 1..0 | The key of the fax, if any. |
Namespaces
When passing a MailingListSetting as a parameter to xWeb web methods, be sure to set the namespace properly.
Important! Parameters that fail to specify proper namespaces will not be interpreted correctly and will result in method faults.
Schema
Here is the schema for MailingListSetting:
<s:complexType name="MailingListSetting">
<s:sequence>
<s:element name="mailing_list_key" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="mailing_list_name" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="mailing_list_category" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="status" type="tns:MailingPerferenceStatus" maxOccurs="1" minOccurs="1"/>
<s:element name="email_key" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="address_key" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="phone_key" type="s:string" maxOccurs="1" minOccurs="0"/>
<s:element name="fax_key" type="s:string" maxOccurs="1" minOccurs="0"/>
</s:sequence>
</s:complexType>Refer to the xWeb WSDL for more details on each element. Please see XWeb Type for more on xWeb schemas and how they can vary slightly from one site and build to the next.
Sample
Here is an example of the MailingListSetting with sample data.
<MailingListSetting>
<mailing_list_key>679ee299-e6ef-4064-a1de-29e2fa218d81</mailing_list_key>
<mailing_list_name>ABCMailing List</mailing_list_name>
<mailing_list_category>event</mailing_list_category>
<status>OptIn</status>
<email_key>984b56f0-8875-4779-969a-16c366f11314</email_key>
<address_key>cee04154-199b-4bb4-9d4d-010eecd3062d</address_key>
<phone_key>f6c64b23-1110-4029-8be5-a2ada3b62544</phone_key>
<fax_key>c0229559-ac17-414c-ba34-b42207ab0bed</fax_key>
</MailingListSetting>