These resources show the published contests for the fanclub, and allow the current customer to enter a contest.
/contests
List all published contests for the fanclub
Name | Type | Description |
---|---|---|
limit |
integer | [Optional] Limits the number of contests returned |
event_id |
integer | [Optional] Restricts contests to only return those belonging to an event specified |
scope |
string | [Optional] Restricts contests Supported scopes: entered , selected |
{
"status": "ok",
"contests": [
{
"id": 1,
"name": "All Access 2013 VIP Backstage Experience",
"minimum_age": 13,
"status": "running", // Will be "entered" if customer has entered; otherwise it will be "ended" or "running" or "upcoming"
"starts_at": "2013-05-01 07:00:00 UTC",
"ends_at": "2013-06-01 07:00:00 UTC",
"timezone": {
"tz": "America/Los_Angeles",
"long": "Pacific Time (US & Canada)"
},
"running": true, // True if the current date is between "starts_at" and "ends_at"
"ended": false, // True if the current date is after "ends_at"
"entered": false, // True if customer is logged in and has entered this contest
"selected": false, // True if customer is logged in and has been selected for this contest
"forfeited": false, // True if customer is logged in and has forfeited this contest
"won": false, // True if customer is logged in and has confirmed their entry to this contest
"details": "<p>All winners will be notified via email and will be asked to CONFIRM their ability to attend the VIP Backstage Experience by clicking a link in the body of the email. After confirming, the winners will then receive an email that includes additional details on the event location and start time.</p><p>Good luck everyone!</p>",
"rules": "<ul><li>Previous winners of any contest in the past 12 months may not enter</li><li>Must be 13 or older</li></ul>",
"event": null
}
]
}
/contests/{id}
Display details for one contest
Name | Type | Description |
---|---|---|
id |
url segment | [Required] The contest ID of the desired contest |
/contests/1
** Assuming "All Access 2013 VIP Backstage Experience" has id = 1
{
"status": "ok",
"contest": {
"id": 1,
"name": "All Access 2013 VIP Backstage Experience",
"minimum_age": 13,
"status": "running", // Will be "entered" if customer has entered; otherwise it will be "ended" or "running" or "upcoming"
"starts_at": "2013-05-01 07:00:00 UTC",
"ends_at": "2013-06-01 07:00:00 UTC",
"timezone": {
"tz": "America/Los_Angeles",
"long": "Pacific Time (US & Canada)"
},
"running": true,
"ended": false,
"entered": false,
"selected": false,
"forfeited": false,
"won": false,
"available_to_customer": true,
"details": "<p>All winners will be notified via email and will be asked to CONFIRM their ability to attend the VIP Backstage Experience by clicking a link in the body of the email. After confirming, the winners will then receive an email that includes additional details on the event location and start time.</p><p>Good luck everyone!</p>",
"rules": "<ul><li>Previous winners of any contest in the past 12 months may not enter</li><li>Must be 13 or older</li></ul>",
"event": {
"id": 23,
"title": "Concert Series New York"
}
}
}
{
"status": "error",
"messages": ["No contest found"]
}
/contests/{id}/enter
Enter the current customer in the contest
Name | Type | Description |
---|---|---|
id |
url segment | [Required] The contest ID of the desired contest |
/contests/1/enter
* Assuming "All Access 2013 VIP Backstage Experience" has id = 1, and customer is LOGGED IN
{
"status": "ok",
"messages": [
"You have been entered into the All Access 2013 VIP Backstage Experience contest",
"If you are chosen as a winner you will be contacted via email for confirmation and further details"
]
}
{
"status": "error",
"messages": ["No contest found"]
}
{
"status": "error",
"messages": ["You have already entered this contest"]
}
{
"status": "error",
"messages": ["Contest hasn't started yet"]
}
{
"status": "error",
"messages": ["Contest has ended"]
}
{
"status": "error",
"messages": ["You must be 21 or older to enter this contest"]
}