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 available HTTP methods (GET, PUT, POST, DELETE, HEAD, and OPTIONS).
- 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
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" https://www.showclix.com/rest.api/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://www.showclix.com/rest.api/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://www.showclix.com/rest.api/Event/6454
Delete an Event
curl --header "X-API-Token: 7476...4a87" -X DELETE https://www.showclix.com/rest.api/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, doors_open_time, event, event_category_id, event_end, event_id, event_start, event_talents, event_type, image, image_url, inventory, keywords, level_description, listing_url, newsletter_sent, parent, position, price, price_active, price_label, price_limit, private_event, product_map, raw_description, 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, child_events, event_seats, event_sections, notes, package_child_map, price_levels, price_levels_groups, products, scheme, section_price_levels, sections, seller, talents, venue
Description: int. Primary Key. Id of an event.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Foriegn Key to a Seller. Required for an event. See http://api.showclix.com/Seller
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. Foriegn Key to a Venue. Required for an event. See http://api.showclix.com/Venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. the title of the event.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. bit set represented as an int. gives characteristics of an event. for example, 3 : an event series placeholder event, 5: a package placeholder event.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. description of the event. sanitized to allow limited html supported. no javascript.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. total inventory of this event, if a general admission event
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. If set to 1, don't show up in searches and public listings
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: deprecated, double. the price of a general admission ticket.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: deprecated, box office GA ticket price
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: deprecated, string. name of the general admission base price level
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: deprecated, int. the inventory of this price level
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: deprecated, Turn the base price level on and off for online sales
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. seconds to complete order. default is 7 minutes.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. max tickets one can purchase in a sale
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. hours:minutes before the start of the event that sales should close
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule Regex: /^(\d\d\d\d-\d\d-\d\d( \d\d\:\d\d:\d\d)?)|(NOW)$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule In: 0, 16, 17, 18, 19, 21
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Description: string. url to an external event website
Required: No
Rule Regex: /^https?:\/\/[a-zA-Z0-9.\-]+\.[a-zA-Z]+(\/.*)?$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. 3 for General Admission Event, 2 for an Assigned Seating Event
Required: Yes
Rule In: 2, 3
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. fk to category table
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. Has the seller sent out a newsletter for this event?
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. Should ShowClix accept donations for the seller? Set to 'y' if so.
Required: No
Rule In: y, n
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. The name of the charity or organization being donated to
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: datetime. Date the event was added to the system
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: datetime. Date the event was most recently editted
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Foriegn Key to Scheme (the color scheme object for this event listing)
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Comma Seperated List of additional keywords for this event
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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: Yes
Rule Regex: /^(?![0-9]*$)[a-zA-Z0-9_\-]{5,64}$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. Foriegn Key to an Event if this event was duplicated from another
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. optional base level description
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. 1=approved for launch, 0=pending, -1=rejected
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. note about approval status. mostly used for rejection.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: datetime
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. the id of the tweet that was sent
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Relationship Type: hasMany
Links to Class: App\Resource\Event\PriceLevel\PriceLevelGroup (https://api.showclix.com/App\Resource\Event\PriceLevel\PriceLevelGroup)
Through Foreign Key: event_id
Example URI: https://api.showclix.com/Event/<ID>/price_levels_groups
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Relationship Type: hasMany
Links to Class: Event (https://api.showclix.com/Event)
Through Foreign Key: parent
Example URI: https://api.showclix.com/Event/<ID>/child_events
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/sections
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/products
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/bundles
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Event/<ID>/talents
Access:
GET
PATCH
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, last_name, opt_out, phone, state, user_id, user_name, zip
Methods
findByEmail, searchSales
Relationships
sales
Description: int. Primary Key. Id of member
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. unique handle. autogenerated for the most part now.
Required: No
Rule Regex: /^.+|[a-zA-Z0-9_]{8,}$/
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. Member first name
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member last name
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member email address
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
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. First line of Member address
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Second line of Member address (if applicable)
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member city
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member country code
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member's geographical state
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member postal code
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Member phone number
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
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
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
PATCH
HEAD
OPTIONS
https://api.showclix.com/MemberAttributeDefinitionMemberAttributeDefinition
Attributes
attribute_id, choices, description, name, seller_id, type, validator
Relationships
Description:
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
No relationships accessible from the API
https://api.showclix.com/PartnerPartner
Attributes
home_url, locale, partner_id, partner_name
Relationships
events, sellers, venues
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Partner/<ID>/events
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Partner/<ID>/venues
Access:
GET
PATCH
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, discount_type, discount_val, event_id, increment_by, level, level_id, limit, min_price, parent_id, position, price, subheading, ticket_layout_id, transaction_limit, upsell_price
Relationships
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: float. online price
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: float. online price
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: float. box office price
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: bool. defaults to 1
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. Used for linking to parent price levels with recurring events
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: Online listing page increments the purchase tickets on this price level by this number
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: Individual price level transaction limit
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: float. price to sell at when upselling
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: bool Ignored by individual seats for now - goes off of EventSection
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string The discount type being applied for Event Upsells
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: float Discount Amount being applied. Corresponds to the the discount_type
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
No relationships accessible from the API
https://api.showclix.com/SaleSale
Attributes
addl_fees_total, address, address_2, buyer_fee, buyer_fee_covered, capture_method, cardnumber, city, confirmation_number, country, currency, custom_buyer_fee, date, delivery_fee, delivery_type, discount, donation, email, event_id, first_four, locale, 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
Description: int. Primary Key. ID of Sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Foreign Key to an Event. See http://api.showclix.com/Event
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Foregin Key to a Seller. See http://api.showclix.com/Seller
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Foreign Key to a Member. See http://api.showclix.com/Member
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. id returned from the gateway used
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. number of tickets in sale.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. Confirmation number used internally to track this sale.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. Total cost of this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. probably the most confusing attribute name. this is the TOTAL SERVICE FEE
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. the amount of the service fee covered BY THE SELLER
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. % of fee covered by seller. 0 thru 100.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. Any custom fees setup for this seller
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. Total of any and all additional fees
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. The amount of any service fee discounts, if applicable
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. The amount of a donation received on this sale, if any
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. The amount of a venue-specific fee, if any
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. The amount of a delivery fee, if any
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. The type of delivery
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. The amount of any discounts, if any
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. last four digits of credit card
Required: No
Rule Regex: /^\d{13,16}|\d{4}$/
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. first 4 digits of the credit card number determines type
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: datetime. Time of sale (format 'YYYY:MM:dd HH:mm:ss')
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. First line of the address used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. Second line of the address used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. City used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment.string. Geographical state used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. Postal code used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. Country code used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on ReservationPayment. string. Phone number used for this sale
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: deprecated, now set on Reservation. string. Email address used for this order
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
PATCH
HEAD
OPTIONS
Description: string. Name of the person this sale was purchased for, if different than the person paying
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. fk to PaymentType. the method of payment. in the case of multiple payments, becomes PAYMENT_SPLIT
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. Three Char ISO 4217 currency code (e.g. USD)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. (e.g. en_US)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule In: 1, 2, 3, 4, 5, 10, 9, 6, 7, 8, 11, 12, 14, 13, 15, 16, 17
Access:
GET
PATCH
HEAD
OPTIONS
Description: Find completed sales.
Parameters:
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
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
PATCH
HEAD
OPTIONS
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>/cancel_set
Access:
GET
PATCH
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_bg_image_on_eticket, show_facebook, show_header_image_on_eticket, show_instructions_on_eticket, show_mytickets_on_eticket, show_on_email, show_policy_on_eticket, show_recaptcha, show_twitter, whos_going
Relationships
creator, events
Description: int. primary key
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. foreign key to seller id
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. name of the color scheme/template
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. color of headings and ticket box. hex (no leading # or 0x) e.g. FFFFFF
Required: Yes
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. color of description font and accents. hex (no leading # or 0x) e.g. FFFFFF
Required: Yes
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. color of the background of the event listing. hex (no leading # or 0x) e.g. FFFFFF
Required: Yes
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule In: no-repeat, repeat, repeat-x, repeat-y
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. full URL to image
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: bool. show user comments in the event listing?
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: bool. display the date as part of the event listing?
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: bool. require captcha to be solved for bot protection
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: bool. rounded corners on checkout
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: background image position
Required: No
Rule In: left top, center top, right top
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: background image: fixed or scroll
Required: No
Rule In: fixed, scroll
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: a custom CSS blob that the user can type in.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: show the header image in outbound emails related to the scheme
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: show the header image in E-Ticket
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: show Background Image in E-Ticket
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: show My Tickets link on E-Ticket
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: make policy available on E-Tickets page
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: display instructions on E-Tickets page
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
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, salesforce_id, seller_id, short_name, state, twitter_screen_name, user_id, vanity_url, zip
Methods
eventFilter
Relationships
events, partner, scan_contexts, schemes, venues
Description: int. Primary key of seller
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. first name of seller
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. seller's organization
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. last name of sellet
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. seller's address
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Two letter state abbreviation.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Post code for the seller.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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,63})$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule Regex: /^(?![0-9]*$)[a-zA-Z0-9_\-]{5,64}$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: No
Rule Regex: /^(?!(admin|admin-demo|ticketingadmin|ticketadmin|promoters)\.)/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: Fetch Seller's Events in batches
Parameters:
int limit - count events per page int start - page index, start from 0 string view - individual (all events), high_level (series parents and single events only), single (single events, neither child events, nor parent events), parent (series parents events only) string range - future, past, recent_forward(future events, including events from the last 48 hours)Returns: array of Event objects
Relationship Type: hasMany
Links to Class: App\Resource\Event\Event (https://api.showclix.com/App\Resource\Event\Event)
Through Foreign Key: seller_id
Example URI: https://api.showclix.com/Seller/<ID>/events
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasMany
Links to Class: Scheme (https://api.showclix.com/Scheme)
Through Foreign Key: creator_id
Example URI: https://api.showclix.com/Seller/<ID>/schemes
Access:
GET
PATCH
HEAD
OPTIONS
Relationship Type: hasMany
Links to Class: App\Resource\Scan\ScanContext (https://api.showclix.com/App\Resource\Scan\ScanContext)
Through Foreign Key: seller_id
Example URI: https://api.showclix.com/Seller/<ID>/scan_contexts
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Relationship Type: hasManyThru
Example URI: https://api.showclix.com/Seller/<ID>/venues
Access:
GET
PATCH
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
Methods
seatInfo
Relationships
event_seat
Description: int. Primary Key
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Event foreign key
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. EventSection foreign key
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. PriceLevel foreign key
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Member foreign key.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. Sale foreign key.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: original "face value" of the ticket. Will be set to zero in the case of a comp checkout type, but will keep its original value if comp is triggered by automatic discount or discount coupon(s)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. POSITIVE. amount comped on this ticket. Used when the order is comped via COMP payment method or a comp coupon.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. the TOTAL SERVICE FEE on this ticket
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. the amount of the service fee PAID BY THE BUYER
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. NEGATIVE. amount of discount applied to just this ticket and only as a result of discount coupons. Used for discount and comp coupons.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. NEGATIVE. fk to CouponOffer. amount of the automatic discount applied to this ticket (typically one ticket per order)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: float. donation amount associated with this ticket (this will appear on only one ticket per event)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. the name attached to this ticket (if one is directly attached)
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: datetime. time the ticket was originalyl held (a.k.a. added to cart).
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string. Barcode for this ticket.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: Fulfillment status -- see ticket status types below -> Default to 1?
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: int. fk to reservation
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description:
Parameters:
Returns:
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
PATCH
HEAD
OPTIONS
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, seatsio_id, state, status, timezone, timezone_name, url, venue_id, venue_name, zip
Relationships
seats, sections
Description: int. primary key.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
Description: string.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. A way to differenciate between multiple seating setups at the same venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. The maximum capacity of this venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. A text description of this venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Additional information about bookings at this venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
Description: int. 2 for static image. 3 for swf.
Required: No
Rule In: 2, 3
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. URL to this venue's website.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Full name of the Contact for the venue.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. The Contact's title at the Venue or relationship with the venue. E.g. Promoter
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Core\Geo::$states,
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. Core\Geo::$countries
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-\.]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string.
Required: No
Rule Regex: /^(?:\+?(?:1|\d{2}|011))?(?:[\s\-\.]?\(?\d{2,4}\)?){2,4}(?:x\d{1,5})?$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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,63})$/
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description:
Required: Yes
Rule In: 2, 3
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: double. The Venue's Latitude. This is an approximation.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: double. The Venue's Longitude. This is an approximation.
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. the ZONE/NAME style timezone name. replaces the old hourly offset method.
Required: Yes
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: string. the seatsio id of the currently assigned seating chart
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
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
Description: int. foreign key to Venue
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: int. foreign key to Seller
Required: No
Rule : N/A
Access:
GET
PUT
PATCH
POST
DELETE
HEAD
OPTIONS
Description: datetime. time when venue was added to system. set automatically by a hook.
Required: No
Rule : N/A
Access:
GET
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS
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
PATCH
HEAD
OPTIONS