Get All Virtual Linear Playlists

Retrieves a list of your virtual linear playlists.

Request

Request syntax:

GET /linear-playlist

Request syntax (filtered):

GET /linear-playlist?desc=Description&active=Status

Query string parameters:

Filter the response by passing the following query string parameters:

Response

The response for a successful request contains the following properties:

items List

The items list describes each virtual linear playlist via the following properties:

playlist List

The playlist list defines a virtual linear playlist via the following properties:

Sample Request/Response

Call the get_all_virtual_linear_playlists module (Python 3) to retrieve REPLACEME. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_all_virtual_linear_playlists()

    def _get_all_virtual_linear_playlists(self):
        url = "{}{}".format(self.host, "/api/v4/linear-playlist")

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

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({}), headers=headers
        )

        print(response.json())

VirtualLinearPlaylists().run()

Response:

{
	'@id': '/api/v4/linear-playlist/?desc=Sample+Playlist',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/linear-playlist/abce801613f94955b17db4f7c8e8137c',
			'@type': 'LinearPlaylist',
			'id': 'abce801613f94955b17db4f7c8e8137c',
			'desc': 'Sample Playlist',
			'repeat': -1,
			'profile': '',
			'beam_break_duration': 30,
			'ad_slate_fill': 0,
			'active': 1,
			'skip_drm': 0,
			'studio_drm_required': 0,
			'playlist': [{
            	    'beam':{
                	    'id':'abc123456defghi789jklmno012345pq'
                	}
            	}, {
                	'ad':{
                    	'dur': 20
                	}
            	}, {
                	'beam':{
                    	'id':'1df8d13992cd4222a7343b8fafd89cd7'
                	}
            	}
        	]
		}
	],
	'total_items': 1
}