Return calendar events for the station’s streamer/DJ schedule.

GET

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

Return calendar events for the station's streamer/DJ schedule.

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

const response = await fetch('https://demo.azuracast.com/api/station/0/streamers/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/streamers/schedule',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "id": 1,
    "title": "Example Streamer",
    "type": "streamer",
    "start": "2020-02-19T03:00:00-06:00",
    "end": "2020-02-19T05:00:00-06:00",
    "edit_url": "/api/station/1/streamer/1",
    "streamer_username": "example_dj",
    "comments": "Live every weekday evening.",
    "has_custom_art": true,
    "art": "/api/station/1/streamer/1/art/1.jpg"
  }
]

{
  "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_StationScheduleStreamerEvent>

Success

Response fields application/json

Array<Api_StationScheduleStreamerEvent>

Show child attributes

idintegerrequired

The unique identifier of the streamer.

Example

titlestringrequired

The streamer display name representing the event title.

Example

Example Streamer

typestringstreamerrequired

The type of this schedule event.

Example

streamer

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 streamer.

Example

/api/station/1/streamer/1

streamer_usernamestringrequired

The streamer login username.

Example

example_dj

commentsstring | nullrequired

Comments about the streamer.

Example

Live every weekday evening.

has_custom_artbooleanrequired

Whether the streamer has custom artwork.

Example

true

artstring | nullrequired

The URL of the streamer artwork, if custom artwork is present.

Example

/api/station/1/streamer/1/art/1.jpg

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