58 Promotion Event Services, Version 1.0

This chapter provides the information necessary to send messages contained in Version 1.0 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/v1_0/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 1.0 of the Promotion Event Services.

retrievePromotionDeals

PromoDealsResponseType retrievePromotionDeals(         long PromotionId)         
    throws RelateProcessingException

Variable	Required?	Description
PromotionId	(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
PromotionRequest	(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
PromotionId	(Required)	ID of the promotion.
LocationId	(Optional)	ID of the location for the promotion.
AssociateId	(Optional)	ID of the associate assigned to customers.
startIndex	(Required)	Start index of the customer list.
pageSize	(Required)	Maximum number of records per page.

The retrievePromotionEventCustomerList method retrieves the customers targeted by a promotion.

This method returns a Promo Event Customer Response Type element.

Classes

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

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
PromoDealType[]	PromoDeal	Array of promotion details

PromoDealsResponseType

The PromoDealsResponseType class contains the following elements:

Type	Element	Description
long	OrganizationId	ID of the organization.
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.

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.

RelateProcessingException

For a description of this class, see Introduction.