Return calendar events for the station’s playlist schedule.

GET

https://demo.azuracast.com/api/station/{station_id}/playlists/schedule

Controller used to respond to AJAX requests from the playlist “Schedule View”.

Return calendar events for the station's playlist schedule.

curl -X GET 'https://demo.azuracast.com/api/station/0/playlists/schedule' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/station/0/playlists/schedule', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/playlists/schedule',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "id": 1,
    "title": "Example Playlist",
    "type": "playlist",
    "start": "2020-02-19T03:00:00-06:00",
    "end": "2020-02-19T05:00:00-06:00",
    "edit_url": "/api/station/1/playlist/1",
    "source": "songs",
    "order": "random",
    "playlist_type": "default",
    "play_per_songs": 0,
    "play_per_minutes": 0,
    "play_per_hour_minute": 0,
    "weight": 3,
    "is_jingle": false,
    "include_in_on_demand": false,
    "avoid_duplicates": false,
    "plays_via_group_schedule": false,
    "members": [
      {
        "id": 1,
        "name": "Example Playlist",
        "source": "songs",
        "order": "random",
        "weight": 3,
        "count": 25,
        "consecutive_plays": 1,
        "play_full_cycle": false,
        "is_enabled": true
      }
    ],
    "num_songs": 25,
    "total_length": 3600,
    "remote_url": "https://example.com/stream",
    "remote_type": "stream"
  }
]

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Parameters

station_idinteger | stringrequiredpath

Response

200OKArray<Api_StationSchedulePlaylistEvent>

Success

Response fields application/json

Array<Api_StationSchedulePlaylistEvent>

Show child attributes

idintegerrequired

The unique identifier of the playlist.

Example

titlestringrequired

The playlist name representing the event title.

Example

Example Playlist

typestringplaylistrequired

The type of this schedule event.

Example

playlist

startstringrequired

The start time of this schedule event, in ISO 8601 format.

Example

2020-02-19T03:00:00-06:00

endstringrequired

The end time of this schedule event, in ISO 8601 format.

Example

2020-02-19T05:00:00-06:00

edit_urlstringrequired

The API URL used to edit the underlying playlist.

Example

/api/station/1/playlist/1

sourcePlaylistSourcessongsplaylistsremote_urlrequestsrequired

orderPlaylistOrdersrandomshufflesequentialrequired

playlist_typePlaylistTypesdefaultonce_per_x_songsonce_per_x_minutesonce_per_hourcustomrequired

play_per_songsintegerrequired

Example

play_per_minutesintegerrequired

Example

play_per_hour_minuteintegerrequired

Example

weightintegerrequired

Example

is_jinglebooleanrequired

Example

false

include_in_on_demandbooleanrequired

Example

false

avoid_duplicatesbooleanrequired

Example

false

plays_via_group_schedulebooleanrequiredread only

True if this playlist is a group member and an ancestor group’s schedule covers this entire event, so it plays via that group instead of on its own. Partially covered events report false.

Example

false

membersArray<Api_StationScheduleGroupMember>required

Show child attributes

idintegerrequired

The unique identifier of the member playlist.

Example

namestringrequired

The name of the member playlist.

Example

Example Playlist

sourcePlaylistSourcessongsplaylistsremote_urlrequestsrequired

orderPlaylistOrdersrandomshufflesequentialrequired

weightintegerrequired

The weighting of this member within the group.

Example

countinteger | nullrequired

The number of songs or member playlists in this member, if applicable.

Example

consecutive_playsintegerrequired

The number of consecutive plays configured for this member.

Example

play_full_cyclebooleanrequired

Whether the member plays through its full cycle before advancing.

Example

false

is_enabledbooleanrequired

Whether the member playlist is enabled.

Example

true

num_songsinteger | nullrequired

The number of songs in the playlist, if it is a song-based playlist.

Example

total_lengthnumber<float> | nullrequired

The total length of the playlist in seconds, if it is a song-based playlist.

Example

remote_urlstring | nullrequired

The remote URL, if this is a remote URL playlist.

Example

https://example.com/stream

remote_typePlaylistRemoteTypes | nullrequired

Show child attributes

One of

PlaylistRemoteTypesstreamplaylistother

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey