Get Multiple Blackouts

Retrieves either all or recently updated blackout configurations associated with a specific live channel.

Request

Request syntax (time period):

GET /channels/Live Channel ID/blackouts?order=Sort Category&page=Page Number&page_size=Items Per Page

Request syntax (recently updated blackout configurations):

GET /channels/Live Channel ID/blackouts?after=Last Modified Time

Define the following variable when submitting the above request:

Request query string parameters:

Pass the following optional request query string parameters:

Response

A successful request returns a 200 OK response that contains the following properties:

items List

The items list describes each rule configuration via the following properties:

Sample Request/Response

Call the get_multiple_blackouts module (Python 3) to retrieve the blackout configurations associated with a live channel. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams
channel_id = 'Hak3zjnPLSW5o0j8GMpzRMsa' # Replace with the ID for the desired live channel.
blackout_id = 'degf8923f093kfd932kd9fa4' # Replace with the ID for the desired blackout configuration.

class Blackout:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Update a blackout configuration.
        """
        self._update_blackout()

    def _update_blackout(self):
        url = "{}{}{}{}{}".format(self.host, "/api/v4/channels/", channel_id, "/blackouts", blackout_id)

        payload = {
            'blackout_id': 'NorthAmerica', # Replace with the desired blackout ID.
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.patch(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

Blackout().run()

Response:

{
	'@id': '/api/v4/channels/Hak3zjnPLSW5o0j8GMpzRMsa/blackouts',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/blackouts/4d585f7e0df24e25b14a45410ec836a7',
			'@type': 'Blackout',
			'id': '4d585f7e0df24e25b14a45410ec836a7',
			'blackout_id': 'BSA',
			'channel': 'Hak3zjnPLSW5o0j8GMpzRMsa',
			'desc': 'Blackout South America',
			'external_id': '',
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'rules': ['f34e337d51f04b6da043cc7f28c9fef1']
		}, {
			'@id': '/api/v4/blackouts/309106a8d8994dd7886c7f8aedab3b66',
			'@type': 'Blackout',
			'id': '309106a8d8994dd7886c7f8aedab3b66',
			'blackout_id': 'BNA',
			'channel': 'Hak3zjnPLSW5o0j8GMpzRMsa',
			'desc': 'Blackout North America',
			'external_id': '',
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'rules': ['c5ce337d51f04b6da043cc7f28c9fe46']
		}
	],
	'total_items': 2
}