GovX ticket feed requirements

The GovX tickets site offers discounted access to events and venues for current and former Military, first responders and government employees.

If you would like to list your tickets for sale on GovX, you will need to provide us a file of your inventory that matches the GovX data schema. The easiest way to do this, especially if your inventory changes frequently, is to provide GovX automated access to an inventory feed that we can ingest on a set schedule.

Basic Requirements

File Format:

JSON

Accessibility:

GovX will need to be able to pull the file. Preferably access is provided via an API call over SSL.

Frequency:

Unless your inventory has high-turnover, GovX will retrieve a fresh file to our production environment once per day. However, there should not be a rate-limit on pulling the file as we will pull more frequently in our development and qa environments.

Data dictionary

There are four primary objects in our data structure: Entertainers, Venues, Events and Tickets.

Entertainers

Entertainers are the attraction of the event, including teams, artists, bands, performers, etc. An example of an entertainer in our system is the San Diego Padres.

Field	Required?	Format	Description	Sample Value
Name	Yes	string	The public facing name of the entertainer.	"San Diego Padres"
Parent category	No	string	The category or classification for the entertainers. GovX supports a tree-based category model.	"MLB"
Savings	No	string	Text describing the promotion or discount. Character limit including spaces is 40.	"Save up to 50%"
Logo	No	link to image
Hero image	No	link to image	Dimensions: 1800 x 400. Ideally, file size should not exceed 60KB
Square image	No	link to image	Dimensions: 500 x 500. Ideally, file size should not exceed 30KB

Venues

Venues represent a physical location with an address. An example of a venue in our system is Petco Park.

Field	Required?	Format	Description	Sample Value
Name	Yes	string	The public facing name of the venue.	"Petco Park"
Address	Yes	string	The street address of the venue.	"100 Park Blvd"
City	Yes	string	The city where the venue is located.	"San Diego"
State	Yes	string	The state abbreviation for where the venue is located.	"CA"
Zip	Yes	int	The postal code or zip code for where the venue is located.	"92101"
Parent category	No	string	The category or classification for the venue. Typically a venue is not mapped to a category directly, unless it offers stand alone tickets. An example of this would be Disneyland.	"MLB"
Savings	No	string	Text describing the promotion or discount. Character limit including spaces is 40.	"Save up to 50%"
Logo	No	link to image
Hero image	No	link to image	Dimensions: 1800 x 400. Ideally, file size should not exceed 60KB
Square image	No	link to image	Dimensions: 500 x 500. Ideally, file size should not exceed 30KB

Events

Events occur at a specific date and time. Entertainers and Venues attach to Events. An Event can be linked to only one Venue, but multiple Entertainers. However, only one Entertainer can be designated as primary for the Event. For example, if the event is the San Francisco Giants game against the San Diego Padres at Petco Park, then the home-team (Padres) should be designated as the primary entertainer on the event.

Field	Required?	Format	Description	Sample Value
Name	Yes	string	The public facing name of the event.	"San Diego Padres vs San Francisco Giants"
Primary Entertainer	Yes	int	The Entertainer ID for the primary Entertainer on the Event. In the case of a sporting event, the primary Entertainer would be the home team.	"234234"
Additional Entertainers	No	array	The Entertainer IDs for all Entertainers linked to the Event.	"234234, 4883, 390478"
Venue	Yes	int	The Venue ID for the Venue linked to the Event.	"23474"
Event Start Date / Time	Yes	date / time	The start date and time of the Event. Should be in GMT.	"2017-07-20T23:30:00Z"
Event Start Local Date	Yes	date	The start date in the local timezone of the event.	"2017-07-20"
Event Start Local Time	Yes	time	The start time in the local timezone of the event.	"18:30"
Event Start Date TBA	No	true / false
Event Start Time TBA	No	true / false
Event End Date / Time	No	date / time	The end date and time of the Event. Can be null if single day event. If provided, should be in GMT.	"2017-11-20T23:30:00Z"
Event Info	No	string	A description of the event.

Tickets

A ticket is the product that the customer is purchasing. Tickets can be attached either to an event or a venue. An example of a ticket to an event is entrance to a specific baseball game (i.e. San Francisco Giants vs San Diego Padres on July 20, 2017 at 6:30 pm). An example of a venue ticket might be a one-day pass to Disneyland. Since it is not tied to an event happening on a specific day, it is a ticket attached directly to a venue.

Field	Required?	Format	Description	Sample Value
Source	Yes	string	Identifies where GovX sourced the ticket.
Ticket Type	Yes	string	Identifies whether the ticket is a venue ticket or an event ticket.
Name	No	string	The name of the ticket. Only used for venue tickets.	"Disneyland one-day pass"
Description	No	string	Text describing the ticket.
Ticket Link	Yes	URL	The url-endpoint where we are directing the customer to complete their purchase.
Savings	No	string	Text describing the savings for the ticket purchase. Character limit including spaces is 20.	"Save 50%"
Ticket Available Start	No	date / time	The start date when the ticket is available for sale.	"2017-11-20T23:30:00Z"
Ticket Available End	No	date / time	The end date after which the ticket is no longer available for sale.	"2017-11-20T23:30:00Z"

Getting started

In order to get started, our team will work with you on the following:

Map category schemas. This allows us to place your inventory in the correct category in our taxonomy.
Map your object data dictionary to the GovX schema
Provide sample data file
Provision credentials to access the file