Data Privacy Services, Version 1.0

39 Data Privacy Services, Version 1.0

This chapter provides the information necessary to send messages contained in Version 1.0 of the Data Privacy 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.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v1_0/DataPrivacyServices?wsdl

Where <servername> is the name or address of the server. The default port number is 443.

The information presented 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 Data Privacy Services API.

retrieveCustomer

CustomerProfileResponseType retrieveCustomer (
                   string customerId,
                   AlternateKeyLookupType[] alternateKeyList,
                   string cardNumber,
                   string securityUserId)
     throws RelateProcessingException

Variable	Required?	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Number of a card associated with the customer.
securityUserId	Optional	ID of the Customer Engagement user performing the lookup.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully. To retrieve transaction history of the customer, use the getTransactionHistory message.

deleteCustomer

string deleteCustomer (
                        string customerId,
                        AlternateKeyLookupType[] alternateKeyList,
                        string cardNumber,
                        string securityUserId)
      throws RelateProcessingException

Variable	Required?	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Number of a card associated with the customer.
securityUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The deleteCustomer method deletes any personal data about the customer, including name, address, phone, and email. The customer ID is disassociated from existing data, including cards, accounts, transactions, images, segments, and item registries.

This method returns a string containing the ID of the deleted customer.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully. Assignment to the EntityDataController or SystemAdmin role is required.

Classes

This section presents the classes used in Version 1.0 of the Data Privacy Services API.

AccountIdType

The getValue() function for the AccountIdType class returns a string value.

AccountIdType includes the following attribute:

Type	Attribute	Description
string	Type	Indicates the type of account.

AddressReturnType

The AddressReturnType class contains the following elements:

Type	Element	Description
string	AddressLine1	AddressLine1.
string	AddressLine2	AddressLine2.
string	AddressLine3	AddressLine3.
string	AddressLine4	AddressLine4.
string	ApartmentNumber	ApartmentNumber.
string	City	City.
string	Country	Country.
string	Country	Country.
string	Territory	Territory, state, or province.
string	PostalCode	PostalCode.

AddressReturnType includes the following attribute:

Type	Attribute	Description
string	Label	Label for the address.
string	ContactPreferenceCode	Code indicating contact preference.
boolean	PrimaryFlag	Indicates whether the address is the primary address.
string	TypeCode	Code indicating the type of address.
string	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary address and deactivate all other addresses.
boolean	ValidFlag	Indicates whether the address has been validated.
string	SequenceNumber	Sequence number for the address.

AffiliationReturnType

The AffiliationReturnType class contains the following element:

Type	Element	Description
string	RetailStoreID	ID for the location.

AffiliationReturnType includes the following attribute:

Type	Attribute	Description
string	Action	Indicates the action performed.

AlternateKeyLookupType

The AlternateKeyLookupType class contains the following element:

Type	Element	Description
string	AlternateID	ID for the alternate key.

AlternateKeyLookupType includes the following attribute:

Type	Attribute	Description
string	TypeCode	Code indicating the type of alternate key.

AlternateKeyReturnType

The AlternateKeyReturnType class contains the following element:

Type	Element	Description
string	AlternateID	ID for the alternate key.

AlternateKeyReturnType includes the following attributes:

Type	Attribute	Description
string	TypeCode	Code indicating the type of alternate key.
string	UpdateType	Indicates whether the information is New or Old.

ArchivedCustomersReturnType

The ArchivedCustomersReturnType class contains the following element:

Type	Element	Description
CustomerResponseType	CustomerResponseType	Information about the archived customer.

ArchivedSocialActivityReturnType

The ArchivedSocialActivityReturnType class contains the following element:

Type	Element	Description
SocialActivityReturnType	SocialActivityReturnType	Information about archived customer social activity.

ArchivedSocialProfilesReturnType

The ArchivedSocialProfilesReturnType class contains the following element:

Type	Element	Description
SocialProfileReturnType	SocialProfileReturnType	Information about an archived customer social profile.

AssociateAssignmentReturnType

