Home / ... / Request.Order / ThirdParty / eNewsletters

eNewsletters


Path: CnPAPI.Engine.Request.Order.eNewsletters

Elements:

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:

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

Name

eNewsletterName

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.eNewsletterName

Description

eNewsletter company name. Only the integrated companies may be used.

Data Type

String

Range

ConstantContact, MailChimp, iContact

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.4

Required

No

Example

<eNewsletterName>ConstantContact</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.

Name

eNewsletterUserID

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.eNewsletterUserID

Description

eNewsletter company account UserID

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

2.0

Required

No

Example

< eNewsletterUserID>myUserID</eNewsletterUserID >

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. 

Name

eNewsletterPassword

Path

CnPAPI.Engine.Request.Order.ThirdPartyeNewsletters.eNewsletterPassword

Description

eNewsletter company account password

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.3

Required

No

Example

<eNewsletterPassword>myPassword</eNewsletterPassword>

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.

Name

eNewsletterCustomParam1

Path

CnPAPI.Engine.Request.Order.ThirdPartyeNewsletters.eNewsletterCustomParam1

Description

eNewsletter API additional parameter if needed

Data Type

String

Range

Minimum: 1 character

Maximum: 200 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

2.52

Required

No

Example

<eNewsletterCustomParam1>myPassword</ eNewsletterCustomParam1>

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:

Schema

      <xsd:element name="SubscribeList">

            <xsd:complexType>

                  <xsd:sequence>

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

                  </xsd:sequence>

            </xsd:complexType>

      </xsd:element>

 

ListName

Name

ListName

Path

CnPAPI.Engine.Request.Order.ThirdParty.eNewsletters.SubscribeList.ListName

Description

List to subscribe. Repeat this node for all subscribed lists.

Data Type

String

Range

Minimum: 1 character

Maximum: 50 characters

Default

 

Operation

Transaction Operation only

Input/output

Input

Version/Release

1.3

Required

No

Example

<ListName >Monthly Newsletter</ListName >

<ListName >Activity Report</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>




     RSS of this page