Introduction
Web Pages provide a single URL address that is used throughout Yodeck. If you want to display different content on each screen, you would have to create a separate Web Page, Layout and Schedule for each screen.
To avoid this, we provide two unique parameters that can be used in the Web Page URL address. Yodeck replaces these parameters in the URL you provide with the values of each Screen. Your web page should then be able to differentiate the behavior based on this ID. Here are the values we currently support:
DEVICE_ID – This is the ID displayed in the Screens list, e.g., 4321
DEVICE_UUID – This is the ID displayed on the Screen Details page, e.g., abcdef112abcdef112abcdef112
DEVICE_NAME – This is the Name of the Screen, e.g., “Lobby Screen”
Please note the following:
All occurrences of these special names in all URL addresses will be replaced.
These parameter names are case-sensitive, so they must be used in uppercase. If they are not in uppercase, they will not be replaced.
The “DEVICE_NAME” values are URL-encoded, so you can use any character, including non-Latin characters.
Currently, there is no way to specify a value for DEVICE_ID and DEVICE_UUID. If you delete a Screen from your account, the DEVICE_UUID and DEVICE_ID values are lost, and you can’t retrieve them or re-create the Screen with these values. Check out the “Using a Custom ID” section below.
Using a Custom ID
If you want to use a Custom ID for each Screen, you can use the “DEVICE_NAME” parameter with a twist to make it easier. If the name of a Screen includes the special character “~” (called “tilde”), then only the part after the tilde is used while replacing. So, if you specify “Lobby Screen ~653” as a Name for a Screen, then the DEVICE_NAME parameter will use only the “653” value.
This way, you can specify a Custom ID within the Name of each Screen, making it easier to manage the custom URLs.
Examples
Let’s say you have 2 Screens with Device IDs 4001 and 4002. If you use the following URL in a Web Page:
https://httpbin.org/get?q=DEVICE_ID&argument=value
The following URLs will be sent respectively to each of the two devices:
To device 4001: https://httpbin.org/get?q=4001&argument=value
To device 4002: https://httpbin.org/get?q=4002&argument=value
Let’s say you have 3 Screens named “Lobby Screen”, “Reception Screen” and “Arena Screen ~1234”. If you use the following URL in a Web Page:
https://httpbin.org/get?q=DEVICE_NAME&argument=value
The following URLs will be sent respectively to each of the two devices:
To device “Lobby Screen”: https://httpbin.org/get?q=Lobby%20Screen&argument=value
To device “Reception Screen”: https://httpbin.org/get?q=Reception%20Screen&argument=value
To device ” Arena Screen ~1234″: https://httpbin.org/get?q=1234&argument=value