The getValue() function for the AssociateAssignmentReturnType class returns a string value.

AssociateAssignmentReturnType includes the following attributes:

Type	Attribute	Description
string	updateDate	Date on which the associate assignment was most recently updated.
string	updateUser	User who most recently updated the associate assignment.
string	lockedFlag	Indicates whether the role assignment is locked.
string	associateName	Name of the associate.
string	associateId	ID of the associate.
string	primaryFlag	Indicates whether the role is the primary role.
string	roleName	Name of the associate role.
string	roleId	ID of the associate role.

AttributeValueType

The AttributeValueType class contains the following element:

Type	Element	Description
string[]	AttributeValue	Array of values for the attribute.

AttributeValueType includes the following attributes:

Type	Attribute	Description
long	AttributeId	Name of the attribute.
string	AttributeName	Attribute action.

ContactInformationReturnType

The ContactInformationReturnType class contains the following elements:

Type	Element	Description
AddressReturnType[]	Address	Contact address.
EMailReturnType[]	Email	Contact email.
TelephoneReturnType[]	Telephone	Contact telephone.

ContactPreferenceReturnType

The getValue() function for the ContactPreferenceReturnType class returns a string value.

ContactPreferenceReturnType includes the following attribute:

Type	Attribute	Description
ContactPreferenceContactReturnType	ContactType	Contact method.
boolean	Permission	Indicates whether this contact method is allowed.

CustomAttributeReturnType

The CustomAttributeReturnType class contains the following element:

Type	Element	Description
string[]	AttributeValue	Array of attribute values.

CustomAttributeReturnType includes the following attributes:

Type	Attribute	Description
boolean	editable	Indicates whether the values of this attribute can be edited.
string	name	Name of the attribute.

Note:

Information that maps to a Customer’s identity is not protected if stored in Customer Attributes. Oracle does not recommend using Customer Attributes to store personal data.

CustomerCardsType

The CustomerCardsType class contains the following element:

Type	Element	Description
IIndividualReturnType[]	Instrument	Array of customer cards.

CustomerFranchiseeContainerReturnType

The CustomerFranchiseeContainerReturnType class contains the following element:

Type	Element	Description
CustomerFranchiseeContainerReturnType	Franchisee	Array of franchisees.

CustomerFranchiseeReturnType

The getValue() function for the CustomerFranchiseeReturnType class returns a string value.

CustomerFranchiseeReturnType includes the following attribute:

Type	Attribute	Description
long	franchiseeId	ID of the franchisee.
string	franchiseeName	Name of the franchisee.

CustomerImageReturnType

The CustomerImageReturnType class contains the following element:

Type	Element	Description
CustomerImageType	CustomerImageType	Information about customer images.

CustomerImageType

The getValue() function for the CustomerImageType class returns a string value.

CustomerImageType includes the following attributes:

Type	Attribute	Description
date	createDate	Date the image was created.
string	createUser	ID of the user who created the image.
date	updateDate	Date the image was most recently updated.
string	updateUser	ID of the user who most recently updated the image.

CustomerNameTypeReturnEntry

The getValue() function for the CustomerNameTypeReturnEntry class returns a string value.

CustomerNameTypeReturnEntry includes the following attribute:

Type	Attribute	Description
NameLocationReturnType	Location	Location within the name.

CustomerNotesContainerReturnType

The CustomerNotesContainerReturnType class contains the following elements:

Type	Element	Description
CustomerNotesReturnType[]	CustomerNote	Array of customer notes.
string	SecurityPrivilege	Security code (for example, Read/Write, Read Only, or Limited Read).
boolean	MaskData	Indicates whether sensitive customer information should be hidden from the user who made the request.

CustomerProfileResponseType

The CustomerProfileResponseType class contains the following elements:

