Skip to content

Schedule JSON Format

WillieBHines edited this page Apr 15, 2012 · 2 revisions

The DCM web server will the marathon schedule in a standard format that all clients will use to display showtimes.

Sample: http://delclosemarathon.com/dcm13/schedules/viewjson

The top level is a JSON dictionary with the following keys: (this is a rough draft based on the existing database and should be given some thought)

  • venues
    • id (must be stable across schedule updates)
    • name
    • short_name
    • address
    • directions
    • image (image size?)
    • gmaps
    • url
    • latitude
    • longitude
  • shows
    • id (must be stable across schedule updates)
    • show_name
    • home_theatre_id
    • home_city
    • performers (an array of cast ids)
    • image
    • is_late_night
    • is_college
    • is_made_for_dcm
  • schedules
    • id (must be stable across schedule updates)
    • show_id
    • venue_id
    • start_time
    • duration_minutes
    • tickets (what is this? a link for buying tickets?)
  • home_theatres
    • id (could change across schedule updates)
    • name
  • performers
    • id (could change across schedule updates)
    • name

General Notes

Items should have a fixed ID number that is guaranteed not to change between schedule versions, so that apps can migrate "favorites" between schedule updates. (We can probably just use the database ID number.)

Some items, such as home theatres, are stored as both a separate table (if it's popular enough) and on the shows table (if it's an "other" theatre). We should do our best to clean this up and normalize the data for the app. We might have to drop the guarantee of IDs being stable in this case.

Clone this wiki locally