The GiftList noun is used to model both a gift registry and a wish list for a customer.
The Registry element is used to determine whether the gift list being created is a wish list or a gift registry.
The GiftList noun contains the list of gift items the customer has requested.
The GiftList noun also contains information about the gifting event,
the registrants who own the gift list,
a description of the gift list, access options, items
purchased, event announcements made, and so on.
The store to which the gift list belongs is also captured in the
noun and is given precedence over the
store information in the business
context. The user ID of the user creating the gift list is assumed to
be set in the business context.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| ChangeGiftList | Add | /GiftList[]/Item[] |
Adds items to the gift list. If the item already exists in the list, the quantity of the item is updated. Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) |
| Change | /GiftList[]/Item[] |
Updates an existing item in the gift list. Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Delete | /GiftList[]/Item[] |
Deletes an item from the gift list. Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[]/Description |
Updates the description of the gift list. To clear the existing
description of the gift list,
an empty string must be passed. Passing
Null
for an element will result in no change.
Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[]/EventInformation |
Updates the event information for the gift list.
Mandatory parameters are:
The pre-event or post-event shipping preference can be one of:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[]/Registrant |
Updates the gift list registrant information.
Mandatory parameters are:
The registrant ID for the gift list is not mandatory because a gift list can have only one registrant. An error results if one of the following conditions occurs:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Add | /GiftList[]/CoRegistrant[] |
Adds a co-registrant to the gift list.
Mandatory parameters are:
An error results if one of the following conditions occurs:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[]/CoRegistrant[] |
Updates the co-registrant information for the gift list.
Mandatory parameters are:
An error results if one of the following conditions occurs:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Delete | /GiftList[]/CoRegistrant[] |
Deletes the specified co-registrant information from the gift list.
Mandatory parameters are:
An error results if one of the following conditions occurs:
|
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[]/AccessSpecifier | Updates the access options for the gift list, which includes the guest access options, the manage access password, and the guest access password. |
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| Change | /GiftList[] | Updates the state of the gift list and other noun-level details, excluding the Registry element. |
Request
Response |
GiftCenterFacadeClient.changeGiftList(ChangeGiftListType) | |
| ProcessGiftList | Create | /GiftList[1] |
Creates a gift list for the user executing the request for the store provided in the noun. If the store information is
not provided,
the store ID in the context of the request is used.
The Registry element is used to determine whether the gift list being created is a wish list or a gift registry. |
Request
Response |
GiftCenterFacadeClient.processGiftList(ProcessGiftListType) |
| Authenticate | /GiftList[1] |
Authenticates the gift list using the guest access password or the manage access password. If the user is authenticated
using the
manage access password, the user is provided co-registrant access to the gift list. If the user is authenticated using
the guest access password,
the user is provided gift giver access to the gift list.
The guest access password or manage access password are required if the user is to be authenticated by password. If both passwords are not provided, the service checks whether the gift list requires a password for granting guest access. The service also checks whether the user who owns the gift list is making a request to update the context with the registrant relationship with the gift list. |
Request
Response |
GiftCenterFacadeClient.processGiftList(ProcessGiftListType) | |
| Announce | /GiftList[1] |
Announces the gift list via e-mail using the e-mail template specified in the request.
Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.processGiftList(ProcessGiftListType) | |
| Delete | /GiftList[1] | Deletes the gift list. The gift list ID or external ID is mandatory. Upon success, the gift list is marked for deletion in the database. |
Request
Response |
GiftCenterFacadeClient.processGiftList(ProcessGiftListType) | |
| Complete | /GiftList[1] |
This service checks if the gift list can be completed or not. The event date of the gift list should be passed
to complete the gift list.
Mandatory parameters are:
|
Request
Response |
GiftCenterFacadeClient.processGiftList(ProcessGiftListType) | |
| GetGiftList | IBM_Store_Summary IBM_Store_Details IBM_Store_All IBM_Store_GiftListSummaryAndItems | /GiftList[GiftListIdentifier[(UniqueID=)]] |
Gets the information for a gift list using the unique ID of the gift list.
The service request returns gift lists that the user executing the request has access to. A user has access to:
|
Request
Response |
findGiftListByUniqueIDs |
| IBM_Store_Summary IBM_Store_Details IBM_Store_All IBM_Store_GiftListSummaryAndItems | /GiftList[GiftListIdentifier[GiftListExternalIdentifier[(ExternalIdentifier=)]]] |
Gets the information for a gift list using the external identifier of the gift list.
The service request returns gift lists that the user executing the request has access to. A user has access to:
|
Request
Response |
findGiftListByExternalIdentifiers | |
| IBM_Store_Summary IBM_Store_Details IBM_Store_All IBM_Store_GiftListSummaryAndItems | /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry=] |
Gets the information for a gift list based on the user ID of the registrant and the gift list type (wish list or gift
registry).
If the user ID of the user executing the request is not the same as the user ID provided in the XPath, the service request returns only public gift lists and protected gift lists for which the user is authenticated to access. |
Request
Response |
findGiftRegistriesForUser findWishListsForUser | |
| IBM_Store_Summary IBM_Store_Details IBM_Store_All IBM_Store_GiftListSummaryAndItems | /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry= and (State=)] |
Gets the information for a gift list based on the user ID of the registrant, the gift list type (wish list or gift registry)
and state of the gift list.
If the user ID of the user executing the request is not the same as the user ID provided in the XPath, the service request returns only public gift lists and protected gift lists for which the user is authenticated to access. |
Request
Response |
findDefaultWishListForUser | |
| IBM_Store_Summary IBM_Store_Details IBM_Store_All IBM_Store_GiftListSummaryAndItems | /GiftList[AccessSpecifier[GuestAccessKey= or RegistryAccessKey=] and GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]] |
Gets the information for the gift list based on the gift list external ID and either of the access keys. This service request is meant for authenticating a user for the gift list. If the guest access key is used, the user is authenticated as a gift giver. If the registry access key is used, the user is authenticated as a co-registrant. If there are no gift lists matching the criteria, this service request throws an exception. Use this XPath when the user needs to be authenticated for a gift list without having to enter the password. Typical usage is in the links shared via e-mail. |
Request
Response |
||
| IBM_Store_Summary | /GiftList[search()] | Get the gift lists that match the search criteria. |
Request
Response |
findGiftListsSearch findGiftListsSimilarSearch | |
| IBM_Store_GiftListItems | /GiftList[GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]]/Item |
This service returns a paginated list of items for the gift list based on the external identifier.
The service request returns results for gift lists that the user executing the request has access to. A user has access to:
|
Request
Response |
findGiftListItemsByExternalIdentifier | |
| IBM_Store_GiftListAnnouncements | /GiftList[GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]]/Announcement |
This service returns a paginated list of gift list announcements made, based on the gift list external identifier.
The service request returns results for gift lists that the user executing the request has access to. A user has access to:
|
Request
Response |
findGiftListAnnouncementsByExternalIdentifier | |
| IBM_Store_GiftListPurchaseRecords | /GiftList[GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]]/PurchaseRecord |
This service returns a paginated list of purchase records, based on the gift list external identifier.
The service request returns results for gift lists that the user executing the request has access to. A user has access to:
|
Request
Response |
findGiftListPurchaseRecordsByExternalIdentifier |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned | |
|---|---|---|
| IBM_Store_Summary |
|
This access profile provides minimal data about a gift list. The typical usage of this access profile is in search. This access profile is open for all users and the data is not filtered. |
| IBM_Store_Details |
IBM_Store_Summary +
|
This access profile is designed to be used for the registrants or the co-registrants of the gift list. It provides detailed information about the gift list. The data returned by this access profile is filtered to prevent users who are neither the registrant nor a co-registrant of the gift list from viewing the data. |
| IBM_Store_All |
IBM_Store_Details +
|
This access profile is designed to be used for the registrants or the co-registrants of the gift list. It provides complete information about the gift list. The data returned by this access profile is filtered to prevent users who are neither the registrant nor a co-registrant of the gift list from viewing the data. |
| IBM_Store_GiftListSummaryAndItems |
IBM_Store_Summary +
|
This access profile provides summary level data about a gift list along with items details. This access profile is open for all users and the data is not filtered. |
| IBM_Store_GiftListAnnouncements |
|
This access profile provides a paginated list of announcements made for a gift list. The data returned by this access profile is filtered to prevent users who are neither the registrant nor a co-registrant of the gift list from viewing the data. |
| IBM_Store_GiftListItems |
|
This access profile provides a paginated list of items in a gift list. The data returned by this access profile is filtered to prevent users who are neither the registrant nor a co-registrant of the gift list from viewing the data. |
| IBM_Store_GiftListPurchaseRecords |
|
This access profile provides a paginated list of purchases made for a gift list. The data returned by this access profile is filtered to prevent users who are neither the registrant nor a co-registrant of the gift list from viewing the data. |