Type	Element	Description
CustomerReturnType	CustomerReturnType	Array of customer information.
CustomerImageReturnType	CustomerImageReturnType	Array of information about customer images.
ArchivedCustomersReturnType	ArchivedCustomersReturnType	Array of archived customer information.
RegistryReturnType	RegistryReturnType	Array of registry information.
SocialProfilesReturnType	SocialProfilesReturnType	Array of social profile information.
ArchivedSocialProfilesReturnType	ArchivedSocialProfilesReturnType	Array of archived social profile information.
SocialActivitiesReturnType	SocialActivitiesReturnType	Array of social activity information.
ArchivedSocialActivityReturnType	ArchivedSocialActivityReturnType	Array of archived social activity information.

CustomerResponseType

The CustomerResponseType class contains the following elements:

Type	Element	Description
string	CustomerID	ID for the customer.
date	SignupDate	Date the customer record was created.
string	ResponseDescription	Response following a request. May be an error, or a confirmation message.
string	FaultDetail	Detailed information for any fault that may be returned.
string	ErrorCode	Code identifying any error that may have occurred.
string	RetailStoreID	ID for the retail location.
date	FirstPurchaseDate	The date of the customer’s first purchase.
date	LastPurchaseDate	The date of the customer’s most recent purchase.
ValidationType	Validation	Validation of the customer
string	OrgName	Name of the organization.
string	CustOrgTypcode	The ID for the customer organization to which the customer belongs.
string	EmployeeID	EmployeeID for the customer, if the customer is an employee.
string	BusinessName	Name of the business to which the customer belongs.
string	CustomerClass	Class to which the customer belongs.
string	Source	Customer source.
boolean	Prospect	Indicates whether the customer is a prospect.
string	CustomerOwnerID	ID of the user who owns the customer.
string	HouseholdKey	ID for the household to which the customer belongs.
string	CustomerNumber	Customer number.
string	CustomerReference	Customer reference.
LastUpdateInfoReturnType	LastUpdateInfo	The last update of the customer.
AffiliationReturnType[]	Affiliation	Customer affiliation.
EntityInformationReturnType	EntityInformation	Entity information for the customer.
PersonalPreferencesReturnType	PersonalPreferences	Personal preferences for the customer.
AlternateKeyReturnType[]	AlternateKey	Alternate key for the customer.
CustomAttributeReturnType[]	CustomAttribute	Custom attribute for the customer.
CustomerNotesContainerReturnType	CustomerNotes	Customer notes.
EligiblePromotionDealsType	EligiblePromotionDeals	Deals for which the customer is eligible.
CustomerSegmentsType	CustomerSegments	Segments to which the customer belongs.
CustomerCardsType	CustomerCards	Cards associated with the customer.
boolean	MaskData	Indicates whether the customer data should be masked from the requesting user.
AssociateAssignmentReturnType	AssociateAssignments	Associate assignments for the customer.
string	SecurityPrivilege	Security code (for example, Read/Write, Read Only, or Limited Read).
string	SystemCurrencyCode	ISO 4217 currency code for the system’s standard currency.
PreferenceCenterContainerReturnType	PreferenceCenters	Customer contact preferences.
CustomerFranchiseeContainerReturnType	Franchisees	Franchisees with which the customer is associated.

CustomerResponseType includes the following attribute:

Type	Attribute	Description
string	ResponseCode	Code identifying the type of response.

CustomerReturnType

The CustomerReturnType class contains the following element:

Type	Element	Description
CustomerResponseType	CustomerResponseType	Customer data.

CustomerSegmentsType

The CustomerSegmentsType class contains the following element:

Type	Element	Description
SegmentType[]	Segment	Array of customer segments.

CustomerSocialActivityContainerReturnType

The CustomerSocialActivityContainerReturnType class contains the following element:

Type	Element	Description
SocialActivityType[]	SocialActivity	Array of social activity items.

CustomerSocialProfileContainerReturnType

The CustomerSocialProfileContainerReturnType class contains the following element:

Type	Element	Description
SocialProfile[]	SocialProfile	Array of social profile information.

EligiblePromotionDealsType

The EligiblePromotionDealsType class contains the following element:

Type	Element	Description
PromotionDealIdType[]	PromotionDealId	Array of promotion deal identifiers.

EMailReturnType

The EMailReturnType class contains the following element:

