The ShowClix API Class Definitions

This documentation describes the Classes that are available through the API. For each class, the documentation includes:
Please read through ShowClix API Documentation for more details.

Important Links
Classes

https://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).

Examples:

Get an event:
curl --header "X-API-Token: 7476...4a87" http://api.showclix.com/Event/4444

Create an Event
curl --header "X-API-Token: 7476...4a87" -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
curl --header "X-API-Token: 7476...4a87" -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
curl --header "X-API-Token: 7476...4a87" -X DELETE https://api.showclix.com/Event/6454


Attributes
ages, approval_note, approval_user_id, approved, behavior_set, bos_price, cardprinter_layout, 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, 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

Relationships
bundles, event_seats, event_sections, notes, package_child_map, price_levels, products, scheme, section_price_levels, sections, seller, venue

API » EventEvent » Attributes

API » Event » Attributesevent_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesseller_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesvenue_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesevent

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesbehavior_set

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesdescription

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesinventory

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesprivate_event

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesprice

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesbos_price

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesprice_label

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesprice_limit

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesprice_active

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesticket_purchase_timelimit

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesticket_purchase_limit

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributessales_close

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesages

Description:
Required: No
Rule In: 0, 18, 19, 21
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesimage

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesurl

Description:
Required: No
Rule Regex: /^https?:\/\/[a-zA-Z0-9.\-]+\.[a-zA-Z]+(\/.*)?$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesevent_type

Description:
Required: Yes
Rule In: 2, 3
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesticket_note

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesevent_category_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesgenre

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesstatus

Description:
Required: Yes
Rule In: 1, 2, 3, 4, 5, 7, 8
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesnewsletter_sent

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesdonation_live

Description:
Required: No
Rule In: y, n
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesdonation_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesdate_added

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesdate_edited

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesscheme_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributeskeywords

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributessales_open

Description:
Required: Yes
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesevent_start

Description:
Required: Yes
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesevent_end

Description:
Required: No
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesshort_name

Description:
Required: Yes
Rule Regex: /^[a-zA-Z][a-zA-Z0-9_\-]{4,64}$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesparent

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesdisplay_image

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesshow_seating_chart

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributeslevel_description

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesposition

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesapproved

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesapproval_note

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesdate_approved

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesapproval_user_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributestweeted_at

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributestweet_url

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributescombine_additional_fees

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributestos_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Event » Attributesproduct_map

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributeslisting_url

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesimage_url

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributesthumbnail_url

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Event » Attributescardprinter_layout

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » EventEvent » Relationships

API » Event » Relationshipsprice_levels

