60 Promotion Event Services, Version 2.1
This chapter provides the information necessary to send messages contained in Version 2.1 of the Promotion Event Services API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.
The URL for the WSDL is:
https://<servername>:<portNumber>/ws/v2_1/PromotionEventServices?wsdl
where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.
The information presented below describes the methods and classes.
The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.
The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.
Note:
Authentication is required. See Introduction for information on creating and implementing an authentication key.
Methods
This section presents the methods used in Version 2.1 of the Promotion Event Services.
addOrUpdatePromotionTarget
PromotionTargetResponseType addOrUpdatePromotionTarget( PromoAddTargetRequestType PromoAddTargetRequestType) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
PromoAddTargetRequestType |
(Optional) |
Customer being added or updated to a promotion. |
The addOrUpdatePromotionTarget method adds or updates a target customer for a promotion.
This method returns a PromotionTargetResponseType element.
retrievePromotionDeals
PromoDealsResponseType retrievePromotionDeals( long PromotionId) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
|
(Required) |
ID of the Promotion. |
The retrievePromotionDeals method retrieves all deals associated with a promotion.
This method returns a PromoDealsResponseType element.
retrievePromotions
PromotionsResponseType retrievePromotions( PromotionsRequestType PromotionRequest) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
|
(Optional) |
Promotion search criteria |
The retrievePromotions method retrieves the promotions that match the PromotionRequest.
This method returns a PromotionsResponseType element.
retrievePromotionEventCustomerList
PromoEventCustomerResponseType[] retrievePromotionEventCustomerList( long PromotionId, string LocationId, string AssociateId, int startIndex, int pageSize) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
|
(Required) |
ID of the promotion. |
|
|
(Optional) |
ID of the location for the promotion. |
|
|
(Optional) |
ID of the associate assigned to customers. |
|
|
(Required) |
Start index of the customer list. |
|
|
(Required) |
Maximum number of records per page. |
The retrievePromotionEventCustomerList method retrieves the customers targeted by a promotion.
This method returns a PromoEventCustomerResponseType[] element.
Classes
This section presents the classes used in Version 2.1 of the Promotion Event Services.
DealAttributeType
The DealAttributeType class contains the following attributes:
| Type | Attribute | Description |
|---|---|---|
|
string |
name |
Name of the deal attribute. |
|
string |
value |
Value of the deal attribute. |
PromoAddTargetRequestType
The PromoAddTargetRequestType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
CampaignId |
ID of the campaign for the promotion. |
|
long |
PromotionId |
ID of the promotion. |
|
string |
CustomerId |
ID of the customer. |
|
AlternateKey |
Array of alternate keys for the customer. |
|
|
string |
Action |
Action to perform. |
|
boolean |
ActiveFlag |
Indicates whether the promotion is active. |
|
boolean |
EmailDeliveredFlag |
Indicates whether an email to the customer was delivered. |
|
boolean |
EmailOpenedFlag |
Indicates whether the email to the customer was opened. |
|
boolean |
EmailClickedThroughFlag |
Indicates whether the customer clicked on the email to view the promotion information. |
|
boolean |
EmailUndeliveredFlag |
Indicates whether the email could not be delivered. |
|
date |
CreateDate |
Date the promotion was created in the system. |
|
date |
UpdateDate |
Date the promotion was last updated in the system. |
|
string |
UpdateUser |
User who last updated the promotion in the system. |
|
string |
CreateUser |
User who created the promotion in the system. |
PromoDealAttributeType
The PromoDealAttributeType element contains no subelements.
The PromoDealAttributeType class contains the following attributes:
| Type | Attribute | Description |
|---|---|---|
|
string |
name |
Name of the promotion-deal attribute. |
|
string |
value |
Value of the promotion-deal attribute. |
PromoDealType
The PromoDealType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
DealId |
ID of the deal. |
|
string |
DealName |
Name of the deal. |
|
string |
DealType |
Type of deal. |
|
string |
DealDescription |
Description of the deal. |
PromoDealsContainerType
The PromoDealsContainerType class contains the following element:
| Type | Element | Description |
|---|---|---|
|
PromoDeal |
Array of promotion details |
PromoDealsResponseType
The PromoDealsResponseType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
CampaignId |
ID of the campaign. |
|
long |
PromotionId |
ID of the promotion. |
|
PromoDeals |
Deals. |
PromoDealsResponseType class contains the following attribute:
| Type | Attribute | Description |
|---|---|---|
|
string |
ResponseCode |
Response code. |
PromoEventCustomerResponseType
The PromoEventCustomerResponseType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
Promo Event Customer Type[] |
PromotionEventCustomers |
Details of customers |
The PromoEventCustomerResponseType class contains the following attribute:
| Type | Attribute | Description |
|---|---|---|
|
int |
startIndex |
Sequence number indicating the order of the first customer in the page results |
|
boolean |
morePages |
Indicates whether there are more pages in the results. |
|
int |
pageSize |
Number of customers on the page. |
PromoEventCustomerType
The PromoEventCustomerType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string |
CustId |
ID of the customer. |
|
string |
FirstName |
First name of the customer. |
|
string |
LastName |
Last name of the customer. |
|
string |
PhoneNumber |
Phone number for the customer. |
|
string |
|
Email address for the customer. |
|
string |
Address |
Primary street address for the customer. |
|
string |
City |
City of the customer. |
PromoEventDocumentType
The PromoEventDocumentType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string |
DocumentName |
Name of the promotion event document. |
|
string |
DocumentLink |
Link to the promotion event document. |
PromotionType
The PromotionType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
PromotionId |
ID of the promotion. |
|
long |
CampaignId |
ID of the campaign. |
|
string |
EventType |
Type of event. |
|
string |
PromoStartDateTime |
Date and time at which the promotion starts. |
|
string |
PromoEndDateTime |
Date and time at which the promotion starts. |
|
string |
TargetingRule |
Targeting rule for the promotion. |
|
string |
EventDescription |
Description of the promotion event. |
|
PromoEventDocuments |
Array of promotion event documents. |
PromotionsRequestType
The PromotionsRequestType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
CampaignId |
ID of the campaign. |
|
long |
PromotionId |
ID of the promotion. |
|
string |
EventType |
Type of event. |
|
date |
StartDate |
Date on which the promotion starts. |
|
date |
EndDate |
Date on which the promotion ends. |
PromotionsResponseType
The PromotionsResponseType class contains the following element:
| Type | Element | Description |
|---|---|---|
|
Promotions |
Array of Promotions. |
PromoDealsResponseType includes the following attributes:
| Type | Attribute | Description |
|---|---|---|
|
string |
ResponseMessage |
Message for the response. |
|
string |
ResponseCode |
Response code. |
PromotionTargetResponseType
The PromotionTargetResponseType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
long |
PromotionID |
ID of the promotion. |
|
string |
CustomerID |
ID of the customer. |
PromotionTargetResponseType includes the following attributes:
| Type | Attribute | Description |
|---|---|---|
|
string |
ResponseCode |
Response code |