Type	Element	Description
string	EMailAddress	The email address.

EMailReturnType includes the following attributes:

Type	Attribute	Description
boolean	PrimaryFlag	Indicates whether it is the primary email address.
string	TypeCode	Code identifying the type of email address.
string	Label	Label for the email address.
string	ContactPreferenceCode	Code indicating the contact preference for the email address.
string	FormatPreferenceCode	Code indicating the preferred formatting method for emails.
string	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary address and deactivate all other addresses.
string	SearchType	Code identifying the type of search.
string	SequenceNumber	Sequence number for the email address.
boolean	ValidFlag	Indicates whether the address has been validated.

EntityInformationReturnType

The EntityInformationReturnType class contains the following element:

Type	Element	Description
IndividualReturnType	Individual	Individual entity.

IndividualReturnType

The IndividualReturnType class contains the following elements:

Type	Element	Description
string	Suffix	Name suffix.
string	SortingName	Name used in sorting the individual.
string	NickName	NickName for the individual.
string	Salutation	Salutation.
NameType	Name	Name for the individual.
ContactInformationReturnType	ContactInformation	Contact information for the individual.
PersonalSummaryReturnType	PersonalSummary	Summary information for the individual.
SocioEconomicProfileReturnType	SocioEconomicProfile	Socio-economic profile for the individual.
LifetimeActivitySummaryType	LifetimeActivity Summary	Summary of the lifetime activity of the individual.
YearToDateActivitySummaryType	YearToDateActivity Summary	Summary of the year-to-date activity of the individual.

InstrumentReturnType

The InstrumentReturnType class contains the following element:

Type	Element	Description
string	CardNumber	Card ID number.
string	CardSerialNumber	Serial number for the card.
boolean	PrimaryAccountHolder Flag	Indicates whether the customer is the primary account holder.
AccountIdType[]	AccountId	Array of identifiers for accounts associated with the card.

InstrumentReturnType includes the following attribute:

Type	Attribute	Description
string	Description	Description of the card.

LastUpdateInfoReturnType

The LastUpdateInfoReturnType class contains the following elements:

Type	Element	Description
string	UpdateUserID	ID for user who made the last update.
dateTime	UpdateDate	Date and time of the last update.

LifetimeActivitySummaryType

The LifetimeActivitySummaryType class contains the following element:

Type	Element	Description
string	TotalReturnsAmount	Total amount of all returns.
string	TotalSalesAmount	Total amount of all sales.
string	TotalTransactionCount	Total number of transactions.
string	TotalItemsSoldCount	Total number of items sold.
string	TotalItemsReturnedCount	Total number of items returned.

NameType

The NameType class contains the following element:

Type	Element	Description
CustomerNameTypeReturnEntry[]	Name	Name of an individual.

PersonalPreferencesReturnType

The PersonalPreferencesReturnType class contains the following element:

Type	Element	Description
string	GenderType	Gender for the individual.
date	BirthDate	Birth date for the individual.
date	Anniversary	Anniversary date for the individual.
string	MaritalStatusCode	Code identifying the individual’s marital status.
string	Ethnicity	Ethnicity of the individual.
boolean	Rent	Indicates whether the customer is part of a rented list.
string	LanguageCode	Code identifying the individual’s preferred language.

PreferenceCenterChannelType

The PreferenceCenterChannelType class contains the following element:

Type	Element	Description
string	channelTypeCode	Type of preference channel.
boolean	optInFlag	Indicates whether the customer opted to be contacted through this channel.
string	frequencyCode	Frequency at which the customer is contacted.
string	authorization Document	Document used to authorize the channel.
dateTime	communication LastSentDate	Last date on which a communication was sent through the communication channel.

PreferenceCenterChannelType includes the following attributes:

Type	Attribute	Description
date	updateDate	Date of the last update to the preference channel.
string	updateUser	ID of the user who last updated the preference channel.

PreferenceCenterContainerReturnType

The PreferenceCenterContainerReturnType class contains the following element:

Type	Element	Description
PreferenceCenterType[]	PreferenceCenter	Array of preference center requests.

