Classes

This section presents the classes used in Version 2.2 of the Promotion Event Services API.

AlternateKeyType

See Introduction.

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.
AlternateKeyType[]	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.
DealAttributeType[]	DealAttribute	Array of deal attributes.
PromoDealAttributeType[]	PromoDealAttribute	Array of promotion-deal attributes.

PromoDealsContainerType

The PromoDealsContainerType class contains the following element:

Type	Element	Description
PromoDealType[]	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.
PromoDealsContainerType	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	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.
PromoEventDocumentType[]	PromoEventDocuments	Array of promotion event documents.
PromoAttributeType[]	PromotionAttributes	Array of promotion attributes.

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
PromotionType[]	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

RelateProcessingException

For a description of this class, see Introduction.