CRMs

Table of Contents  [ Hide]

CRMProvider
ProviderName
ProviderUserID
ProviderPassword

Path: CnPAPI.Engine.Request.Order.ThirdParty.CRMs

Element:

• CRMProvider

Schema

 <xsd:element name="CRMs">

 <xsd:complexType>

 <xsd:sequence>

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

 </xsd:sequence>

 </xsd:complexType>

 </xsd:element>

CRMProvider

Path: CnPAPI.Engine.Request.Order.ThirdParty.CRMs.CRMProvider

Elements:

• ProviderName
• ProviderUserID
• ProviderPassword

Schema

 <xsd:element name="CRMProvider">

 <xsd:complexType>

 <xsd:sequence>

 <xsd:element ref="ProviderName"/>

 <xsd:element ref="ProviderUserID"/>

 <xsd:element ref="ProviderPassword"/>

 </xsd:sequence>

 </xsd:complexType>

 </xsd:element>

Example:

<CRMs>

<CRMProvider>

 <ProviderName>SalesForce</ProviderName>

 <ProviderUserID>SFUserID</ProviderUserID>

<ProviderPassword>PasswordSecurityToken</ProviderPassword>

 </CRMProvider>

</CRMs>

Note: 

Salesforce provides a security token for connecting to the API. The security token should be appended to the end of password for the ProviderPassword node.

To avoid entry of UerID & Password enable Salesforce 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. Once enabled in the administrative system for the checkout page, all patrons’ information will be posted to the Salesforce.

ProviderName

Schema

 <xsd:element name="ProviderName">

 <xsd:simpleType>

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

 <xsd:enumeration value="SalesForce"/>

 </xsd:restriction>

 </xsd:simpleType>

 </xsd:element>

ProviderUserID

Schema

 <xsd:element name="ProviderUserID">

 <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:

ProviderUserID 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.

ProviderPassword

Schema

 <xsd:element name="ProviderPassword">

 <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:

Salesforce: Password should be followed by the security token as provided by Salesforce.

ProviderPassword 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.