Relationship Type: hasMany
Links to Class: PriceLevel (https://api.showclix.com/PriceLevel)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/price_levels
Access:
GET HEAD OPTIONS

API » Event » Relationshipsevent_sections

Relationship Type: hasMany
Links to Class: EventSection (https://api.showclix.com/EventSection)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/event_sections
Access:
GET HEAD OPTIONS

API » Event » Relationshipsevent_seats

Relationship Type: hasMany
Links to Class: EventSeat (https://api.showclix.com/EventSeat)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/event_seats
Access:
GET HEAD OPTIONS

API » Event » Relationshipssection_price_levels

Relationship Type: hasMany
Links to Class: SectionPriceLevel (https://api.showclix.com/SectionPriceLevel)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/section_price_levels
Access:
GET HEAD OPTIONS

API » Event » Relationshipsnotes

Relationship Type: hasMany
Links to Class: EventNote (https://api.showclix.com/EventNote)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/notes
Access:
GET HEAD OPTIONS

API » Event » Relationshipspackage_child_map

Relationship Type: hasMany
Links to Class: PackageEventMap (https://api.showclix.com/PackageEventMap)
Through Foreign Key: package_id
Example URI: https://api.showclix.com/Event/<ID>/package_child_map
Access:
GET HEAD OPTIONS

API » Event » Relationshipsvenue

Relationship Type: belongsTo
Links to Class: Venue (https://api.showclix.com/Venue)
Through Foreign Key: venue_id
Example URI: https://api.showclix.com/Event/<ID>/venue
Access:
GET HEAD OPTIONS

API » Event » Relationshipsseller

Relationship Type: belongsTo
Links to Class: Seller (https://api.showclix.com/Seller)
Through Foreign Key: seller_id
Example URI: https://api.showclix.com/Event/<ID>/seller
Access:
GET HEAD OPTIONS

API » Event » Relationshipsscheme

Relationship Type: belongsTo
Links to Class: Scheme (https://api.showclix.com/Scheme)
Through Foreign Key: scheme_id
Example URI: https://api.showclix.com/Event/<ID>/scheme
Access:
GET HEAD OPTIONS

API » Event » Relationshipssections

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/sections
Access:
GET HEAD OPTIONS

API » Event » Relationshipsproducts

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/products
Access:
GET HEAD OPTIONS

API » Event » Relationshipsbundles

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/bundles
Access:
GET HEAD OPTIONS

https://api.showclix.com/MemberMember


A single ticket buyer (customer) in the ShowClix system.
Note: Members accessed by the API may have different data then you see
through the web interface. We allow Members to present different data to
each individual seller, but the API accesses the Member objects directly.

Attributes
address, address_2, city, country, email, first_name, gender, last_name, phone, state, user_id, user_name, zip

Methods
findByEmail, searchSales

Relationships
sales

API » MemberMember » Attributes

API » Member » Attributesuser_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Member » Attributesuser_name

Description:
Required: No
Rule Regex: /^.+|[a-zA-Z0-9_]{8,}$/
Access:
GET HEAD OPTIONS

API » Member » Attributesfirst_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributeslast_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesemail

Description:
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,63})$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesgender

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesaddress

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesaddress_2

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributescity

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributescountry

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesstate

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributeszip

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Member » Attributesphone

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » MemberMember » Methods

API »Member » MethodsfindByEmail

Description: Searches for a Member object given an email address. Note: Members found by this method may have different data then you see through the web interface. We allow Members to present different data to each individual seller, but the API accesses the Member objects directly.
Parameters:
email - required; email address to search forReturns: Member object

API »Member » MethodssearchSales

Description: Find sales completed by a given Member
Parameters:
email - optional; search for a Member by their email. Only use if you don't have access to their Member ID. start_date - optional; find sales completed after the given date (inclusive) end_date - optional; find sales completed before the given date (inclusive)Returns: array of Sale objects

API » MemberMember » Relationships

API » Member » Relationshipssales

Relationship Type: hasMany
Links to Class: Sale (https://api.showclix.com/Sale)
Through Foreign Key: user_id
Example URI: https://api.showclix.com/Member/<ID>/sales
Access:
GET HEAD OPTIONS

https://api.showclix.com/PartnerPartner


Attributes
home_url, locale, partner_id, partner_name

Relationships
events, sellers, venues

API » PartnerPartner » Attributes

API » Partner » Attributespartner_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Partner » Attributespartner_name

Description:
Required: Yes
Rule : N/A
Access:
GET HEAD OPTIONS

API » Partner » Attributeslocale

Description:
Required: Yes
Rule : N/A
Access:
GET HEAD OPTIONS

API » Partner » Attributeshome_url

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » PartnerPartner » Relationships

API » Partner » Relationshipssellers

Relationship Type: hasMany
Links to Class: Seller (https://api.showclix.com/Seller)
Through Foreign Key: partner_id
Example URI: https://api.showclix.com/Partner/<ID>/sellers
Access:
GET HEAD OPTIONS

API » Partner » Relationshipsevents

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Partner/<ID>/events
Access:
GET HEAD OPTIONS

API » Partner » Relationshipsvenues

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Partner/<ID>/venues
Access:
GET HEAD OPTIONS

https://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, box_office_hide, description, event_id, increment_by, level, level_id, limit, min_price, parent_id, position, price, ticket_layout_id, transaction_limit, upsell_price

Relationships


API » PriceLevelPriceLevel » Attributes

API » PriceLevel » Attributeslevel_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesevent_id

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesprice

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesmin_price

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesbos_price

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributeslevel

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributeslimit

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesactive

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesdescription

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesparent_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesposition

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesincrement_by

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributestransaction_limit

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesticket_layout_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesupsell_price

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevel » Attributesbox_office_hide

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » PriceLevelPriceLevel » Relationships

No relationships accessible from the API

https://api.showclix.com/SaleSale


Attributes
addl_fees_total, address, address_2, buyer_fee, buyer_fee_covered, cardnumber, city, confirmation_number, country, currency, custom_buyer_fee, date, delivery_fee, delivery_type, discount, donation, email, event_id, first_four, is_POS, payment_method, phone, purchase_for, sale_id, seller_fee, seller_id, service_fee_discount, state, tickets, total_cost, transaction_id, user_id, venue_fee, zip

Methods
search

Relationships
cancel_set, ticket_set

API » SaleSale » Attributes

API » Sale » Attributessale_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesevent_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesseller_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesuser_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributestransaction_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributestickets

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesconfirmation_number

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributestotal_cost

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesbuyer_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesseller_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesbuyer_fee_covered

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributescustom_buyer_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesaddl_fees_total

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesservice_fee_discount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesdonation

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesvenue_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesdelivery_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesdelivery_type

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesdiscount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributescardnumber

Description:
Required: No
Rule Regex: /^\d{13,16}|\d{4}$/
Access:
GET HEAD OPTIONS

API » Sale » Attributesfirst_four

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesdate

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesaddress

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesaddress_2

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributescity

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesstate

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributeszip

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributescountry

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesphone

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributesemail

Description:
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,63})$/
Access:
GET HEAD OPTIONS

API » Sale » Attributespurchase_for

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Sale » Attributesis_POS

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributespayment_method

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Sale » Attributescurrency

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » SaleSale » Methods

Description: Find completed sales
Parameters:
email - optional; search for a Member by their email. Only use if you don't have access to their Member ID. start_date - optional; find sales completed after the given date (inclusive) end_date - optional; find sales completed before the given date (inclusive) event - optional; ID of event to narrow the search to seller - optional; ID of seller to narrow search to (only available if authenticated as a partner level user)Returns: array of Sale objects

API » SaleSale » Relationships

API » Sale » Relationshipsticket_set

Relationship Type: hasMany
Links to Class: Ticket (https://api.showclix.com/Ticket)
Through Foreign Key: sale_id
Example URI: https://api.showclix.com/Sale/<ID>/ticket_set
Access:
GET HEAD OPTIONS

API » Sale » Relationshipscancel_set

Relationship Type: hasMany
Links to Class: TicketCanceled (https://api.showclix.com/TicketCanceled)
Through Foreign Key: sale_id
Example URI: https://api.showclix.com/Sale/<ID>/cancel_set
Access:
GET HEAD OPTIONS

https://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_on_email, show_recaptcha, show_twitter, whos_going

Relationships
creator, events

API » SchemeScheme » Attributes

API » Scheme » Attributesscheme_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributescreator_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesscheme_name

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesprimary_color

Description:
Required: Yes
Rule : N/A
Access:
GET HEAD OPTIONS

API » Scheme » Attributessecondary_color

Description:
Required: Yes
Rule : N/A
Access:
GET HEAD OPTIONS

API » Scheme » Attributesbackground_color

Description:
Required: Yes
Rule : N/A
Access:
GET HEAD OPTIONS

API » Scheme » Attributesbackground_image

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Scheme » Attributesbackground_repeat

Description:
Required: No
Rule In: no-repeat, repeat, repeat-x, repeat-y
Access:
GET HEAD OPTIONS

API » Scheme » Attributesheader_image

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Scheme » Attributescomments

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributeswhos_going

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesdisplay_date

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesis_default

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesshow_recaptcha

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesshow_facebook

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesshow_twitter

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesrounded_corners

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesbackground_position

Description:
Required: No
Rule In: left top, center top, right top
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesbackground_attachment

Description:
Required: No
Rule In: fixed, scroll
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributescustom_css

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Scheme » Attributesshow_on_email

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » SchemeScheme » Relationships

API » Scheme » Relationshipsevents

Relationship Type: hasMany
Links to Class: Event (https://api.showclix.com/Event)
Through Foreign Key: scheme_id
Example URI: https://api.showclix.com/Scheme/<ID>/events
Access:
GET HEAD OPTIONS

API » Scheme » Relationshipscreator

Relationship Type: belongsTo
Links to Class: Seller (https://api.showclix.com/Seller)
Through Foreign Key: creator_id
Example URI: https://api.showclix.com/Scheme/<ID>/creator
Access:
GET HEAD OPTIONS

https://api.showclix.com/SellerSeller


Attributes
address1, address2, city, commission_start_date, country, currency, custom_ticket_url, email, fax, first_name, industry_id, last_name, layout, locale, organization, phone, seller_id, short_name, state, tos, twitter_screen_name, user_id, zip

Relationships
events, partner, venues

API » SellerSeller » Attributes

API » Seller » Attributesseller_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Seller » Attributesfirst_name

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesorganization

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributeslast_name

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesaddress1

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesaddress2

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributescity

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesstate

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributeszip

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributescountry

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesphone

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesfax

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesemail

Description:
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,63})$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesshort_name

Description:
Required: No
Rule Regex: /^[a-zA-Z][a-zA-Z0-9_\-]{4,64}$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesuser_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributescommission_start_date

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributeslocale

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributestos

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributeslayout

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributescustom_ticket_url

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributestwitter_screen_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributesindustry_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Seller » Attributescurrency

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » SellerSeller » Relationships

API » Seller » Relationshipsevents

Relationship Type: hasMany
Links to Class: Event (https://api.showclix.com/Event)
Through Foreign Key: seller_id
Example URI: https://api.showclix.com/Seller/<ID>/events
Access:
GET HEAD OPTIONS

API » Seller » Relationshipspartner

Relationship Type: belongsTo
Links to Class: Partner (https://api.showclix.com/Partner)
Through Foreign Key: partner_id
Example URI: https://api.showclix.com/Seller/<ID>/partner
Access:
GET HEAD OPTIONS

API » Seller » Relationshipsvenues

Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Seller/<ID>/venues
Access:
GET HEAD OPTIONS

https://api.showclix.com/TicketTicket


Attributes
auto_discount, barcode, buyer_fee, comp_amount, cost, discount, donation, event_id, event_seat_id, event_section_id, held, pricing_level_id, purchase_for, reservation_id, sale_id, service_fee, status, ticket_id, user_id

Relationships
event_seat

API » TicketTicket » Attributes

API » Ticket » Attributesticket_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesevent_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesevent_section_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesevent_seat_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributespricing_level_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesuser_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributessale_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributescost

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributescomp_amount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesservice_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesbuyer_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesdiscount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesauto_discount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesdonation

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributespurchase_for

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesheld

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesbarcode

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesstatus

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Ticket » Attributesreservation_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketTicket » Relationships

API » Ticket » Relationshipsevent_seat

Relationship Type: belongsTo
Links to Class: EventSeat (https://api.showclix.com/EventSeat)
Through Foreign Key: event_seat_id
Example URI: https://api.showclix.com/Ticket/<ID>/event_seat
Access:
GET HEAD OPTIONS

https://api.showclix.com/TicketCanceledTicketCanceled


Attributes
auto_discount, barcode, buyer_fee, comp_amount, cost, discount, donation, event_id, event_section_id, held, pricing_level_id, purchase_for, reservation_id, sale_id, service_fee, status, ticket_id, user_id, void_time

Relationships


API » TicketCanceledTicketCanceled » Attributes

API » TicketCanceled » Attributesticket_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesevent_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesevent_section_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributespricing_level_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesuser_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributessale_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributescost

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributescomp_amount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesservice_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesbuyer_fee

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesdiscount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesauto_discount

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesdonation

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributespurchase_for

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesheld

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesbarcode

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesstatus

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesreservation_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceled » Attributesvoid_time

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » TicketCanceledTicketCanceled » Relationships

No relationships accessible from the API

https://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

API » VenueVenue » Attributes

API » Venue » Attributesvenue_id

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Venue » Attributesvenue_name

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesseating_chart_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributescapacity

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesdescription

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesbooking_info

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesimage

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Venue » Attributesseating_chart

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » Venue » Attributesseating_chart_type

Description:
Required: No
Rule In: 2, 3
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesurl

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributescontact_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributescontact_title

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesaddress

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributescity

Description:
Required: Yes
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesstate

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributeszip

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributescountry

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesphone

Description:
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-\.]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesfax

Description:
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-\.]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesemail

Description:
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,63})$/
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributestimezone

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributesstatus

Description:
Required: Yes
Rule In: 2, 3
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributeslat

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributeslng

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » Venue » Attributestimezone_name

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » VenueVenue » Relationships

API » Venue » Relationshipsevents

Relationship Type: hasMany
Links to Class: Event (https://api.showclix.com/Event)
Through Foreign Key: venue_id
Example URI: https://api.showclix.com/Venue/<ID>/events
Access:
GET HEAD OPTIONS

API » Venue » Relationshipssections

Relationship Type: hasMany
Links to Class: VenueSection (https://api.showclix.com/VenueSection)
Through Foreign Key: venue_id
Example URI: https://api.showclix.com/Venue/<ID>/sections
Access:
GET HEAD OPTIONS

API » Venue » Relationshipsseats

Relationship Type: hasMany
Links to Class: VenueSeat (https://api.showclix.com/VenueSeat)
Through Foreign Key: venue_id
Example URI: https://api.showclix.com/Venue/<ID>/seats
Access:
GET HEAD OPTIONS

https://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

API » VenueSellersVenueSellers » Attributes

API » VenueSellers » Attributesvenue_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » VenueSellers » Attributesseller_id

Description:
Required: No
Rule : N/A
Access:
GET PUT POST DELETE HEAD OPTIONS

API » VenueSellers » Attributesdate

Description:
Required: No
Rule : N/A
Access:
GET HEAD OPTIONS

API » VenueSellersVenueSellers » Relationships

API » VenueSellers » Relationshipsvenue

Relationship Type: belongsTo
Links to Class: Venue (https://api.showclix.com/Venue)
Through Foreign Key: venue_id
Example URI: https://api.showclix.com/VenueSellers/<ID>/venue
Access:
GET HEAD OPTIONS

API » VenueSellers » Relationshipsseller

Relationship Type: belongsTo
Links to Class: Seller (https://api.showclix.com/Seller)
Through Foreign Key: seller_id
Example URI: https://api.showclix.com/VenueSellers/<ID>/seller
Access:
GET HEAD OPTIONS