eNewsletters

Table of Contents  [ Hide]

eNewsletterProvider
eNewsLetterName
eNewsLetterUserID
eNewsLetterPassword
eNewsLetterCustomParam1
SubscribeList

Path: CnPAPI.Engine.Request.Order.eNewsletters

Elements:

• eNewsletterProvider

Schema

      <xsd:element name="eNewsletters">

            <xsd:complexType>

                  <xsd:sequence>

                        <xsd:element ref="eNewsletterProvider" maxOccurs="unbounded"/>

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

eNewsletterProvider

Path: CnPAPI.Engine.Request.Order.eNewsletters.eNewsletterProvider

Elements:

• eNewsletterName
• eNewsletterUserID
• eNewsletterPassword
• SubscribeList

Schema

      <xsd:element name="eNewsletterProvider">

            <xsd:complexType>

                  <xsd:sequence>

                        <xsd:element ref="eNewsletterName"/>

                        <xsd:element ref="eNewsletterUserID" minOccurs="0"/>

                        <xsd:element ref="eNewsletterPassword" minOccurs="0"/>

                        <xsd:element ref="eNewsletterCustomParam1" minOccurs="0"/>

                        <xsd:element ref="SubscribeList"/>

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

Example

<eNewsletters>

<eNewsletterProvider>

 <eNewsletterName>ConstantContact</eNewsletterName>

 <eNewsletterUserID>CCUserID</eNewsletterUserID>

 <eNewsletterPassword>CCPassword</eNewsletterPassword>

 <SubscribeList>

 <ListName><![CDATA[General Interest]]></ListName>

<ListName><![CDATA[Membership News]]></ListName>

 </SubscribeList>

</eNewsletterProvider>

<eNewsletterProvider>

 <eNewsletterName>MailChimp</eNewsletterName>

 <eNewsletterUserID>MCUserID</eNewsletterUserID>

 <eNewsletterPassword>MCPassword</eNewsletterPassword>

 <SubscribeList>

 <ListName><![CDATA[aSampleList]]></ListName>

 </SubscribeList>

</eNewsletterProvider> 

</eNewsletters>

eNewsLetterName

Schema

       <xsd:element name="eNewsletterName">

              <xsd:simpleType>

                     <xsd:restriction base="xsd:string">

                           <xsd:enumeration value="ConstantContact"/>

                           <xsd:enumeration value="MailChimp"/>

                           <xsd:enumeration value="iContact"/>

                           <xsd:enumeration value="PredictiveResponse"/>

                     </xsd:restriction>

              </xsd:simpleType>

       </xsd:element>

eNewsLetterUserID

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system. To subscribe a user to a list, post the ListName as the only required field.

Schema

      <xsd:element name="eNewsletterUserID">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:normalizedString">

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Notes:

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system.  To subscribe a user to a list, post the ListName as the only required field.

eNewsLetterPassword

To avoid entry of UerID & Password enable the provider in the administrative system and add it to a checkout page. Use the WID in the API. The API will retrieve the information from the administrative system. 

Schema

      <xsd:element name="eNewsletterPassword">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:normalizedString">

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

Notes:

eNewsletterPassword is optional if the information is set for the checkout page ID used for the WID node. If the provider is enabled for the checkout page, the API will automatically take the settings provided in the administrative system.

eNewsLetterCustomParam1

The parameter is used for providers that require additional information, e.g. iContact and the use of URL.

Schema

      <xsd:element name="eNewsletterCustomParam1">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:normalizedString">                    

                        <xsd:maxLength value="200"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>   

SubscribeList

Path: CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.SubscribeList

Element:

• ListName

Schema

      <xsd:element name="SubscribeList">

            <xsd:complexType>

                  <xsd:sequence>

                        <xsd:element ref="ListName" maxOccurs="unbounded"/>

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

ListName

Schema

      <xsd:element name="ListName">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation/>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:normalizedString">

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="50"/>

                  </xsd:restriction>

            </xsd:simpleType>