Appearance
AIM Standard Export Formats
In this article, you will find the essential information you need for understanding the AIM export formats in Rapid.
AIM On Air Format
The AIM On Air format contains information for the current and next show in the schedule source, and the queued, current and recently played items in the playout source. The actual content that is currently playing track and up to seven items that are queued to be played.
An example is:
{
"nowPlaying": [
{
"title": "Need Someone",
"artist": "Asino",
"album": "",
"type": "song",
"time": "2018-02-09T10:59:35+00:00",
"duration": "00:03:40",
"id": "b60bbec81ff14437a32054cbb0689af4",
"image":"[BASE64_ENCODED_IMAGE]",
"imageUrl": "http://is4.mzstatic.com/image/thumb/Music62/v4/3f/48/46/3f484623-1d8d-41da-f9da-cf5bf14d067a/source/450x450bb.jpg",
"status": "playing"
},
{
"title": "Cola (Craig Knight Remix)",
"artist": "CamelPhat & Elderbrook",
"album": "",
"type": "song",
"time": "2018-02-09T10:55:04+00:00",
"duration": "00:03:24",
"id": "fbf5394a60da49c6a5daea529231a44e",
"image":"[BASE64_ENCODED_IMAGE]",
"imageUrl": "http://is4.mzstatic.com/image/thumb/Music127/v4/e7/96/e0/e796e022-2c1d-e820-5c94-42b424ebc5aa/source/450x450bb.jpg",
"status": "history"
}
],
"onAir": [
{
"id": "veKtuMeKltaPmdeP",
"title": "The Morning Show Summer Series",
"description": "Join Larry Emdur and Kylie Gillies each morning for a variety of segments on the latest news, entertainment and other hot topics.",
"startTime": "2016-01-07T22:00:00+00:00",
"endTime": "2016-01-07T23:00:00+00:00",
"duration": "02:30:00",
"image":"[BASE64_ENCODED_IMAGE]",
"images": [
{
"url": "https://www.imageurl.com/rectangular_image.jpg",
"type": "widescreen",
"width": 1280,
"height": 800
},
{
"url": "https://www.imageurl.com/square_image.jpg",
"type": "square",
"width": 1280,
"height": 1280
}
],
"status": "next"
},
{
"id": "uKvou3eJltaPmdaJ",
"title": "Sunrise",
"description": "Wake up to a better breakfast with Samantha Armytage and David Koch for all the latest news, sport and weather.",
"startTime": "2016-01-07T19:00:00+00:00",
"endTime": "2016-01-07T22:00:00+00:00",
"duration": "03:00:00",
"images": [
{
"url": "https://www.imageurl.com/rectangular_image.jpg",
"type": "widescreen",
"width": 1280,
"height": 800
},
{
"url": "https://www.imageurl.com/square_image.jpg",
"type": "square",
"width": 1280,
"height": 1280
}
],
"status": "current"
}
]
}The following attributes are contained within the JSON:
- nowPlaying: Container for all playout items. Items are ordered in reverse chronological order
- title: The title for this playout item
- artist: The artist for this playout item
- album: The album (if it is a music track) for this playout item
- id: A unique identifier for this playout item
- time: The start time (or expected start time in the case of queued items) in ISO8601 format, e.g. 2016-01-27T:12:11:53+11:00
- duration: The expected duration of the item in HH:MM:SS format
- type: The type of playout item. Accepted values: song, speech, spot, link, other
- image (Only Used if CDN, eg AIM Content Hosting, is disabled): A base-64 encoded copy of the image (if available) associated with the playout item is included within the JSON
- imageUrl (Only Used if CDN, eg AIM Content Hosting, is enabled): A link to the image (if available) associated with the playout item
- status: Whether this track is the currently playing item or queued. A maximum of one item with the type set to playing is allowed per file. Accepted values:
- queued: a playout item that is queued
- playing: the playout item that is currently playing
- history: a playout item that has recently played
- onAir: Container for all schedule items. Items are ordered in reverse chronological order
- title: The title for this schedule item
- description: The description for this schedule item
- id: A unique identifier for this schedule item
- startTime: The start time for this schedule item in ISO8601 format, e.g. 2016-01-27T:12:11:53+11:00
- endTime: The end time for this schedule item in ISO8601 format, e.g. 2016-01-27T:12:11:53+11:00
- duration: The duration for this schedule item in HH:MM:SS format
- image (Only Used if CDN, eg AIM Content Hosting, is disabled): A base-64 encoded copy of the image is included within the JSON
- images (Only Used if CDN, eg AIM Content Hosting, is enabled): An array of images. The following fields will be supplied for each image (if an image is available for this item). Multiple images of the same type could be included in this array.
- url: A link to the image
- type: Accepted values:
- square: Square image (aspect ratio of 1:1)
- widescreen: Widescreen image (aspect ratio of (1.66:1, 1.75:1, 1.77:1, 1.78:1 and 16:9)
- fullscreen: Fullscreen image (aspect ratio of 4:3)
- custom: An image that does
- width: Width of the image in pixels
- height: Height of the image in pixels
- status: Whether this item is the currently onair show or the upcoming show. A maximum of one item of each type per document. Accepted values:
- current: the show that is currently on air
- next: the next schedule show
Playout/Automation Specification | Feed Format
The Playout Feed should be provided in the format defined below. The endpoint should be served via HTTPS where possible.
All images should be served via HTTPS.
The Playout endpoint must return a set of playout data in JSON, with the most recent track first and the subsequent tracks in reverse chronological order following that. It is recommended that you include a maximum of 10 tracks in the response.
All the fields are detailed below:
| Field | Required | Description |
|---|---|---|
| id | Yes | A unique identifier for the track |
| artist | Yes | Artist name |
| title | Yes | Title of the track |
| album | No | Album the track is on |
| time | Yes | The time the track started playing in ISO8601 format, e.g. 2016-01-27T:12:11:53+11:00 |
| imageUrl | No | Link to an image to displayed for the song. The image must be square and a minimum size of 450 pixels by 450 pixels. If no image is specified, the default track image for the station is used. |
| itunesTrackUrl | No | A link to the track on iTunes. This can be used as a purchase link. |
| previewUrl | No | A link to an audio file containing a preview of the track. If this attribute is populated then users will be able to listen to a preview of the track within the app. |
| duration | Yes | The duration of the track in HH:MM:SS format |
| status | Yes | Set to 'playing' if the track is currently playing, 'history' if the track has finished playing, and ‘queued’ if the track is upcoming |
| type | Yes | Set to 'song' |
An example Playout Feed response is:
API Response
{
"nowPlaying": [
{
"album": "",
"artist": "Asino",
"duration": "00:03:40",
"iTunesTrackUrl": "https://itunes.apple.com/au/album/need-someone/id1144640245?i=1144640297&uo=4",
"id": "b60bbec81ff14437a32054cbb0689af4",
"imageUrl": "http://is4.mzstatic.com/image/thumb/Music62/v4/3f/48/46/3f484623-1d8d-41da-f9da-cf5bf14d067a/source/450x450bb.jpg",
"previewUrl": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview118/v4/33/09/ba/3309ba10-1f0e-d211-5520-5cd516a12c83/mzaf_2932131380501237484.plus.aac.p.m4a",
"status": "playing",
"time": "2018-02-09T10:59:35+00:00",
"title": "Need Someone",
"type": "song"
},
{
"album": "",
"artist": "CamelPhat & Elderbrook",
"duration": "00:03:24",
"iTunesTrackUrl": "https://itunes.apple.com/au/album/cola/1247588439?i=1247588952&uo=4",
"id": "fbf5394a60da49c6a5daea529231a44e",
"imageUrl": "http://is4.mzstatic.com/image/thumb/Music127/v4/e7/96/e0/e796e022-2c1d-e820-5c94-42b424ebc5aa/source/450x450bb.jpg",
"status": "history",
"time": "2018-02-09T10:55:04+00:00",
"title": "Cola (Craig Knight Remix)",
"type": "song"
}
]
}Schedule Format | Schedule Specification
The Schedule should be provided in the format defined below. The endpoint should be served via HTTPS where possible.
All images should be served via HTTPS.
The Schedule endpoint must return a complete set of schedule data for the current day and the subsequent seven days for a particular station.
All episodes in the schedule data should be sorted chronologically.
All the fields are detailed below:
| Field | Required | Description |
|---|---|---|
| episodes | Yes | Container for the episode details |
| id | Yes | A unique alphanumeric ID for the episode |
| seriesId | No | If this episode is part of a series, all episodes within the series should have the same unique alphanumeric seriesId value |
| title | Yes | A title for the episode |
| description | Yes | A description for the episode |
| startTime | Yes | Start time for the episode in ISO8601 format |
| endTime | Yes | End time for the episode in ISO8601 format |
| duration | Yes | Duration of the episode in hh:mm:ss format |
| images | Yes | The following image must be supplied:
|
An example response is:
API Response
{
"episodes": [
{
"id": "uKvou3eJltaPmdaJ",
"seriesId": "123456",
"title": "Sunrise",
"description": "Wake up to a better breakfast with Samantha Armytage and David Koch for all the latest news, sport and weather.",
"images": [
{
"url": "https://www.imageurl.com/square_image.jpg",
"type": "square",
"width": 1024,
"height": 1024
}
],
"startTime": "2016-01-07T19:00:00+00:00",
"endTime": "2016-01-07T22:00:00+00:00",
"duration": "03:00:00"
},
{
"id": "veKtuMeKltaPmdeP",
"seriesId": "123459",
"title": "The Morning Show Summer Series",
"description": "Join Larry Emdur and Kylie Gillies each morning for a variety of segments on the latest news, entertainment and other hot topics.",
"startTime": "2016-01-07T22:00:00+00:00",
"endTime": "2016-01-08T00:30:00+00:00",
"duration": "02:30:00"
}
]
}v4.10.x