Upload
trinhthu
View
240
Download
0
Embed Size (px)
Citation preview
Fandango Data Feeds - Specification Version PT4.14
Page 2 of 15
Confidential Information © Fandango, Inc. 2012
Table of Contents
Table of Contents ................................................................................................................ 2
Fandango Data Feed ........................................................................................................... 3 Overview ............................................................................................................................... 3 Contents of Fandango Data Feed ......................................................................................... 4
Theaters ................................................................................................................................................ 5 Movies ................................................................................................................................................... 7 Performances ...................................................................................................................................... 11 Editorial Content .................................................................................................................................. 12
Page 3 of 15
Confidential Information © Fandango, Inc. 2012
Fandango Data Feed
Overview
The Fandango Data Feed is an XML feed delivered via FTP on a periodic basis. Partners use this feed to display information regarding theaters, movies, showtimes, and editorial content. In addition, this data is used as the basis for providing theater, movie, and performance search capability in the Partner’s client application. The diagram below depicts the typical process that a Partner would use to work with the Fandango Data Feed. Figure 1 - Fandango Data Feed Process
Page 4 of 15
Confidential Information © Fandango, Inc. 2012
In this process, the Fandango Server will deliver the Fandango Data Feed to the Partner’s FTP site. The Partner will then parse the feed with an XML parser (created by the Partner) and insert and/or update the Partner’s application data store. Users of the Partner’s application are then able to use their client (desktop, mobile phone, TV, or other device) to view the most up-to-date data.
Contents of Fandango Data Feed
The Fandango Data Feed contains the details of all of Fandango’s movies, theaters, performances, and editorial content. It is presented in a series of files using XML as the formatting mechanism. These files are packaged into one compressed file and made available for retrieval via FTP once a day. The performances files are updated every 6 hours and made available for retrieval. The contents and naming conventions of the files are as follows. Note: The file names below contain the date and time the file was generated. This will change appropriately when a file is generated.
File Contents
FandangoDataFeed-20050610-1300.zip This is the compressed file that contains the data files discussed below. This file is updated once daily.
FandangoDataFeed-theaters-20050610-1300.xml
This file contains all of the theaters and their respective data. It includes the Fandango theater ID to be used during communication with the Fandango server, the theater name, address, latitude, longitude, and other theater-related details. This file is updated once daily.
FandangoDataFeed-movies-20050610-1300.xml
This file contains all of the Fandango movies and their respective data. It includes the Fandango movie ID to be used during communication with the Fandango server, the movie title, runtime, rating, synopses, and other movie-related details. This file is updated once daily.
FandangoDataFeed-performances-20050610-1300.xml
This file contains all of the Fandango performances that are displayed on the Fandango web site. It includes the Fandango performance ID to be used during communication with the Fandango server, the performance date, time, and any amenities or restrictions related to the performance. This file is updated every 6 hours.
FandangoDataFeed-editorial-20050610-1300.xml
This file contains all of the Fandango editorial content. It includes the lists that appear on the Fandango home page, the reviews page,
Page 5 of 15
Confidential Information © Fandango, Inc. 2012
and the trailers page. This file is updated once daily.
This section will describe the XML provided in each file and for each entity in that file.
Theaters
File name: FandangoDataFeed-theaters-20050610-1300.xml Note: The file name contains the date and time the file was generated. This will change appropriately when a file is generated. Sample: <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<fandango_data>
<theater_data>
<theater pkey="1" tmsid=”AAAVC” tz=”EST”>
<pos_theater_id>05701</pos_theater_id>
<name>Century 23</name>
<chain_id>CENT</chain_id>
<geographic_location latitude="37.3191" longitude="-121.9493" />
<wired value="true" />
<address>
<line_1>3164 Olsen Drive</line_1>
<city>San Jose</city>
<state>CA</state>
<postal_code>95117</postal_code>
<country>USA</country>
</address>
<phone_number>408-984-5610</phone_number>
<express_code>926</express_code>
<theater_properties>
<thx value="false" />
<stadium_seating value="true" />
<kiosk value="false" />
<game_room value="false" />
<party_room value="false" />
<print_at_home value="true" />
<cafe value="false" />
<preferred_parking value="false" />
<wheelchair_accessible value="true" />
<all_listening_devices value="true" />
</theater_properties>
</theater>
</theater_data>
</fandango_data>
The above XML snippet is a small sample of one theater that would be found in the Fandango Data Feed. The elements in this snippet are described in the table below:
Element Description
<fandango_data> This is the root element that is the container for all other
elements.
<theater_data> This element is the container element for all of the theaters.
Page 6 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
<theater> This element is the container for one theater. The value of the
attribute “pkey” is the internal Fandango key. This value is
important in that it is used to identify the theater when
conversing with the Fandango server. The value of the attribute
“tmsid” is the id assigned to this theater by TMS. This value
is significant if the client application accepts TMS theater
id’s in addition to Fandango theater id’s. The value of the
attribute “tz” is the timezone of the theater.
<pos_theater_id> This element contains the value of the theater ID that the
point-of-sale uses.
<name> The name of the theater.
<chain_id> The chain to which this theater belongs.
<geographic_location> Contains the attributes “latitude” and “longitude” which are
this theater’s geographic location.
<wired> Contains the attribute “value” which is set to the value “true”
if the tickets can be purchased for this theater from Fandango.
<address> The container element for the address of this theater.
<line_1> The first address line.
<line_2> Optional. This element is present if the theater has a second
address line.
<city> The city of this theater.
<state> The state of this theater.
<postal_code> The postal code (U.S. or Canadian) of this theater.
<country> The country of this theater.
<phone_number> The phone number of this theater.
<express_code> The theater express code of this theater. This is used in
applications to provide users with a shortcut method for getting
the details of a theater.
<theater_properties> The container element for the theater’s amenities.
<thx> Indicates that this theater has THX available if the attribute
“value” is set to “true”.
<stadium_seating> Indicates that this theater has stadium seating available if the
attribute “value” is set to “true”.
<kiosk> Indicates that this theater has a kiosk to pick up tickets
available if the attribute “value” is set to “true”.
<game_room> Indicates that this theater has a game room available if the
attribute “value” is set to “true”.
<party_room> Indicates that this theater has a party room available if the
attribute “value” is set to “true”.
Page 7 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
<print_at_home> Indicates that this theater has the ability to accept tickets
printed at home if the attribute “value” is set to “true”.
<café> Indicates that this theater has a cafe available if the
attribute “value” is set to “true”.
<preferred_parking> Indicates that this theater has preferred parking available if
the attribute “value” is set to “true”.
<wheelchair_accessible> Indicates that this theater has wheelchair accessibility
available if the attribute “value” is set to “true”.
<all_listening_devices> Indicates that this theater has listening devices available if
the attribute “value” is set to “true”.
Movies
File name: FandangoDataFeed-movies-20050610-1300.xml Note: The file name contains the date and time the file was generated. This will change appropriately when a file is generated. Sample: <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<fandango_data>
<movie_data>
<movie id="82743" tmsid=”3766” amgid="V 6998">
<title>Harry Potter and the Goblet of Fire</title>
<rating>PG</rating>
<rating_advisory>Violence</rating_advisory>
<genre>Family,Adventure,Fantasy</genre>
<runtime>150</runtime>
<color>True</color>
<sound>SDDS,THX,Dolby Digital</sound>
<subtitles>True</subtitles>
<website>www.wb.com/harrypotter</website>
<lang>English</lang>
<release_date>11/18/2005</release_date>
<wide_release_date>11/18/2005</wide_release_date>
<subsequent_release_date>1/1/2006</subsequent_release_date>
<featured_release>True</featured_release>
<special_messaging>True</special_messaging>
<small_poster>/images/82743sm.jpg</small_poster>
<large_poster>/images/82743lg.jpg</small_poster>
<trailers>
<trailer context=”web” player=”*” id=”483” />
<trailer context=”wap” player=”*” id=”13493” />
<trailer context=”tv” player=”*” id=”AD23” />
</trailers>
<photos>
<photo src=”/images/82743.jpg” alt=”Harry at home” featured=”true” />
</photos>
<keywords>rowling, harry, voldemort, hermione</keywords>
<cast>
<character character_name="Harry Potter" actor_name="Daniel Radcliffe" />
<character character_name="Ron Weasley" actor_name="Rupert Grint" />
<character character_name="Hermione Granger" actor_name="Emma Watson" />
<character character_name="Lord Voldemort" actor_name="John Malkovich" />
Page 8 of 15
Confidential Information © Fandango, Inc. 2012
<character character_name="Albus Dumbledore" actor_name="Michael Gambon" />
<character character_name="Rubeus Hagrid" actor_name="Robbie Coltrane" />
<director>
<director_name>Mike Newell</director_name>
</director>
<writer>
<writer_name>Steven Kloves</writer_name>
</writer>
<producer>
<producer_name>Miss Producer</producer_name>
</producer>
<composer>
<composer_name>Miss Composer</composer_name>
</composer>
</cast>
<synopsis>Harry's fourth year at Hogwarts is marked by the Triwizard
Tournament, in which student representatives from three different wizarding schools
compete in a series of increasingly challenging contests. The competitors are
selected by the goblet of fire, which this year makes a very surprising
anouncement: Hogwarts will have two representatives in the tournament, including
Harry Potter! As if things weren't bad enough, marks of the evil wizard Voldemort
begin appearing, signaling that he is finally ready to come back to the land of the
living.</synopsis>
<long_synopsis>Harry's fourth year at Hogwarts is marked by the Triwizard
Tournament, in which student representatives from three different wizarding schools
compete in a series of increasingly challenging contests. The competitors are
selected by the goblet of fire, which this year makes a very surprising
anouncement: Hogwarts will have two representatives in the tournament, including
Harry Potter!</long_synopsis>
<medium_synopsis>Harry's fourth year at Hogwarts is marked by the Triwizard
Tournament, in which student representatives from three different wizarding schools
compete in a series of increasingly challenging contests.</medium_synopsis>
<short_synopsis>Based Harry finds himself selected as an underaged competitor
in a dangerous multi-wizardary school competition.</short_synopsis>
</movie>
</movie_data>
</fandango_data>
The above XML snippet is a small sample of one movie that would be found in the Fandango Data Feed. The elements in this snippet are described in the table below:
Element Description
<fandango_data> This is the root element that is the container for all other
elements.
<movie_data> This element is the container element for all of the movies.
The value of the attribute "id" is the internal Fandango ID for
this movie. It is used to identify this movie in communication
with the Fandango server. The value of the attribute “tmsid” is
the id that is assigned to this movie by TMS. The value of the
attribute “amgid” is the id that is assigned to this movie by
AMG. These ids are useful if the client application is
accepting TMS and AMG values in addition to Fandango id’s.
<title> The title of the movie.
<rating> The rating of the movie.
<rating_advisory> The reasons for why the movie was given its rating.
Page 9 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
<genre> A comma-separated list of the genres to which this movie
belongs.
<runtime> The length in minutes of this movie.
<color> Set to the color type used for this movie.
<sound> A comma-separated list of the sound formats in which this movie
plays.
<subititles> Set to the value of “True” if the movie is sub-titled.
<website> The official web site for this movie.
<lang> The language this movie in which this movie is playing.
<release_date> The date this movie is initially released in the format
M/D/YYYY.
<wide_release_date> Optional. The date this movie is released world-wide in the
format M/D/YYYY.
<subsequent_release_date> Optional. The date this movie is released subsequent to the
world-wide release date in the format M/D/YYYY.
<featured_release> Set with a value of True if this movie is considered a featured
release by Fandango. A featured release is a movie considered
of significant box office value by Fandango.
<special_messaging> Set with a value of True if this movie has special messaging
associated with it.
<small_poster> The path to the small poster for this movie.
<large_poster> The path to the large poster for this movie.
<trailers> The container for the trailers associated with this movie. A
trailer can be specific to the platform on which the application
runs. For example, a movie may have a web-specific trailer
versus a wap-specific trailer.
<trailer> Holds the properties for a specific trailer of this movie. The
value of the attribute “context” indicates the context for which
this trailer is used. It is the responsibility of the consuming
application to interpret this context and render the correct
trailer interface appropriate to its context. The value of the
attribute “player” indicates the specific player on which this
trailer is played. An “*” for this value indicates the trailer
can be played on all players. The value of the attribute “id”
indicates the trailer id for this trailer. It is typically used
in conjunction with a fixed URL that accepts the id as a
parameter.
<photos> The container for the photos associated with this movie.
<photo> One of the photos for this movie. The value of the attribute
“src” indicates the relative URL to the photo. The value of the
attribute “alt” indicates alternate text or caption to display
along with the photo. The value of the attribute “featured”
indicates whether this is photo is to be displayed in a
prominent manner on the client application. This attribute is
Page 10 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
optional and will not be present if the photo is not featured.
<keywords> A comma-separated list of words that are associated with this
movie. Client applications can use this list for an additional
mechanism by which users can search for this movie.
<cast> The container for the cast members of this movie. There can be
several <character> elements, a <director> element, <producer>
elements, <writer> elements, and a <music> elements.
<character> The value of the attribute "character_name" contains the name of
the character in the movie. The value of the attribute
"actor_name" contains the name of the actor that plays this
character in the movie.
<director> Optional. The container for the directors for this movie. If
the director is not available then this element will not be
present.
<director_name> The name of the director of this movie.
<producer> Optional. The container for the producers of this movie. If
the producer is not available then this element will not be
present.
<producer_name> The name of the producer of this movie.
<writer> Optional. The container for the writers for this movie. If the
writer is not available then this element will not be present.
<writer_name> The name of the writer of this movie.
<composer> Optional. The container for the composers of this movie. If
the composer is not available then this element will not be
present.
<composer_name> The name of the composer of this movie.
<synopsis> The extended synopsis of this movie.
<long_synopsis> Optional. The long synopsis of this movie.
<medium_synopsis> Optional. The medium synopsis of this movie.
<short_synopsis> Optional. The short synopsis of this movie.
Page 11 of 15
Confidential Information © Fandango, Inc. 2012
Performances
File name: FandangoDataFeed-performances-20050610-1300.xml Note: The file name contains the date and time the file was generated. This will change appropriately when a file is generated. Sample: <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<fandango_data>
<movie_data>
<schedule theater="815">
<day date="2005-06-01">
<film movie="85809">
<screening time="11:00:00.000" actual_date="2005-06-01">
<amenitites>
<amenity type="bargain" />
<amenity type="reserved seating" />
</amenitites>
</screening>
</film>
</day>
</movie_data>
</fandango_data>
The above XML snippet is a small sample of one movie playing at one theater on one specific day that would be found in the Fandango Data Feed. The elements in this snippet are described in the table below:
Element Description
<fandango_data> This is the root element that is the container for all other
elements.
<schedule_data> This element is the container element for the entire schedule of
movies.
<schedule> This element is the container element for the schedule of one
theater. The value of the attribute “theater” is the Fandango
theater ID for this theater. It is the same ID found in the
theater data described earlier.
<day> This element is the container element for the schedule of movies
playing on a specific day. The value of the attribute “date”
indicates the day to which this schedule refers. The date is in
the format YYYY-MM-DD.
<film> This element is the container element for the times that this
movie is playing in this theater for this day. The value of the
attribute “movie” contains the Fandango movie ID for this movie.
It is the same ID found in the movie data described earlier.
<screening> This element is the container element for the information
related to this screening. The value for the attribute “time”
indicates the time this movie is playing at this theater for
this day. The time is specified in 24-hour format. The value of
the attribute “actual_date” is the true calendar date that this
movie is playing. This date could be different from the date in
the <day> element if the time for this performance is after
midnight. The format for this date is YYYY-MM-DD.
Page 12 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
<amenities> This element is the parent element of the list of amenities for
this performance. This element will not be present if there are
no amenities.
<amenity> Identifies the amenity associated with this performance. The
value of the attribute “type” contains the name of the amenity.
Editorial Content
File name: FandangoDataFeed-editorial-20050610-1300.xml Note: The file name contains the date and time the file was generated. This will change appropriately when a file is generated. Sample: <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<fandango_data>
<editorial_data>
<otw layout=”3 Large”>
<film id=”87021” alt=”Opening 6/20 in NY” />
<film id=”86010” alt=”Opening 7/1 in LA” />
<film id=”87325” />
</otw>
<cs>
<film id=”2348” alt=”Opens 6/29. Tickets now on sale" />
<film id=”85862” />
<film id=”34505” />
<film id=”86133” />
</cs>
<tbo>
<film id=”85993” alt="$46.9M" />
<film id=”86816” alt="$27.3M" />
<film id=”85909” alt="$11.1M" />
<film id=”84554” alt="$9.7M" />
<film id=”86069” alt="$8.0M" />
<film id=”91178” alt="$6.6M" />
<film id=”85957” alt="$5.5M" />
<film id=”86083” alt="$5.2M" />
<film id=”85812” alt="$3.2M" />
<film id=”89155” alt="$2.6M" />
</tbo>
<featuredlists>
<featured type=”mobile”>
<film id=”63355” />
<film id=”34345” />
<film id=”86133” />
<film id=”84333” />
<film id=”86632” />
</featured>
</featuredlists>
<poll id="12">
<question id="199">HERBIE: FULLY LOADED features the return of the ultimate
car "personality." What is your favorite iconic Hollywood car:</ques>
<ans id="54">Shaguar (Austin Powers)</ans>
Page 13 of 15
Confidential Information © Fandango, Inc. 2012
<ans id="55">The Delorean (Back to the Future)</ans>
<ans id="56">Aston Martin (James Bond)</ans>
<ans id="57">The Batmobile (Batman)</ans>
<ans id="58">Herbie (The Love Bug/Herbie: Fully Loaded)</ans>
<ans id="59">General Lee (Dukes of Hazzard)</ans>
</poll>
<commentator>
<title>A Blockbuster Team</title>
<subtitle>Spielberg & Williams: Hollywood’s Most Dynamic Duo</subtitle>
<author>Richard Horgan, Fandango Film Commentator</author>
<photo>/images/commentator/spielberg1.jpg</photo>
<body>When War of the Worlds arrives in theaters on Wednesday, June 29
(advance tickets on sale now), it will mark the twenty-second collaboration between
producer-director Steven Spielberg and composer John Williams.</body>
</commentator>
<reviews>
<featuredreviews>
<film id=”85135” />
<film id=”85698” />
<film id=”86541” />
<film id=”2564” />
<film id=”86546” />
<film id=”88444” />
<film id=”83215” />
<film id=”64222” />
<film id=”82126” />
<film id=”89633” />
<film id=”86465” />
</featuredreviews>
<tboreviews>
<film id=”87987” />
<film id=”89465” />
<film id=”83454” />
<film id=”87353” />
<film id=”78242” />
<film id=”72124” />
<film id=”83121” />
<film id=”86453” />
<film id=”86558” />
<film id=”83545” />
</tboreviews>
<filmreviews>
<filmreview filmid="85993" source="USAToday.com">
<title>Batman Begins</title>
<author>Mike Clark</author>
<snippet>Christian Bale makes the best Batman since Warner Bros. revived
the franchise in 1989: His voice is right, and the mask fits his face.</snippet>
<body>If Bale's superhero and Katie Holmes' assistant district attorney
were more romantically inclined in Batman Begins, you could imagine her telling her
gal pals, "There's just something about his chin."</body>
</filmreview>
</filmreviews>
</reviews>
<trailers>
<featuredtrailer filmid="87996" />
<intheatertrailers>
<film id=”84655” />
<film id=”89741” />
<film id=”82778” />
<film id=”86574” />
Page 14 of 15
Confidential Information © Fandango, Inc. 2012
<film id=”84663” />
</intheatertrailers>
<newtrailers>
<film id=”83155” />
<film id=”84665” />
<film id=”83288” />
<film id=”83471” />
<film id=”81569” />
</newtrailers>
<mostpopulartrailers>
<film id=”83456” />
<film id=”81984” />
<film id=”82548” />
<film id=”82346” />
<film id=”83251” />
</mostpopulartrailers>
</trailers>
<editorial_data>
</fandango_data>
The above XML snippet is a small sample of one movie playing at one theater on one specific day that would be found in the Fandango Data Feed. The elements in this snippet are described in the table below:
Element Description
<fandango_data> This is the root element that is the container for all other
elements.
<editorial_data> This element is the container element for the editorial content.
<otw> This is the container element for the "Opening this week" list.
The value of the attribute layout contains a description of how
the movies in this list are presented on screen. For example,
"3 Large" indicates the three movies in the list use the large
poster.
<film> This is a generic element that describes a movie for a list.
The value of the attribute "alt" is the alternative or
supporting text to display along with this movie. This
attribute may not be applicable for the context of the list, in
which case it will not be present.
<cs> This is the container element for the "Coming soon" list.
<tbo> This is the container element for the "Top Box Office" list.
<featuredlists> This is the container element for lists that are featured for a
client application. Client applications would typically display
this list prominently in their user interface.
<featured> This is the container element for a single featured list. The
value of the attribute type indicates for which context this
list belongs. For example, the value “mobile” for this
attribute indicates this list is relevant to a mobile client
application.
<poll> This is the container element for the poll and its associated
data. The value of the attribute "id" contains the Fandango ID
for this poll.
Page 15 of 15
Confidential Information © Fandango, Inc. 2012
Element Description
<ques> The question for this poll. The value of the attribute "id"
contains the Fandango ID for this question.
<ans> One of the answers for this poll. The value of the attribute
"id" contains the Fandango ID for this answer.
<commentator> The container element for the commentator article.
<title> The title of the commentator article.
<subtitle> The subtitle of the commentator article.
<author> The author of the commentator article.
<photo> The path to the photo associated with this commentator article.
<body> The body of the commentator article.
<reviews> The container element for the content related to reviews.
<featuredreviews> The container element for the list of featured reviews.
<tboreviews> The container element for the list of Top Box Office reviews.
<filmreviews> The container element for all of the reviews.
<filmreview> The container element for a single review. The value of the
attribute "filmid" is the Fandango ID for this movie. The value
of the attribute "source" is the name of the review source.
<title> The title of this review.
<author> The author of this review.
<snippet> The short teaser text for this review.
<body> The body of this review.
<trailers> The container element for the content related to trailers.
<featuredtrailer> The film that is designated as the featured trailer. The value
of the attribute "filmid" is the Fandango movie ID for this
film.
<intheatertrailers> The container element for the list of "In Theater" trailers.
<newtrailers> The container element for the list of "New" trailers.
<mostpopulartrailers> The container element for the list of "Most popular" trailers.