61 Promotion Event Services, Version 2.2

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

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
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 PromoEventCustomerResponseType[] element.