WebSphere Commerce EnterpriseWebSphere Commerce Professional

GiftRegistryDelete action

This action marks a gift registry as expired and therefore is no longer searchable from the system by the gift registrant or any gift givers.

URL structure

http://host_name/path/
The fully qualified name of your WebSphere Commerce Server and the configuration path (for example, wcserver.mydomain.ibm.com is fully qualified).
GiftRegistryDelete syntax diagram

Parameter values

URL
Required: The URL to be called when the action is successfully completed.
storeId
Required: The store reference number, which is required to help identify to which stores a gift registry belongs.
externalId
Required: The unique identifier for the gift registry.
errorViewName
Overrides the error view when an error occurs.

Example

The following example marks gift registry 888 as expired from the system at store 1001.


http://myhostname/webapp/wcs/stores/servlet/GiftRegistryDelete?URL=/webapp/wcs
/stores/servlet/&storeId=1001&externalId=888

Behavior

  • Upon successful completion, the specified URL is called.
  • Places an access key for the gift registry in the request for the appropriate JSP page.
  • Marks the gift registry profile as expired and no longer searchable from the system by the gift registrant or any gift givers.
  • If the action is unsuccessful, it redirects to the error view.

Exception conditions

  • If a required parameter is not specified, the system throws an exception with the _ERR_CMD_MISSING_PARAMETER message key.
  • If an invalid parameter is specified, the system throws an exception with the ERR_CMD_BAD_PARAMETER message key.
  • If the system cannot find the gift registry profile to remove, the system throws an exception with the _ERR_REGISTRY_NOT_FOUND message key.
  • If the system encounters a security problem, such as a user attempting to access the gift registry without the appropriate authorization, the system throws an exception with the _ERR_NOT_AUTHORIZED message key.