API Documentation

Description

Stores and retrieves parameters for sending the user to a Shutterfly UE (User Experience).

Call Signature

Application ID and call signature are required. Please see Call Signature documentation for more details.

Resource Path

This API uses the following resource path element:

/go2ue

Methods

POST - Stores parameters for a Shutterfly User Experience.
GET - Reads parameters previously stored for a Shutterfly User Experience.

Scheme

http, https

Host

ws.shutterfly.com

Method Endpoint example

POST http://ws.shutterfly.com/go2ue

GET http://ws.shutterfly.com/go2ue/5f37cab8905a7c46ddbdc08f4c56fb1f

Method	Endpoint example

POST	http://ws.shutterfly.com/go2ue

GET	http://ws.shutterfly.com/go2ue/5f37cab8905a7c46ddbdc08f4c56fb1f

In the following Method detail sections, click on Method name to expand or collapse the detail.
Click here to expand/collapse all.

Method: POST

Stores parameters for a Shutterfly User Experience.

User authorization

User authorization is required for this method. Please see the user authorization documentation for more details.

Sample Input

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"
	xmlns:go2ue="http://go2ue.openfly.shutterfly.com/v1.0">
	<category term="go2ueParms" scheme="http://openfly.shutterfly.com/v1.0" />
	<go2ue:target>OP</go2ue:target>
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/1111" />
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/2222" />
</entry>

Submit the following as an Atom XML entry, as in the Sample Input.

Content-Type

application/atom+xml

go2ue entry

Sample Output

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"
	xmlns:go2ue="http://go2ue.openfly.shutterfly.com/v1.0">
	<category term="go2ueParms" scheme="http://openfly.shutterfly.com/v1.0" />
	<go2ue:target>OP</go2ue:target>
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/1111" />
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/2222" />
	<id>http://ws.shutterfly.com/go2ue/987654321</id>
	<link rel="alternate" href="http://www.shutterfly.com/go2ue.sfly?id=987654321">
</entry>

Content-Type

application/atom+xml

go2ue entry

HTTP 201 (Created) is the normal response. The response will be an Atom XML entry representing the stored UE parameters. Key elements:

Error Codes

If there is no error, methods always return HTTP status code 200 (or 201 for a create operation). See Common Response Codes documentation.

This API has no specific error codes, only the common HTTP responses will be returned.

Method: GET

Reads parameters previously stored for a Shutterfly User Experience.

User authorization

User authorization is required for this method. Please see the user authorization documentation for more details.

Input Parameters

Set the following on the URL:

/go2ue

A previously returned id (handle) to parameters you stored for a Shutterfly User Experience.

Count: 1

Example: 5f37cab8905a7c46ddbdc08f4c56fb1f

format

Optional. Defaults to format=feed, which means the API response is an Atom feed with the info at the /feed level. By contrast, format=entry means the API response is a single Atom entry with the info. Shutterfly recommends format=entry.

Count: 0 - 1

Example: entry

Sample Output

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"
	xmlns:go2ue="http://go2ue.openfly.shutterfly.com/v1.0">
	<category term="go2ueParms" scheme="http://openfly.shutterfly.com/v1.0" />
	<go2ue:target>OP</go2ue:target>
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/1111" />
	<go2ue:resource category-term="album" href="http://ws.shutterfly.com/userid/000012345678/albumid/2222" />
	<id>http://ws.shutterfly.com/go2ue/987654321</id>
	<link rel="alternate" href="http://www.shutterfly.com/go2ue.sfly?id=987654321">
</entry>

Content-Type

application/atom+xml

go2ue entry

Interpret the parameters as for the response to a POST.

Error Codes

If there is no error, methods always return HTTP status code 200 (or 201 for a create operation). See Common Response Codes documentation.

This API has no specific error codes, only the common HTTP responses will be returned.

Shutterfly Open API | UE Parameters

Description

Call Signature

Resource Path

Methods

Scheme

Host

Method: POST

User authorization

Sample Input

go2ue entry

Sample Output

go2ue entry

Error Codes

Method: GET

User authorization

Input Parameters

Sample Output

go2ue entry

Error Codes