Registry Services, Version 3.1

71 Registry Services, Version 3.1

This chapter provides the information necessary to send messages contained in version 3.1 of the Registry 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/v3_1/RegistryServices?wsdl

where <servername> is the name or address of the server, and <companycode> is the code assigned to the company at installation. 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 classes used in Version 3.1 of the Registry Services API.

addOrUpdateRegistry

UpdateRegistryResponseType addOrUpdateRegistry(                      RegistryRequestType registryData,                      string updateUserId,                      string securityUserId)     throws RelateProcessingException, AttributeException

Variable	Required?	Description
`registryData`	[optional]	Registry information being added or updated.
`updateUserId`	[optional]	ID of the POS user performing the action.
`securityUserId`	[required]	ID of the Customer Engagement user performing the action.

The addOrUpdateRegistry method adds new registries to the system, or updates existing registries.

This method returns a UpdateRegistryResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

addOrUpdateRegistryDetail

UpdateRegistryDetailResponseType addOrUpdateRegistryDetail(          RegistryDetailRequestType registryDetailData,          string updateUserId,          string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryData`	[optional]	Registry details being added or updated.
`updateUserId`	[optional]	ID of the POS user performing the action.
`securityUserId`	[required]	ID of the Customer Engagement user performing the action.

The addOrUpdateRegistryDetail method adds items to a registry, or makes changes to items already entered into the registry.

This method returns a UpdateRegistryDetailResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

customerRegistryAssociation

CustomerRegistryAssociationResponseType customerRegistryAssociation(           CustomerRegistryAssociationRequestType registryAssociationData,           string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryAssociationData`	[optional]	Customer-registry association information.
`securityUserId`	[required]	ID of the Customer Engagement user performing the action.

The customerRegistryAssociation method associates a registry with a customer.

This method returns a CustomerRegistryAssociationResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

deleteRegistry

UpdateRegistryResponseType deleteRegistry(                        long registryId,                        string updateUserId,                        string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryId`	[required]	ID of the registry being deleted.
`updateUserId`	[required]	ID of the POS user deleting the registry.
`securityUserId`	[required]	ID of the Customer Engagement user deleting the registry.

The deleteRegistry method deletes an existing gift registry from the system.

This method returns a UpdateRegistryResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getRegistry

RegistryResponseType getRegistry(              long registryId,              string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryId`	[required]	ID of the registry.
`securityUserId`	[required]	ID of the Customer Engagement user retrieving the registry.

The getRegistry method retrieves information about a gift registry.

This method returns a RegistryResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getRegistryDetail

RegistryDetailResponseType getRegistryDetail(              long registryId,              string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryId`	[required]	ID of the registry.
`securityUserId`	[required]	ID of the Customer Engagement user retrieving the registry.

The getRegistryDetail method retrieves information about the items in a gift registry.

This method returns a RegistryDetailResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

searchRegistry

RegistrySummaryType[] searchRegistry(         RegistrySearchCriteriaType[]          registryCriterias,         string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`registryCriterias`	[optional]	Array of search criteria.
`securityUserId`	[required]	ID of the Customer Engagement user performing the search.

The searchRegistry method searches for registries matching the given criteria.

This method returns an array of RegistrySummaryType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

sellOrReturnRegistryItems

ReturnRegistryItemType sellOrReturnRegistryItems(                   RegistryItemsType registryItemsType,                   string securityUserId)     throws RelateProcessingException, IllegalRetailTranIdException

Variable	Required?	Description
`registryItemsType`	[optional]	Registry items being sold or returned.
`securityUserId`	[required]	ID of the Customer Engagement user performing the transaction.

The sellOrReturnRegistryItems method lists items in the registry as sold or returned.

This method returns a ReturnRegistryItemType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

Classes

AttributeException

For a description of this class, see Introduction.

AttributeValueType

The AttributeValueType class contains the following elements:

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

The AttributeValueType class contains the following attributes:

Type	Attribute	Description
long	AttributeID	ID of the Attibute.
string	AttributeName	Name of the attribute.

ContactInformationReturnType

The ContactInformationReturnType class contains the following elements:

Type	Element	Description
AddressReturnType[]	Address	Array of addresses.
EMailReturnType[]	Email	Array of emails.
TelephoneReturnType[]	Telephone	Array of telephone numbers.

CustAddressType

The CustAddressType class contains the following elements.

Type	Element	Description
AddressLineType	AddressLine1	Address line 1.
AddressLineType	AddressLine2	Address line 2.
AddressLineType	AddressLine3	Address line 3.
AddressLineType	AddressLine4	Address line 4.
string	ApartmentNumber	Apartment number.
AddressLineType	City	City.
string	Country	Country.
string	County	County.
TerritoryType	Territory	Territory, state, or province.
PostalCodeType	PostalCode	Postal Code.

CustContactInformationType

The ContactInformationReturnType class contains the following elements:

Type	Element	Description
CustAddressType[]	Address	Array of addresses.
CustEMailType[]	Email	Array of emails.
CustTelephoneType[]	Telephone	Array of telephone numbers.

CustEMailType

The EMailType class contains the following elements:

Type	Element	Description
string	EmailAddress	The email address.

CustTelephoneType

The TelephoneType class contains the following elements:

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

CustomerRegistryAssociationRequestType

The CustomerRegistryAssociationRequestType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
RegOwnerRequestType[]	Owners	Array of registry owners.

CustomerRegistryAssociationResponseType

The CustomerRegistryAssociationResponseType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
string[]	CustId	Array of IDs of the customers associated with the registry.
string	Status	Status of the registry.

EMailReturnType

See Introduction.

IllegalRetailTranIdException

The IllegalRetailTranIdException class contains the following elements

Type	Element	Description
string	faultDetail	Detailed description of the fault, including any debugging information.
string	message	Error message.
relateExceptionCode	relateExceptionCode	ID for the error.

PostalCodeType

See Introduction.

RegAddressIdType

The RegAddressIdType class contains the following element:

Type	Element	Description
string	AddressTypecode	Type of address.

RegAddressRequestType

The RegAddressRequestType class contains the following elements:

Type	Element	Description
RegistryActionType	Action	Action being performed on the registry.
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.

RegAddressResponseType

The RegAddressResponseType class contains the following elements:

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.

The RegAttributeType class contains the following attributes:

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

RegItemType

The RegItemType class contains the following element:

Type	Element	Description
string	ItemId	ID of the item.

RegItemRequestType

The RegItemRequestType class contains the following elements:

Type	Element	Description
RegistryActionType	Action	Action being performed on the registry.
RegItemIdType	GiftRegItemMapId	Item ID.
string	ItemXrefId	Cross-reference ID for the item.
string	DesiredQuantity	Desired quantity for the item.

RegItemResponseType

The RegItemResponseType class contains the following elements:

Type	Element	Description
RegItemIdType	GiftRegItemMapId	Item ID.
string[]	ItemXrefIds	Array of cross-reference IDs for the item.
string	DesiredQuantity	Desired quantity for the item.
string	PurchasedQuantity	Purchased quantity of the item.

RegOwnerIdType

The RegOwnerIdType class contains the following element:

Type	Element	Description
string	CustId	Customer ID for the owner.

RegOwnerRequestType

The RegOwnerRequestType class contains the following elements:

Type	Element	Description
RegistryActionType	Action	Action being performed.
RegOwnerIdType	GiftRegOwnerMapId	Registry owner.
AlternateKeyType[]	AlternateKey	Array of alternate keys for the owner.
string	CardNumber	Card number for the owner.
string	Nickname	Owner nickname.
boolean	PrimaryFlag	Indicates whether the owner is the primary owner.
CustContactInformationType	ContactInformation	Contact information for the owner.

RegOwnerResponseType

The RegOwnerResponseType class contains the following elements:

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.

RegistryDetailRequestType

The RegistryDetailRequestType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
RegItemRequestType[]	Items	Array of items for the registry.

RegistryDetailResponseType

The RegistryDetailResponseType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
RegItemResponseType[]	Items	Array of items in the registry.
string	SecurityPrivilege	Security code (e.g. `Read/Write`, `Read` `Only`, or `Limited Read`).

RegistryIdType

The RegistryIdType class contains the following element:

Type	Element	Description
long	RegistryId	ID for the registry.

RegistryItemsType

The RegistryItemsType class contains the following elements:

Type	Element	Description
long	GiftRegistryId	ID for the registry.
string	CustId	ID for the customer who is buying or returning the registry item.
decimal	Quantity	Quantity of the item.
RegistryItemsActionType	TransactionTypeCode	Type of registry action being performed.
date	BusinessDate	Business date of the action.
string	LocationId	ID of the location where the action is being performed.
string	WorkstationId	ID of the workstation where the action is being performed.
string	sequenceNumber	Sequence number of the transaction in which the action is being performed.
string	ItemId	ID of the registry item.
string	ItemRefId	Cross reference ID used to look up Customer Engagement item ID.

RegistryResponseType

The RegistryResponseType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
RegistryType	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 (e.g. `Read/Write`, `Read Only`, or `Limited Read`).

RegistryRequestType

The RegistryRequestType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID for the gift registry.
RegistryType	RegistryType	Indicates whether the registry is a gift registry or a wish list.
string	Name	Name of the registry.
string	EventTypecode	Code identifying the type of event.
dateTime	EventDate	Date of the event.
dateTime	ExpirationDate	Expiration date for the registry.
boolean	PublishedFlag	Indicates whether the registry is published.
string	Comments	Comments about the registry.
string	ImageData	URL for the image associated with the registry.
RegAddressResponseType[]	Addresses	Array of addresses for the registry.
RegOwnerResponseType[]	Owners	Array of registry owners.
RegItemRequestType[]	Items	Items for the registry.
RegAttributeType	AttributeGroup	Group of attributes.

RegistrySearchCriteriaType

The RegistrySearchCriteriaType class contains the following elements:

Type	Element	Description
string[]	fieldValue	Array of values to use in the search.
RegistrySearchFieldType	searchFieldType	Registry field being searched.
SearchOperatorType	searchOperator	Comparison operator to use in the search.

RegistrySummaryType

The RegistrySummaryType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID for the gift registry.
RegistryType	RegistryType	Indicates whether the registry is a gift registry or a wish list.
string	Name	Name of the registry.
string	EventTypecode	Code identifying the type of event.
dateTime	EventDate	Date of the event.
string	EventPlace	ID of the location where the event occurred.
boolean	PublishedFlag	Indicates whether the registry is published.
string	FirstName	First Name of the primary owner.
string	LastName	Last Name of the primary owner.

RelateProcessingException

For a description of this class, see Introduction.

ReturnRegistryItemType

The ReturnRegistryItemType class contains the following elements:

Type	Element	Description
long	GiftRegistryId	ID of the gift registry.
string	ItemId	ID of the item.
string	Status	Status code of the result. OK indicates the request was successful.

TelephoneReturnType

See Introduction.

TerritoryType

See Introduction.

UpdateRegistryDetailResponseType

The UpdateRegistryDetailResponseType class contains the following elements:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
string[]	ItemId	Array of items updated in the registry.
string	Status	Status of the gift registry.

UpdateRegistryResponseType

The UpdateRegistryResponseType class contains the following element:

Type	Element	Description
RegistryIdType	GiftRegistryId	ID of the gift registry.
string	Status	Status of the gift registry.

Methods

addOrUpdateRegistry

addOrUpdateRegistryDetail

customerRegistryAssociation

deleteRegistry

getRegistry

getRegistryDetail

searchRegistry

sellOrReturnRegistryItems

Classes

AddressLineType

AddressReturnType

AlternateKeyType

AttributeException

AttributeValueType

ContactInformationReturnType

CustAddressType

CustContactInformationType

CustEMailType

CustTelephoneType

CustomerRegistryAssociationRequestType

CustomerRegistryAssociationResponseType

EMailReturnType

IllegalRetailTranIdException

PostalCodeType

RegAddressIdType

RegAddressRequestType

RegAddressResponseType

RegAttributeType

RegItemType

RegItemRequestType

RegItemResponseType

RegOwnerIdType

RegOwnerRequestType

RegOwnerResponseType

RegistryDetailRequestType

RegistryDetailResponseType

RegistryIdType

RegistryItemsType

RegistryResponseType

RegistryRequestType

RegistrySearchCriteriaType

RegistrySummaryType

RelateProcessingException

ReturnRegistryItemType

TelephoneReturnType

TerritoryType

UpdateRegistryDetailResponseType

UpdateRegistryResponseType