Appmiral Timetable Importer v2 (deprecated)

Separating artists & performances.

Warning: This version of the Appmiral Timetable Importer is deprecated. It is still operational but no longer maintained. For new applications, please use the Appmiral Timetable Importer v3.

Introduction

The Appmiral Timetable Importer allows you to import timetable information from other systems into Appmiral and keep them in sync. It reads content from an XML or JSON and adds or updates the contents into the Appmiral database, where it is structured as Artists, Stages and Performances. This importer expects 2 XMLs or JSONs: one for stages and one for artists and their performances. These XMLs/JSONs can be static files hosted online or API endpoints.

Every 15 minutes, the importer will download the XMLs/JSONs and sync the contents to the Appmiral database. This means that when the timetable is changed in the original XMLs/JSONs, it takes a maximum of 15 minutes before those changes are reflected in the Appmiral CMS and the app.

Differences from v1

The v1 Timetable Importer did not make the distinction between artists and performances, meaning every performance also created an artist in the Appmiral database. This caused issues when the same artist performed multiple times. Also artist descriptions can now contain HTML.

Stages

Stage Model

Field	Required	Type	Description
id	Yes	string	The ID of the stage. Has to be unique for each stage.
name	Yes	string	The name of the stage.
priority	No	integer	The priority of the stage. This determines the position of the stage on various screens in the app. Default is 100.
color	No	string	The color representing the stage. This color will be used on various screens in the app where the stage is mentioned. In HEX format including the #. e.g. "#FF0000".

Stage JSON Example

{
  "stages": [
    {
      "id": "1",
      "name": "Main Stage",
      "priority": 1,
      "color": "#FF0000"
    },
    {
      "id": "dance_hall",
      "name": "Dance Hall",
      "priority": 2,
      "color": "#00FF00"
    }
  ]
}

Stage XML Example

