Event API

#Introduction

The ScoreBig API is a simple REST web service interface with lightweight JSON-formatted responses, providing you the capability to use many of the functions and data of ScoreBig's platform. This document outlines the API methods pertinent to event discovery. If you haven't already, you should go over the basics of the ScoreBig API by reading the ScoreBig API Introduction documentation.

#Response Objects

##Event

Property Name	Type	Description	Value Constraints	Nullable
id	guid	ScoreBig's unique identifier for the event		no
url	string	Your affiliate deep-link URL to the ScoreBig offer page for this event.		yes
name	string	Event name		No
local_date_time	datetime	The date and time of the event in the local timezone of the venue for the event.	string in the format M/d/YYYY H:MM:SS AM/PM	No
local_date_time_type	int	Determines the level of certainty for the LocalDateTime.	1 = Known date time, 2 = Known date but time is TBD, 3 = Both time and date are TBD	No
time_zone	string	The timezone name for the event.		no
venue_id	guid	Id of the venue for this event.		no
venue	string	Name of the venue for this event.		no
deal_rating	int	Determines the level of savings for this event.	0 = Event is out of stock, 1 = Big savings, 2 = Bigger savings, 3 = Biggest savings	no
deal_rating_percentage	int	The overall percentage savings for this event.	Returned values are 10, 25, or 50 percent for Big, Bigger, and Biggest savings respectively	no
performer_Id	guid	The id of the primary performer for this event.		no
performer	string	The name of the primary performer for this event.		no
categories	array of Category objects	The list of categories for this event. Categories have an Id and Name property.		no
is_on_sale	bool	Determines whether the event is on sale at ScoreBig.		no
is_cancelled	bool	Determines whether the event has been cancelled.		no
is_out_of_stock	bool	Determines if there are no more tickets available for this event.		no
rescheduled_from_event_id	guid	The id of the cancelled event that resulted in this event.		yes
rescheduled_to_event_id	guid	If this event is cancelled, this is the id for the rescheduled event.		yes

#Resources

##Events

Events are the atomic building blocks of ScoreBig. Events can be searched and filtered.

Method	URI	Description
GET	/events	Returns available events. Includes the ability to search by keywords and filter by a variety of fields.
GET	/events/{:event_id}	Returns one specific event.

###GET /events

Description:	Returns a list of upcoming events on sale on ScoreBig.com
Resource:	Events
Method:	GET
Resource Path:	/events
Example:	http://developer.api.scorebig.com/1/events To get all available events (could take up to 20 seconds to return)

Returned Objects: Event

An array of Event objects will be returned. If your search yields no events, an empty array with be returned. See object definitions above for object reference.

Example Response:

{
  type: "EventResult",
  count: 9,
  results: [ //Array
  { //Event Results
    "id": "00000000-0000-0000-0000-000000000210",
    "url": "/alternative-rock-tickets/radiohead-in-rainbows-11-18-2010/ios-1/sjoAjBYBKQ?ref_tag=aff.api",
    "name": "Radiohead In Rainbows",
    "local_date_time": "1/1/2019 2:30:00 AM",
    "local_date_time_type": 1,
    "time_zone": "America/Los_Angeles",
    "venue_id": "00000000-0000-0000-0000-000000000001",
    "venue": "Staples Center",
   "deal_rating": 0,
   "deal_rating_percentage": 0,
   "performer_id": "00000000-0000-0000-0000-000000000030",
   "performer": "Radiohead",
   "categories": [
     {
       "id": "00000000-0000-0000-0000-000000000300",
       "name": "Music"
     },
     {
       "id": "00000000-0000-0000-0000-000000000301",
       "name": "Alternative Rock"
     }
   ],
   "is_on_sale": true,
   "is_canceled": false,
   "is_out_of_stock": true,
   "rescheduled_from_event_id": null,
   "rescheduled_to_event_id": null
  }],
  ... //And so forth the for other 8 results
}

###GET /events/{:event_id}

Description:	Returns the details of a single event.
Resource:	Events
Method:	GET
Resource Path:	/events/{:event_id} where :event_id is the ScoreBig GUID of the event to retrieve
Example:	GET http://developer.api.scorebig.com/1/events/e595287b-0101-4e4c-b47e-db5f5b15eb29

Returned Object: Event

See object definitions above for object reference.

Example Response:

{
  type: "EventResult",
  count: 9,
  results: [ //Array
    { //Event Results
      "id": "00000000-0000-0000-0000-000000000210",
      "client_id": null,
      "url": "/alternative-rock-tickets/radiohead-in-rainbows-11-18-2010/ios-1/sjoAjBYBKQ?ref_tag=aff.api",
      "name": "Radiohead In Rainbows",
      "local_date_time": "1/1/2019 2:30:00 AM",
      "local_date_time_type": 1,
      "time_zone": "America/Los_Angeles",
      "venue_id": "00000000-0000-0000-0000-000000000001",
      "venue": "Staples Center",
      "deal_rating": 0,
      "deal_rating_percentage": 0,
      "performer_id": "00000000-0000-0000-0000-000000000030",
      "performer": "Radiohead",
      "categories": [
          {
              "id": "00000000-0000-0000-0000-000000000300",
              "name": "Music"
          },
          {
              "id": "00000000-0000-0000-0000-000000000301",
              "name": "Alternative Rock"
          }
      ],
      "is_on_sale": true,
      "is_canceled": false,
      "is_out_of_stock": true,
      "rescheduled_from_event_id": null,
      "rescheduled_to_event_id": null
    }
  ],

  //And so forth the for other 8 results
}