The ShowClix API Class Definitions
This documentation describes the Classes that are available through the API. For each class, the documentation includes:
- Attributes: including a description, whether or not the attribute is required when PUTing or POSTing, a validation rule (either a set of values or a regular expression), and access level denoting the HTTP methods (GET, PUT, POST, DELETE, HEAD, and OPTIONS) available for public and private access
- Relationships: including the type of the relationship (belongsTo, hasMany, or belongsToAndHasMany), target class of the relationship, and foreign key used
- Permissions
- Example usage
Please read through ShowClix API Documentation for more details.
Important Links
-
ShowClix API Documentation
Complete description of how the API works, RESTful Web Services, URI structure, supported HTTP methods, headers and status codes, the authentication process, the Client Library, and more.
-
The PHP Client Library
A PHP library that abstracts the HTTP and authentication process for clients using the API. Available through GitHub.
Classes
http://api.showclix.com/EventEvent
A single event in the ShowClix system. An event must be linked to a Seller
(http://api.showclix.com/Seller) and a Venue (http://api.showclix.com/Venue).
com Examples:
Get an event (as a public unauthenticated user):
curl http://api.showclix.com/Event/4444
Create an Event (where private.key is your private key and certificate.crt is your signed SSL certificate and assuming you are the owner of Seller 678 and Venue 842):
curl -v -s -k --key private.key --cert certificate.crt -X POST -d '{"seller_id":"678","venue_id":"842","event":"Event Title","description":"event desc","inventory":"600","private_event":"0","price":"18.00","price_label":"General Admission","price_limit":"1","ticket_purchase_timelimit":null,"ticket_purchase_limit":null,"will_call_ticketing":null,"ages":"0","image":"20091252630916.jpg","url":"http:\/\/www.jokerprod.com","event_type":"3","ticket_note":null,"genre":"Alternative","status":"5","scheme_id":null,"keywords":null,"sales_open":"2009-09-19 14:39:00","event_start":"2009-11-08 18:30:00","event_end":"0000-00-00 00:00:00","short_name":"","parent":null,"display_image":"1"}' https://api.showclix.com/Event
Edit an Event (where private.key is your private key and certificate.crt is your signed SSL certificate and assuming you are the owner of Seller 678 and Venue 842):
curl -v -s -k --key private.key --cert certificate.crt -X PUT -d '{"event_id":"6454","seller_id":"678","venue_id":"842","event":"My New Event Title","description":"event desc","inventory":"600","private_event":"0","price":"18.00","price_label":"General Admission","price_limit":"1","ticket_purchase_timelimit":null,"ticket_purchase_limit":null,"will_call_ticketing":null,"ages":"0","image":"20091252630916.jpg","url":"http:\/\/www.jokerprod.com","event_type":"3","ticket_note":null,"genre":"Alternative","status":"5","scheme_id":null,"keywords":null,"sales_open":"2009-09-19 14:39:00","event_start":"2009-11-08 18:30:00","event_end":"0000-00-00 00:00:00","short_name":"","parent":null,"display_image":"1"}' https://api.showclix.com/Event/6454
Delete an Event (where private.key is your private key and certificate.crt is your signed SSL certificate):
curl -v -s -k --key private.key --cert certificate.crt -X DELETE https://api.showclix.com/Event/6454
Attributes
ages, approval_note, approval_user_id, approved, behavior_set, bos_price, combine_additional_fees, date_added, date_approved, date_edited, description, display_image, donation_live, donation_name, event, event_category_id, event_end, event_id, event_start, event_type, genre, image, image_url, inventory, keywords, level_description, listing_url, newsletter_sent, parent, position, price, price_active, price_label, price_limit, private_event, product_map, resale_fee_amount, resale_fee_type, sales_close, sales_open, scheme_id, seller_id, short_name, show_seating_chart, status, thumbnail_url, ticket_note, ticket_purchase_limit, ticket_purchase_timelimit, tos_id, tweet_url, tweeted_at, url, venue_id, views
Relationships
bundles, event_seats, event_sections, notes, price_levels, products, scheme, section_price_levels, sections, seller, venue
Description: int. Primary Key. Id of an event.
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. the title of the event.
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. bit set represented as an int. gives characteristics of an event. see clockingIT "note" for more.
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. description of the event. santized to allow limited html supported. no javascript.
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. If set to 1, don't show up in searches and public listings
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule In: 0, 18, 19, 21
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. code relies on these images in a certain dir, should fix to work with full uri with api
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. fk to category table
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Genre of the event. Open Field. e.g. Pop, Classical, Rock, Raffle, etc.
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: datetime. Date the event was added to the system
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: datetime. Date the event was most recently editted
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: datetime. SQL Timestamp of when sales open, stored in venue timezone
Required: Yes
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: datetime. SQL Timestamp of when event starts, stored in venue timezone
Required: Yes
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: datetime. SQL Timestamp of when the event closes, leav blank/null if this is the same as the event start date
Required: No
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. Foriegn Key to a Seller. Required for an event. See http://api.showclix.com/Seller
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Foriegn Key to a Venue. Required for an event. See http://api.showclix.com/Venue
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. total inventory of this event, if a general admission event
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: double. the price of a general admission ticket. additional price levels can bee set with the PriceLevel Class. see http://api.showclix.com/PriceLevel
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: box office GA ticket price
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. name of the general admission base price level
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. the inventory of this price level
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: boolean. Turn the base price level on and off for online sales
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. seconds to complete order. default is 7 minutes.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. max tickets one can purchase in a sale
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. hours:minutes before the start of the event that sales should close
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. url to an external event website
Required: No
Rule Regex: /^https?:\/\/[a-zA-Z0-9.\-]+\.[a-zA-Z]+(\/.*)?$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. 3 for General Admission Event, 2 for an Assigned Seating Event
Required: Yes
Rule In: 2, 3
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. Short text to appear on the bottom of the print at home ticket e.g. "Doors open at 6:00pm"
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Number of Views this Event listing has had on ShowClix
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Description: int. Events can be setup in stages. A status of 5 means the even is completely setup. A status of 4 means the event is in Preview Mode - only the seller can view the listing on ShowClix. 3, 2, and 1 each mean that the event is not complete and can be used to represent different stages in an event process if desired. 6 = canceled, 7 = paused, 8 = suspended.
Required: Yes
Rule In: 1, 2, 3, 4, 5, 7, 8
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Has the seller sent out a newsletter for this event?
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Description: string. Should ShowClix accept donations for the seller? Set to 'y' if so.
Required: No
Rule In: y, n
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. The name of the charity or organization being donated to
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Foriegn Key to Scheme (the color scheme object for this event listing)
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. Comma Seperated List of additional keywords for this event
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. An alias name (slug) that can be used in the event listing URL e.g. http://www.showclix.com/event/NICKNAME. Useful for SEO.
Required: No
Rule Regex: /^[a-zA-Z][a-zA-Z0-9_\-]{4,32}$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Foriegn Key to an Event if this event was duplicated from another
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Description: int. A value of 1 will show the events image as part of the event listing on ShowClix
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. A value of 1 will bring up the link to the venue seating chart (used to be set in the color_schemes table)
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. optional base level description
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: The service fee charged on tickets for the base price level
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: The service fee type for tickets resold on the base price level (1=flat, 2=percent of resale amount)
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. 1=approved for launch, 0=pending, -1=rejected
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: datetime
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. the id of the tweet that was sent
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Relationship Type: hasMany
Links to Class: PriceLevel (http://api.showclix.com/PriceLevel)
Through Foreign Key: event_id
Example URI: http://api.showclix.com/Event/<ID>/price_levels
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: EventSection (http://api.showclix.com/EventSection)
Through Foreign Key: event_id
Example URI: http://api.showclix.com/Event/<ID>/event_sections
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: EventSeat (http://api.showclix.com/EventSeat)
Through Foreign Key: event_id
Example URI: http://api.showclix.com/Event/<ID>/event_seats
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: SectionPriceLevel (http://api.showclix.com/SectionPriceLevel)
Through Foreign Key: event_id
Example URI: http://api.showclix.com/Event/<ID>/section_price_levels
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: EventNote (http://api.showclix.com/EventNote)
Through Foreign Key: event_id
Example URI: http://api.showclix.com/Event/<ID>/notes
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Venue (http://api.showclix.com/Venue)
Through Foreign Key: venue_id
Example URI: http://api.showclix.com/Event/<ID>/venue
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Seller (http://api.showclix.com/Seller)
Through Foreign Key: seller_id
Example URI: http://api.showclix.com/Event/<ID>/seller
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Scheme (http://api.showclix.com/Scheme)
Through Foreign Key: scheme_id
Example URI: http://api.showclix.com/Event/<ID>/scheme
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Event/<ID>/sections
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Event/<ID>/products
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Event/<ID>/bundles
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
http://api.showclix.com/PartnerPartner
Attributes
home_url, locale, partner_name
Relationships
events, sellers, venues
Description:
Required: Yes
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: Seller (http://api.showclix.com/Seller)
Through Foreign Key: partner_id
Example URI: http://api.showclix.com/Partner/<ID>/sellers
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Partner/<ID>/events
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Partner/<ID>/venues
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
http://api.showclix.com/PriceLevelPriceLevel
PriceLevels represent additional price levels for an event. Every price level that a seller wishes to add must be added by creating a new PriceLevel instance.
PriceLevels are only valid for Events at General Admission Venues (meaning they are not seated venues).
To get all price levels for an event, you can use the custom URI http://www.showclix.com/rest.api/Event//all_levels
Attributes
active, bos_price, description, event_id, increment_by, level, level_id, limit, parent_id, position, price, resale_fee_amount, resale_fee_type, transaction_limit
Relationships
Description:
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: float. online price
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: float. box office price
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: bool. defaults to 1
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: Online listing page increments the purchase tickets on this price level by this number
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: The service fee charged on tickets for the price level
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: The service fee type for tickets resold on the price level (1=flat, 2=percent of resale amount)
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: Individual price level transaction limit
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Description: int. The max number of tickets that can be sold for this PL. A value of 0 or otherwise <= than the number of tix sold effectively disables the PL, but it will still be displayed on the event page in contrast to inactivating it. NULL means ulimited (defaults to the event limit)
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. Used for linking to parent price levels with recurring events
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
No relationships accessible from the API
http://api.showclix.com/SchemeScheme
Schemes (aka Color Schemes) are stored templates for event listings. These color schemes can be attached to events to change the "look and feel" of the event listing. Usually this is done to allow sellers to match their existing website or branding.
Schemes are composed of several color and image options. All images should be provided in full URL format (e.g. "http://example.com/my-image.jpg"). All colors are stored as hex values WITHOUT a leading hash (#) or "0x" (e.g. "FFFFFF").
Attributes
background_attachment, background_color, background_image, background_position, background_repeat, comments, creator_id, custom_css, display_date, header_image, hide_map_link, is_default, primary_color, rounded_corners, scheme_id, scheme_name, secondary_color, show_facebook, show_recaptcha, show_twitter, whos_going
Relationships
creator, events
Description: string. color of headings and ticket box. hex (no leading # or 0x) e.g. FFFFFF
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. color of description font and accents. hex (no leading # or 0x) e.g. FFFFFF
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. color of the background of the event listing. hex (no leading # or 0x) e.g. FFFFFF
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Filename of seating chart image. full image URL e.g. http://example.com/my-image.jpg
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. full URL to image
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. primary key
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. foreign key to seller id
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. name of the color scheme/template
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule In: no-repeat, repeat, repeat-x, repeat-y
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: bool. show user comments in the event listing?
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: bool. display the date as part of the event listing?
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: bool. require captcha to be solved for bot protection
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: bool. rounded corners on checkout
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: background image position
Required: No
Rule In: left top, center top, right top
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: background image: fixed or scroll
Required: No
Rule In: fixed, scroll
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: a custom CSS blob that the user can type in.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Relationship Type: hasMany
Links to Class: Event (http://api.showclix.com/Event)
Through Foreign Key: scheme_id
Example URI: http://api.showclix.com/Scheme/<ID>/events
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Seller (http://api.showclix.com/Seller)
Through Foreign Key: creator_id
Example URI: http://api.showclix.com/Scheme/<ID>/creator
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
http://api.showclix.com/SellerSeller
Attributes
address1, address2, city, commission_start_date, country, custom_ticket_url, email, fax, first_name, google_analytics_id, last_name, layout, locale, organization, phone, seller_id, short_name, state, tos, twitter_screen_name, user_id, zip
Relationships
events, partner, venues
Description: string. seller's organization
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. Primary key of seller
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Description: string. first name of seller
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. last name of sellet
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. seller's address
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. Two letter state abbreviation.
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. Post code for the seller.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: Yes
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: Yes
Rule Regex: /^((?:(?:(?:[a-zA-Z0-9][\.\-\+_#]?)*)[a-zA-Z0-9]?[\.\-\+_#]?)+)\@((?:(?:(?:[a-zA-Z0-9][\.\-_#]?){0,62})[a-zA-Z0-9])+)\.([a-zA-Z0-9]{2,6})$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. An alias (slug) for this seller. This will also "create" the URL http://SHORT_NAME.showclix.com for this seller. This URL will list their events.
Required: No
Rule Regex: /^[a-zA-Z][a-zA-Z0-9_\-]{4,32}$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. authoritative user for this seller.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. ISO 639.1/639.2 + ISO 3166 format of language_COUNTRY (e.g. en_US)
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. tos
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: custom ticket layout
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: custom ticket background
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule Regex: /^[a-z\-0-9]{8,20}$/i
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description:
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Relationship Type: hasMany
Links to Class: Event (http://api.showclix.com/Event)
Through Foreign Key: seller_id
Example URI: http://api.showclix.com/Seller/<ID>/events
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasManyThru
Example URI: http://api.showclix.com/Seller/<ID>/venues
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Partner (http://api.showclix.com/Partner)
Through Foreign Key: partner_id
Example URI: http://api.showclix.com/Seller/<ID>/partner
Access:
GET: Private
HEAD: Private
OPTIONS: Private
http://api.showclix.com/VenueVenue
Venue represents the location where an event is occurring. All events
must have a venue associated with it. Venues and Sellers is a many to
many relationship mapped through VenueSellers
Attributes
address, booking_info, capacity, city, contact_name, contact_title, country, description, email, fax, image, lat, lng, phone, seating_chart, seating_chart_name, seating_chart_type, state, status, timezone, timezone_name, url, venue_id, venue_name, zip
Relationships
events, seats, sections
Description: int. primary key.
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string.
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. A way to differenciate between multiple seating setups at the same venue
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int. The maximum capacity of this venue
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. A text description of this venue
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Filename of image. May allow base64 encoded POSTing/PUTting in the future but not supported at the moment.
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Filename of seating chart image. May allow base64 encoded POSTing/PUTting in the future but not supported at the moment.
Required: No
Rule : N/A
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string.
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string.
Required: Yes
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Geo::$states,
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: int.
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Geo::$countries
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: double. The Venue's Latitude. This is an approximation.
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: double. The Venue's Longitude. This is an approximation.
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. the ZONE/NAME style timezone name. replaces the old hourly offset method.
Required: No
Rule : N/A
Access:
GET: Public, Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Public, Private
OPTIONS: Public, Private
Description: string. Additional information about bookings at this venue
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. 2 for static image. 3 for swf.
Required: No
Rule In: 2, 3
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. URL to this venue's website.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. Full name of the Contact for the venue.
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string. The Contact's title at the Venue or relationship with the venue. E.g. Promoter
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: string.
Required: No
Rule Regex: /^((?:(?:(?:[a-zA-Z0-9][\.\-\+_#]?)*)[a-zA-Z0-9]?[\.\-\+_#]?)+)\@((?:(?:(?:[a-zA-Z0-9][\.\-_#]?){0,62})[a-zA-Z0-9])+)\.([a-zA-Z0-9]{2,6})$/
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. The UTC offset for this venue's timezone. E.g. -5 for UTC-5 Eastern Standard Time. Deprecated now...
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. The type of the venue: 2 if basic, 3 if seated. Seated Venues will need to be setup through ShowClix. Please contact ShowClix if you wish to create a seated venue.
Required: Yes
Rule In: 2, 3
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Relationship Type: hasMany
Links to Class: Event (http://api.showclix.com/Event)
Through Foreign Key: venue_id
Example URI: http://api.showclix.com/Venue/<ID>/events
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: VenueSection (http://api.showclix.com/VenueSection)
Through Foreign Key: venue_id
Example URI: http://api.showclix.com/Venue/<ID>/sections
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: hasMany
Links to Class: VenueSeat (http://api.showclix.com/VenueSeat)
Through Foreign Key: venue_id
Example URI: http://api.showclix.com/Venue/<ID>/seats
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
http://api.showclix.com/VenueSellersVenueSellers
Maps a seller to a venue. Makes that seller an admin of a venue.
Attributes
date, seller_id, venue_id
Relationships
seller, venue
Description: int. foreign key to Venue
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: int. foreign key to Seller
Required: No
Rule : N/A
Access:
GET: Private
PUT: Private
POST: Private
DELETE: Private
HEAD: Private
OPTIONS: Private
Description: datetime. time when venue was added to system. set automatically by a hook.
Required: No
Rule : N/A
Access:
GET: Private
HEAD: Private
OPTIONS: Private
Relationship Type: belongsTo
Links to Class: Venue (http://api.showclix.com/Venue)
Through Foreign Key: venue_id
Example URI: http://api.showclix.com/VenueSellers/<ID>/venue
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private
Relationship Type: belongsTo
Links to Class: Seller (http://api.showclix.com/Seller)
Through Foreign Key: seller_id
Example URI: http://api.showclix.com/VenueSellers/<ID>/seller
Access:
GET: Public, Private
HEAD: Public, Private
OPTIONS: Public, Private