PreferenceCenterType

The PreferenceCenterType class contains the following elements:

Type	Element	Description
long	preferenceTypeId	ID number for the type of preference.
string	preferenceTypeName	Name of the type of preference.
PreferenceCenterType[]	PreferenceCenterChannel	Contact channel for the preference.

PromotionDealIdType

The getValue() function for the PromotionDealIdType class returns a string value.

PromotionDealIdType includes the following attribute:

Type	Attribute	Description
string	Name	Name of the promotion.
string	Exclusive	Indicates whether the promotion is exclusive.

RegAddressIdType

The RegAddressIdType class contains the following element:

Type	Element	Description
string	AddressTypecode	Type of address.

RegAddressResponseType

The RegAddressResponseType class contains the following element:

Type	Element	Description
RegAddressIdType	GiftRegAddressId	Type of address.
string	AddressName	Name of the address.
string	AddressLine1	Line 1 of the street address.
string	AddressLine2	Line 2 of the street address.
string	AddressLine3	Line 3 of the street address.
string	AddressLine4	Line 4 of the street address.
string	Apartment	Address apartment.
string	City	Address city.
string	Territory	Address territory/state/province.
string	County	Address county.
string	Country	Address country.
string	PostalCode	Postal/Zip Code for the address.

RegAttributeType

The RegAttributeType class contains the following element:

Type	Element	Description
AttributeValueType[]	Attribute	Array of attributes and their values.

RegAttributeType includes the following attributes:

Type	Attribute	Description
string	GroupName	Name of the attribute group.
string	Action	Attribute group action.

RegistryIdType

The RegistryIdType class contains the following element:

Type	Element	Description
long	RegistryId	ID for the registry.

RegistryResponseType

The RegistryResponseType class contains the following element:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
RegistryIdType	RegistryType	Indicates whether the registry is a gift registry or a wish list.
string	Name	Name of the gift registry.
string	EventTypecode	Type of event.
dateTime	EventDate	Date of the event.
dateTime	ExpirationDate	Expiration date of the registry.
boolean	PublishedFlag	Indicates whether the registry is published.
string	LocationCreated	ID for the location where the registry was created.
string	Comments	Comments on the registry.
string	ImageData	URL for the image associated with the registry.
string	CreateDate	Date the registry was created.
string	CreateUserId	ID of the User who created the registry.
string	UpdateDate	Date the registry was most recently updated.
string	UpdateUserId	ID of the User who most recently updated the registry.
RegAddressResponseType[]	Addresses	Array of addresses for the registry.
RegOwnerResponseType[]	Owners	Array of registry owners.
RegAttributeType	AttributeGroup	Group of attributes.
string	SecurityPrivilege	Security code (for example, Read/Write, Read Only, or Limited Read).

RegistryReturnType

The RegistryReturnType class contains the following element:

Type	Element	Description
RegistryResponseType[]	RegistryResponseType	Array of registry response values.

RegOwnerIdType

The RegOwnerIdType class contains the following element:

Type	Element	Description
string	CustId Customer	ID for the owner.

RegOwnerResponseType

The RegOwnerResponseType class contains the following element:

Type	Element	Description
RegOwnerIdType	GiftRegOwnerMapId	Registry owner.
string	Nickname	Owner nickname.
boolean	PrimaryFlag	Indicates whether the owner is the primary owner.
ContactInformationReturnType	ContactInformation	Contact information for the owner.

RelateProcessingException

For a description of this class, see RelateProcessingException.

SegmentMessageType

The SegmentMessageType class contains the following elements:

Type	Element	Description
string	LanguageCode	Code identifying the language of the message.
string	Message	The message.
string	CustomerMessage	Message to the customer.
string	ReceiptMessage	Message on the receipt.

SegmentStrataType

The SegmentStrataType class contains the following elements:

Type	Element	Description
string	StrataType	Type of strata.
string	StrataFormat	Format of the strata.
string	BasedOnValue	Value used to determine the strata to which customers belong.
string	StrataField	Field used by the strata.
long	AverageStrataValue	Average field value for all customers in the stratum.
long	NumberOfStrata	Number of strata.
long	CustomerStrata	Strata level to which the customer belongs.
long	CustomerValue	Value of the field for the customer.

