Used for viewing and creating new Bucket Lists. The GET methods default to OAuth, and can only return your own bucket lists. However, adding /Public to the end switches to ApiKey security, and can return other accounts' public bucket lists.

Resource URI

/v2.0/Accounts/12345678/BucketList(/Public)

Resource Properties

Parameter	Format	Description	Allows Null
bucketID	Number	Unique ID for the bucket	no
name	String	Bucket name	no
trailCount	Number	The number of trails contained in the bucket	no

Error Responses

HTTP GET

Returns the details of a specific Bucket List. Add /Public to view a public bucket list owned by another account

JSON Request:

/v2.0/Accounts/{acctID}/BucketList/{bucketID}/
/v2.0/Accounts/{acctID}/BucketList/{bucketID}/Public/

JSON Response:

{
"name": "Test bucket list",
"description": "",
"priv": "Y",
"bucketTrails": [
{
"trailID": 6016038,
"trailName": "Capital Crescent Trail",
"trailHero": 158796,
"complete": "N"
}
]
}

XML Request:

XML Response:

HTTP POST

Add a trail to a bucket list

JSON Request:

/v2.0/Accounts/{acctID}/BucketList/{bucketID}/?trailID={trailID}

JSON Response:

XML Request:

XML Response:

HTTP PUT

n/a

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

n/a

JSON Request:

JSON Response:

XML Request:

XML Response:

REST API: Accounts/BucketList Set

n/a

Resource URI

Set Filters

Parameter	Format	Description	Allows Null
xxx	xxx	xxx	xxx

HTTP GET

Returns the list of all Bucket Lists associated with your account. Alternatively can return all public Bucket Lists associated with other accounts. Add /Public to the API call to see other accounts' bucket lists

JSON Request:

/v2.0/Accounts/{acctID}/BucketList/
/v2.0/Accounts/{acctID}/BucketList/Public/

JSON Response:

[
{
"bucketID": 10000000,
"name": "Test bucket list",
"trailCount": 1
},
{
"bucketID": 10000020,
"name": "Test #2",
"trailCount": 0
}
]

XML Request:

XML Response:

HTTP POST

Create a new empty Bucket List

JSON Request:

/v2.0/Accounts/{acctID}/BucketList/

"name": "Bucket List Name",
"description": "Bucket List Description",
"priv": "Y"|"N"