<stages> 
  <stage id="1">
    <name><![CDATA[ Main Stage ]]></name> 
    <priority>1</priority> 
    <color><![CDATA[ #FF0000 ]]></color> 
  </stage> 
  <stage id="dance_hall"> 
    <name><![CDATA[ Dance Hall ]]></name> 
    <priority>2</priority> 
    <color><![CDATA[ #00FF00 ]]></color> 
  </stage>
</stages>

Artists

Artist Model

Field	Required	Type	Description
id	Yes	string	The ID of the artist. Has to be unique for each artist.
name	Yes	string	The name of the artist.
performances	No	array of Performance objects	A list of all performances of the artist.
priority	No	integer	The priority of the artist. This determines the position of the artist on various screens in the app. Default is 100.
description	No	string	The description for the artist. Can contain HTML.
image	No	string	A URL to an image of the artist. Must be JPG or PNG. Should be at least 1500x1500. Artist should preferably be centered on the image.
website	No	string / object	A URL to the website of the artist.
facebook	No	string	A URL to the Facebook page of the artist.
twitter	No	string	A URL to the Twitter page of the artist.
linkedin	No	string	A URL to the LinkedIn page of the artist.
instagram	No	string	A URL to the Instagram profile of the artist.
tiktok	No	string	A URL to the TikTok profile of the artist.
youtube	No	string	A URL to the Youtube channel of the artist.
vimeo	No	string	A URL to the Vimeo channel of the artist.
spotify	No	string	A URL to the Spotify page of the artist or the artist's Spotify URI. Can be found by going to the artist in Spotify, choose Share and select "Copy Artist Link" or "Copy Spotify URI".
deezer	No	string	A URL to the Deezer page of the artist.
applemusic	No	string	A URL to the Apple Music page of the artist.
soundcloud	No	string	A URL to the Soundcloud page of the artist.

Performance Model

Field	Required	Type	Description
id	Yes	string	The ID of the performance. Has to be unique for each performance.
name	No	string	The name of the performance. This is optional and only necessary if the performance name is different from the artist name.
start_time	No	string	The start time of the performance. Date format has to be YYYY-MM-DD HH:mm:ssZ. Must be before or equal to end_time.
end_time	No	string	The end time of the performance. Date format has to be YYYY-MM-DD HH:mm:ssZ. Must be after or equal to start_time.
stage_id	No	string	The ID of the stage this performance takes place on.
priority	No	integer	The priority of the performance. This determines the position of the performance on various screens in the app. Default is 100.

Tip: If the day of a performance is already known but the exact time is still unknown, use the same start_time and end_time on the day of the performance.
The application will show the day of the performance but no time.

Artists JSON Example

{
  "artists": [
    {
      "id": "1",
      "name": "Rihanna",
      "performances": [
        {
          "id": "1",
          "stage_id": "dance_hall",
          "start_time": "2019-08-24 21:00:00+02:00",
          "end_time": "2019-08-24 23:00:00+02:00"
          "priority": 5
        }
      ],
      "description": "<p>Robyn Rihanna Fenty (born 20 February 1988) is a Barbadian-born singer, songwriter, actress, and businesswoman. Born in Saint Michael, Barbados and raised in Bridgetown, during 2003, she recorded demo tapes under the direction of record producer Evan Rogers and signed a recording contract with Def Jam Recordings after auditioning for its then-president, hip hop producer and rapper Jay-Z. In 2005, Rihanna rose to fame with the release of her debut studio album Music of the Sun and its follow-up A Girl like Me (2006), which charted on the top 10 of the US Billboard 200 and respectively produced the successful singles \"Pon de Replay\", \"SOS\" and \"Unfaithful\". She assumed creative control for her third studio album Good Girl Gone Bad (2007) and adopted a public image as a sex symbol, while reinventing her music. Its lead single \"Umbrella\" became an international breakthrough in her career, as she won her first Grammy Award at the 50th Annual Grammy Awards in 2008.</p>",
      "image": "https://media.muzooka.com/images/4995441/landscape/16x9/medium1.jpg",
      "website": "http://rihannanow.com",
      "facebook": "https://www.facebook.com/rihanna",
      "twitter": "https://twitter.com/rihanna",
      "linkedin": null,
      "instagram": "https://www.instagram.com/badgalriri",
      "tiktok": "https://www.tiktok.com/@rihanna",
      "youtube": "https://www.youtube.com/channel/UCcgqSM4YEo5vVQpqwN-MaNw",
      "vimeo": null,
      "spotify": "spotify:artist:5pKCCKE2ajJHZ9KAiaK11H",
      "deezer": "https://www.deezer.com/en/artist/564",
      "applemusic": "https://music.apple.com/us/artist/rihanna/63346553",
      "soundcloud": "https://soundcloud.com/rihanna"
    },
    {
      "id": "taylor-swift",
      "name": "Taylor Swift",
      "performances": [
        {
          "id": "2",
          "stage_id": "1",
          "start_time": "2019-08-23 20:00:00+02:00",
          "end_time": "2019-08-23 22:10:00+02:00",
          "priority": 1
        },
        {
          "id": "3",
          "name": "Taylor Swift Exclusive Livestream",
          "stage_id": null,
          "start_time": "2019-08-25 00:00:00+02:00",
          "end_time": "2019-08-25 00:00:00+02:00",
          "priority": 2
        }
      ],
      "description": "Taylor Alison Swift (born December 13, 1989) is an American singer-songwriter. One of the world's leading contemporary recording artists, she is known for narrative songs about her personal life, which have received widespread media coverage. Born and raised in Pennsylvania, Swift moved to Nashville, Tennessee at the age of 14 to pursue a career in country music. She signed with the label Big Machine Records and became the youngest artist ever signed by the Sony/ATV Music publishing house. Her 2006 self-titled debut album peaked at number five on the Billboard 200 and spent the most weeks on the chart in the 2000s.",
      "image": "https://media.muzooka.com/images/434181/landscape/16x9/medium1.jpg",
      "website": "https://www.taylorswift.com",
      "facebook": "https://www.facebook.com/TaylorSwift",
      "twitter": "https://twitter.com/taylorswift13",
      "linkedin": null,
      "instagram": "https://www.instagram.com/taylorswift",
      "tiktok": "https://www.tiktok.com/@taylorswift.14",
      "youtube": "https://www.youtube.com/user/taylorswift",
      "vimeo": null,
      "spotify": "https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02",
      "deezer": "https://www.deezer.com/us/artist/12246",
      "applemusic": "https://music.apple.com/us/artist/taylor-swift/159260351",
      "soundcloud": "https://soundcloud.com/taylorswiftofficial"
    }
  ]
}

Artists XML Example

<artists>
  <artist id="1">
    <name><![CDATA[Rihanna]]></name>
    <performances> 
      <performance id="1">
        <stage_id>dance_hall</stage_id>
        <start_time>2019-08-24 21:00:00+0200</start_time>
        <end_time>2019-08-24 23:00:00+0200</end_time>
        <priority>5</priority>
      </performance>
      </performances>
      <description><![CDATA[Robyn Rihanna Fenty (born 20 February 1988) is a Barbadian-born singer, songwriter, actress, and businesswoman. Born in Saint Michael, Barbados and raised in Bridgetown, during 2003, she recorded demo tapes under the direction of record producer Evan Rogers and signed a recording contract with Def Jam Recordings after auditioning for its then-president, hip hop producer and rapper Jay-Z. In 2005, Rihanna rose to fame with the release of her debut studio album Music of the Sun and its follow-up A Girl like Me (2006), which charted on the top 10 of the US Billboard 200 and respectively produced the successful singles "Pon de Replay", "SOS" and "Unfaithful". She assumed creative control for her third studio album Good Girl Gone Bad (2007) and adopted a public image as a sex symbol, while reinventing her music. Its lead single "Umbrella" became an international breakthrough in her career, as she won her first Grammy Award at the 50th Annual Grammy Awards in 2008.]]></description>
      <image><![CDATA[https://media.muzooka.com/images/4995441/landscape/16x9/medium1.jpg]]></image>
       <website><![CDATA[http://rihannanow.com]]></website>
       <facebook><![CDATA[https://www.facebook.com/rihanna]]></facebook>
       <twitter><![CDATA[https://twitter.com/rihanna]]></twitter>
       <linkedin><![CDATA[https://www.linkedin.com/in/rihanna-fenty-6a104346]]></linkedin>
       <instagram><![CDATA[https://www.instagram.com/badgalriri]]></instagram>
       <tiktok><![CDATA[https://www.tiktok.com/@rihanna]]></tiktok>
       <youtube><![CDATA[https://www.youtube.com/channel/UCcgqSM4YEo5vVQpqwN-MaNw]]></youtube>
       <vimeo/> 
       <spotify><![CDATA[spotify:artist:5pKCCKE2ajJHZ9KAiaK11H]]></spotify>
       <deezer><![CDATA[https://www.deezer.com/en/artist/564]]></deezer>
       <applemusic><![CDATA[https://music.apple.com/us/artist/rihanna/63346553]]></applemusic>
       <soundcloud><![CDATA[https://soundcloud.com/rihanna]]></soundcloud>
  </artist>
  <artist id="taylor-swift"> 
    <name><![CDATA[Taylor Swift]]></name>
    <performances> 
      <performance id="2"> 
        <stage_id>1</stage_id> 
        <start_time>2019-08-23 20:00:00+0200</start_time> 
        <end_time>2019-08-23 22:10:00+0200</end_time>
        <priority>1</priority> 
      </performance>
      <performance id="3">
        <stage_id/>
        <start_time>2019-08-25 00:00:00+0200</start_time>
        <end_time>2019-08-25 00:00:00+0200</end_time>
        <priority>2</priority>
      </performance>
    </performances>
    <description><![CDATA[Taylor Alison Swift (born December 13, 1989) is an American singer-songwriter. One of the world's leading contemporary recording artists, she is known for narrative songs about her personal life, which have received widespread media coverage. Born and raised in Pennsylvania, Swift moved to Nashville, Tennessee at the age of 14 to pursue a career in country music. She signed with the label Big Machine Records and became the youngest artist ever signed by the Sony/ATV Music publishing house. Her 2006 self-titled debut album peaked at number five on the Billboard 200 and spent the most weeks on the chart in the 2000s.]]></description>
    <image><![CDATA[https://media.muzooka.com/images/434181/landscape/16x9/medium1.jpg]]></image>
    <website><![CDATA[https://www.taylorswift.com]]></website>
    <facebook><![CDATA[https://www.facebook.com/TaylorSwift]]></facebook>
    <twitter><![CDATA[https://twitter.com/taylorswift13]]></twitter>
    <linkedin/>
    <instagram><![CDATA[https://www.instagram.com/taylorswift]]></instagram>
    <tiktok><![CDATA[https://www.tiktok.com/@taylorswift.14]]></tiktok>
    <youtube><![CDATA[https://www.youtube.com/user/taylorswift]]></youtube>
    <vimeo/>
    <spotify><![CDATA[https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02]]></spotify>
    <deezer><![CDATA[https://www.deezer.com/us/artist/12246]]></deezer>
    <applemusic><![CDATA[https://music.apple.com/us/artist/taylor-swift/159260351]]></applemusic>
    <soundcloud><![CDATA[https://soundcloud.com/taylorswiftofficial]]></soundcloud>
  </artist> 
</artists>