{"_id":"57fcc4870312b20e00ac650c","version":{"_id":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","__v":1,"createdAt":"2016-10-11T10:52:54.637Z","releaseDate":"2016-10-11T10:52:54.637Z","categories":["57fcc4860312b20e00ac64c1","57fcc4860312b20e00ac64c2","57fcc4860312b20e00ac64c3","57fcc4860312b20e00ac64c4","57fcc4860312b20e00ac64c5","57fcc4860312b20e00ac64c6","57fcc4860312b20e00ac64c7","57fcc4860312b20e00ac64c8","57fcc4860312b20e00ac64c9","57fcc4860312b20e00ac64ca","57fcc4860312b20e00ac64cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"[APP-1265], [APP-1035]","version_clean":"5.2.0","version":"5.2"},"parentDoc":null,"user":"5435682035740020002a1c01","__v":0,"category":{"_id":"57fcc4860312b20e00ac64cb","__v":0,"version":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-24T21:45:44.150Z","from_sync":false,"order":10,"slug":"api-methods","title":"API Methods"},"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-24T19:24:50.827Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":15,"body":"Playlists are a collection of objects that will play according to rules you define.\n\nA playlist contains one or more [Pages](doc:pages). Each page can display a [Board](doc:boards), a Web Page, an Image, a Video or a supported Chrome App.\n\nPlaylists will calculate which pages are currently visible based on the rules you define and then display each page in sequence.\n\nTake note that you must specify a duration for each page in order for the rotation of pages to occur.\n\n## Playlist Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"A globally unique static string identifying the object.\",\n    \"1-0\": \"name\",\n    \"1-1\": \"The name of the playlist\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## List all Playlists\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/playlists\",\n  \"body\": \"This method will return a list of all playlists on your account.\"\n}\n[/block]\n## Display a Playlist\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/playlists/:id\",\n  \"body\": \"This method will return a specific playlist on your account by id.\"\n}\n[/block]\n## Create a Playlist\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/playlists\",\n  \"body\": \"This method will create a new playlist.\"\n}\n[/block]\n## Update a Playlist\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/playlists/:id\",\n  \"body\": \"This method will update a playlist object by id.\"\n}\n[/block]\n## Delete a Playlist\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DELETE https://api.telemetrytv.com/playlists/:id\",\n  \"body\": \"This method will delete a playlist object.\"\n}\n[/block]","excerpt":"","slug":"playlists","type":"basic","title":"Playlists"}
Playlists are a collection of objects that will play according to rules you define. A playlist contains one or more [Pages](doc:pages). Each page can display a [Board](doc:boards), a Web Page, an Image, a Video or a supported Chrome App. Playlists will calculate which pages are currently visible based on the rules you define and then display each page in sequence. Take note that you must specify a duration for each page in order for the rotation of pages to occur. ## Playlist Object [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "0-1": "A globally unique static string identifying the object.", "1-0": "name", "1-1": "The name of the playlist" }, "cols": 2, "rows": 2 } [/block] ## List all Playlists [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/playlists", "body": "This method will return a list of all playlists on your account." } [/block] ## Display a Playlist [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/playlists/:id", "body": "This method will return a specific playlist on your account by id." } [/block] ## Create a Playlist [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/playlists", "body": "This method will create a new playlist." } [/block] ## Update a Playlist [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/playlists/:id", "body": "This method will update a playlist object by id." } [/block] ## Delete a Playlist [block:callout] { "type": "danger", "title": "DELETE https://api.telemetrytv.com/playlists/:id", "body": "This method will delete a playlist object." } [/block]