com.ibm.commerce.giftcenter.rest.resources

Class GiftList

java.lang.Object

com.ibm.commerce.giftcenter.rest.resources.GiftList

@Path(value="stores/{storeId}/GiftLists")
 @Encoded
public class GiftList
extends java.lang.Object

This class converts RESTful GiftList requests into WebSphere Commerce GiftList requests and returns data in either XML, JSON, or Atom feed format.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Constructor Summary

Constructors

Constructor and Description
GiftList()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findByExternalId(java.lang.String externalId, java.lang.String storeId, java.lang.String guestAccessKey, java.lang.String accessProfile, java.lang.String responseFormat) This method performs a GetGiftList by externalId request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

GiftList

public GiftList()

Method Detail

findByExternalId

@GET
 @Produces(value={"application/atom+xml","application/json","application/xml"})
 @Path(value="{externalId}")
public javax.ws.rs.core.Response findByExternalId(@PathParam(value="externalId")
                                                                                                                                                                    java.lang.String externalId,
                                                                                                                                                                    @PathParam(value="storeId")
                                                                                                                                                                    java.lang.String storeId,
                                                                                                                                                                    @QueryParam(value="guestAccessKey")
                                                                                                                                                                    java.lang.String guestAccessKey,
                                                                                                                                                                    @QueryParam(value="accessProfile")
                                                                                                                                                                    java.lang.String accessProfile,
                                                                                                                                                                    @QueryParam(value="responseFormat")
                                                                                                                                                                    java.lang.String responseFormat)
                                                                                                                                                             throws javax.ws.rs.WebApplicationException,
                                                                                                                                                                    java.io.IOException,
                                                                                                                                                                    GiftListException

This method performs a GetGiftList by externalId request.

Parameters:

externalId - the GiftList externalId.

storeId - the store Id.

guestAccessKey - the guest access key of the gift list.

accessProfile - the access profile of the Get request.

responseFormat - the response format (xml, json, or atom).

Returns:

The GiftList noun in the specified format.

Throws:

javax.ws.rs.WebApplicationException

java.io.IOException

GiftListException