{"_id":"57fcc4870312b20e00ac650b","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"},"user":"5435682035740020002a1c01","__v":0,"parentDoc":null,"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"},"project":"5435687035740020002a1c04","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-24T19:23:57.680Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":14,"body":"A [playlist](doc:playlists) contains one or more [pages](doc:pages-1).\n\n## Page 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\": \"playlist_id\",\n    \"1-1\": \"The id of the [playlists](doc:playlists)  this page belongs to.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"The type of the page. Can be \\\"board\\\", \\\"video\\\", \\\"image\\\", \\\"url\\\".\",\n    \"3-0\": \"location\",\n    \"3-1\": \"The source of the page. It depends of the type, it can be the channel id of the board page or the url of the video, image or url page.\",\n    \"5-0\": \"priority\",\n    \"4-0\": \"screen\",\n    \"4-1\": \"The screen number of the page.\",\n    \"5-1\": \"The sort order of the page. Determine which page of the playlist would be displayed first.\",\n    \"6-0\": \"duration\",\n    \"6-1\": \"Duration, in second, which determine how long this page should be displayed before displaying another page within a playlist.\",\n    \"7-0\": \"days\",\n    \"7-1\": \"An array of the name of days (\\\"sun\\\", \\\"mon\\\", \\\"tue\\\", \\\"wed\\\", \\\"thu\\\", \\\"fri\\\", \\\"sat\\\") on which the page is allowed to be displayed.\",\n    \"8-0\": \"hours\",\n    \"8-1\": \"A string that represents a period at which hours the page is allowed to be displayed. It is in the format of \\\"10:00-14:00\\\", this means the page can only be displayed between 10am to 2pm.\",\n    \"9-0\": \"start\",\n    \"10-0\": \"end\",\n    \"9-1\": \"A date after which the page is *allowed* to be displayed. The page would not be displayed before the start date.\",\n    \"10-1\": \"A date after which the page is *not allowed* to be displayed. The page would not be displayed after the end date.\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n## List all Pages within a Playlist\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/playlists/:playlist_id/pages\",\n  \"body\": \"This method will return a list of all pages within the playlist.\"\n}\n[/block]\n## Display a Page\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"GET https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id\",\n  \"body\": \"This method will return a specific page by id.\"\n}\n[/block]\n## Create a Page\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"POST https://api.telemetrytv.com/playlists/:playlist_id/pages\",\n  \"body\": \"This method will create a new page.\"\n}\n[/block]\n## Update a Page\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id\",\n  \"body\": \"This method will update a page object by id.\"\n}\n[/block]\n## Delete a Page\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"DELETE https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id\",\n  \"body\": \"This method will delete a page object.\"\n}\n[/block]","excerpt":"","slug":"pages","type":"basic","title":"Pages"}
A [playlist](doc:playlists) contains one or more [pages](doc:pages-1). ## Page 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": "playlist_id", "1-1": "The id of the [playlists](doc:playlists) this page belongs to.", "2-0": "type", "2-1": "The type of the page. Can be \"board\", \"video\", \"image\", \"url\".", "3-0": "location", "3-1": "The source of the page. It depends of the type, it can be the channel id of the board page or the url of the video, image or url page.", "5-0": "priority", "4-0": "screen", "4-1": "The screen number of the page.", "5-1": "The sort order of the page. Determine which page of the playlist would be displayed first.", "6-0": "duration", "6-1": "Duration, in second, which determine how long this page should be displayed before displaying another page within a playlist.", "7-0": "days", "7-1": "An array of the name of days (\"sun\", \"mon\", \"tue\", \"wed\", \"thu\", \"fri\", \"sat\") on which the page is allowed to be displayed.", "8-0": "hours", "8-1": "A string that represents a period at which hours the page is allowed to be displayed. It is in the format of \"10:00-14:00\", this means the page can only be displayed between 10am to 2pm.", "9-0": "start", "10-0": "end", "9-1": "A date after which the page is *allowed* to be displayed. The page would not be displayed before the start date.", "10-1": "A date after which the page is *not allowed* to be displayed. The page would not be displayed after the end date." }, "cols": 2, "rows": 11 } [/block] ## List all Pages within a Playlist [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/playlists/:playlist_id/pages", "body": "This method will return a list of all pages within the playlist." } [/block] ## Display a Page [block:callout] { "type": "info", "title": "GET https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id", "body": "This method will return a specific page by id." } [/block] ## Create a Page [block:callout] { "type": "success", "title": "POST https://api.telemetrytv.com/playlists/:playlist_id/pages", "body": "This method will create a new page." } [/block] ## Update a Page [block:callout] { "type": "warning", "title": "PATCH https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id", "body": "This method will update a page object by id." } [/block] ## Delete a Page [block:callout] { "type": "info", "title": "DELETE https://api.telemetrytv.com/playlists/:playlist_id/pages/:page_id", "body": "This method will delete a page object." } [/block]