SegmentType

The SegmentType class contains the following elements:

Type	Element	Description
string	SegmentId	ID for the segment.
string	Name	Name of the segment.
string	Description	Description of the segment.
string	Type	Type of segment.
boolean	OpenAccess	Indicates whether the segment is an open access segment.
boolean	PublishToPromote	Indicates whether the segment is to be published to Promote.
SegmentMessageType []	SegmentMessage	Array of messages for the segment.
SegmentStrataType[]	Strata	Array of strata for the segment.

SocialActivitiesReturnType

The SocialActivitiesReturnType element contains the SocialActivityReturnType.

SocialActivityReturnType

The SocialActivityReturnType class contains the following element:

Type	Element	Description
string	CustomerID	ID of the customer.
CustomerSocialActivityContainerReturnType	SocialActivities	Social activity.
string	SecurityPrivilege	Security privilege for the social activity results.
boolean	MaskData	Indicates whether the social activity results should be masked from the user who performed the request.

SocialActivityType

The SocialActivityType class contains the following element:

Type	Element	Description
string	profileName	Name of the social profile.
string	socialMediaType	Type of social media.
string	activityType	Type of social activity.
date	activityDate	Date of the social activity.
string	messageText	Text of the social media post.

SocialProfile

The SocialProfile class contains the following element:

Type	Element	Description
string	profileId	ID of the social profile.
string	profileName	Name of the social profile.
string	socialMediaType	The type of social media for the social profile.
string	profileImageUrl	The URL of the social profile image.
string	userName	The name of the user associated with the social profile record.

SocialProfileReturnType

The SocialProfileReturnType class contains the following elements:

Type	Element	Description
string	CustomerId	ID of the customer.
CustomerSocialProfileContainerReturnType	SocialProfiles	Array of social profiles.
string	SecurityPrivilege	Security code (for example, Read/Write, Read Only, or Limited Read).
boolean	MaskData	Indicates whether sensitive customer information should be hidden from the user who made the request.

SocialProfilesReturnType

The SocialProfilesReturnType class contains the following element:

Type	Element	Description
SocialProfileReturnType[]	SocialProfileReturnType	Information on the social profile.

SocioEconomicProfileReturnType

The SocioEconomicProfileReturnType class contains the following elements:

Type	Element	Description
string	AnnualIncomeAmount	Annual income amount.
string	NetWorth	Net worth.
string	HighestEducationalLevelName	Highest level of education completed.

TelephoneReturnType

The TelephoneReturnType class contains the following element:

Type	Element	Description
string	PhoneNumber	Telephone number.
string	Extension	Telephone extension.

TelephoneReturnType includes the following attributes:

Type	Attribute	Description
boolean	PrimaryFlag	Indicates whether the telephone number is the primary telephone number.
string	TypeCode	Code indicating the type of telephone number.
string	Label	Label for the telephone number.
string	ContactPreferenceCode	Code indicating the contact preference for the telephone number.
string	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary telephone and deactivate all other telephones.
string	SearchType	Type of search.
string	SequenceNumber	Sequence number of the telephone number.
boolean	ValidFlag	Indicates whether the address has been validated.

ValidationType

The getValue() function for the ValidationType class returns a string value.

ValidationType includes the following attribute:

Type	Attribute	Description
boolean	ValidFlag	Indicates whether the customer information is complete (valid) or incomplete.

YearToDateActivitySummaryType

The YearToDateActivitySummaryType class contains the following elements:

Type	Element	Description
string	YearToDateReturnsAmount	Total amount of all year-to-date returns.
string	YearToDateSalesAmount	Total amount of all year-to-date sales.
string	YearToDateTransactionCount	Total number of year-to-date transactions.
string	YearToDateItemsSoldCount	Total number of year-to-date items sold.
string	YearToDateItemsReturnedCount	Total number of year-to-date items returned.