{ "openapi": "3.1.0", "info": { "title": "Expedy Displays API", "version": "v2", "description": "Reference for the displays endpoints of the Expedy API. Generated from https://docs.expedy.io.", "contact": { "name": "Expedy", "url": "https://docs.expedy.io" } }, "servers": [ { "url": "https://www.expedy.fr/api/v2", "description": "Production" } ], "paths": { "/displays/all": { "get": { "summary": "List all your displays", "description": "This endpoint allows you to list all your displays", "operationId": "get_displays_all", "tags": [ "displays" ], "externalDocs": { "url": "https://docs.expedy.io/en/digital-signage/displays/get-displays-all", "description": "Full documentation for List all your displays" }, "responses": { "200": { "description": "OK\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| `display_id` | `string` | No | |\n| `display_name` | `string` | No | |\n| `display_model` | `string` | No | |\n| `host_device_uid` | `string` | No | |\n| `hdmi_port` | `string` | No | |\n| `display_state` | `string` | No | |\n| `display_power` | `string` | No | |\n| `display_dim` | `string` | No | |\n| `display_resolution` | `string` | No | |\n| `display_fps` | `string` | No | |\n| `display_capabilities` | `array` | No | |\n\n**`display_capabilities` properties:**\n\n | Parameter | Type | Required | Description |\n |-----------|------|----------|-------------|\n | `rez` | `string` | No | |\n | `freqs` | `array` | No | |\n\n **`freqs` properties:**\n\n | Parameter | Type | Required | Description |\n |-----------|------|----------|-------------|\n | `freq` | `string` | No | |\n\n | `selected` | `string` | No | |\n\n\n**Response Example:**\n\n```json\n[\n {\n \"display_id\": \"1\",\n \"display_name\": \"Main Hall screen\",\n \"display_model\": \"SAM-SMB2230N\",\n \"host_device_uid\": \"MMAAZ112PI\",\n \"hdmi_port\": \"1\",\n \"display_state\": \"connected\",\n \"display_power\": \"1\",\n \"display_dim\": \"477mmx268mm\",\n \"display_resolution\": \"1920x1080\",\n \"display_fps\": \"60.00\",\n \"display_capabilities\": [\n {\n \"rez\": \"1920x1080\",\n \"freqs\": [\n {\n \"freq\": \"60.00*\"\n },\n {\n \"freq\": \"50.00\"\n },\n {\n \"freq\": \"59.94\"\n }\n ],\n \"selected\": \"60.00*\"\n },\n {\n \"rez\": \"1600x1200\",\n \"freqs\": [\n {\n \"freq\": \"60.00\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1680x1050\",\n \"freqs\": [\n {\n \"freq\": \"59.88\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1280x1024\",\n \"freqs\": [\n {\n \"freq\": \"75.02\"\n },\n {\n \"freq\": \"60.02\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1440x900\",\n \"freqs\": [\n {\n \"freq\": \"74.98\"\n },\n {\n \"freq\": \"59.90\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1280x960\",\n \"freqs\": [\n {\n \"freq\": \"60.00\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1280x800\",\n \"freqs\": [\n {\n \"freq\": \"59.91\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1152x864\",\n \"freqs\": [\n {\n \"freq\": \"75.00\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1280x720\",\n \"freqs\": [\n {\n \"freq\": \"60.00\"\n },\n {\n \"freq\": \"50.00\"\n },\n {\n \"freq\": \"59.94\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"1024x768\",\n \"freqs\": [\n {\n \"freq\": \"75.03\"\n },\n {\n \"freq\": \"70.07\"\n },\n {\n \"freq\": \"60.00\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"832x624\",\n \"freqs\": [\n {\n \"freq\": \"74.55\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"800x600\",\n \"freqs\": [\n {\n \"freq\": \"72.19\"\n },\n {\n \"freq\": \"75.00\"\n },\n {\n \"freq\": \"60.32\"\n },\n {\n \"freq\": \"56.25\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"720x480\",\n \"freqs\": [\n {\n \"freq\": \"60.00\"\n },\n {\n \"freq\": \"59.94\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"640x480\",\n \"freqs\": [\n {\n \"freq\": \"75.00\"\n },\n {\n \"freq\": \"72.81\"\n },\n {\n \"freq\": \"66.67\"\n },\n {\n \"freq\": \"60.00\"\n },\n {\n \"freq\": \"59.94\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"720x400\",\n \"freqs\": [\n {\n \"freq\": \"70.08\"\n }\n ],\n \"selected\": \"\"\n }\n ]\n },\n {\n \"display_id\": \"2\",\n \"display_name\": \"Second Hall Screen\",\n \"display_model\": \"none\",\n \"host_device_uid\": \"MMAAZ112PI\",\n \"hdmi_port\": \"2\",\n \"display_state\": \"unknown\",\n \"display_power\": \"1\",\n \"display_dim\": \"0mmx0mm\",\n \"display_resolution\": \"1024x768\",\n \"display_fps\": \"60.00\",\n \"display_capabilities\": [\n {\n \"rez\": \"1024x768\",\n \"freqs\": [\n {\n \"freq\": \"60.00*\"\n }\n ],\n \"selected\": \"60.00*\"\n },\n {\n \"rez\": \"800x600\",\n \"freqs\": [\n {\n \"freq\": \"60.32\"\n },\n {\n \"freq\": \"56.25\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"848x480\",\n \"freqs\": [\n {\n \"freq\": \"60.00\"\n }\n ],\n \"selected\": \"\"\n },\n {\n \"rez\": \"640x480\",\n \"freqs\": [\n {\n \"freq\": \"59.94\"\n }\n ],\n \"selected\": \"\"\n }\n ]\n },\n {\n \"display_id\": \"11\",\n \"display_name\": \"Entrance 1\",\n \"display_model\": \"\",\n \"host_device_uid\": \"NYBFYLP9ZJF\",\n \"hdmi_port\": \"1\",\n \"display_state\": \"\",\n \"display_power\": \"\",\n \"display_dim\": \"\",\n \"display_resolution\": \"none\",\n \"display_fps\": \"none\",\n \"display_capabilities\": []\n },\n {\n \"display_id\": \"12\",\n \"display_name\": \"Entrance 2\",\n \"display_model\": \"\",\n \"host_device_uid\": \"NYBFYLP9ZJF\",\n \"hdmi_port\": \"2\",\n \"display_state\": \"\",\n \"display_power\": \"\",\n \"display_dim\": \"\",\n \"display_resolution\": \"none\",\n \"display_fps\": \"none\",\n \"display_capabilities\": []\n },\n {\n \"display_id\": \"17\",\n \"display_name\": \"Center Wide Wall\",\n \"display_model\": \"SAM-SMB2230N\",\n \"host_device_uid\": \"YTES85MCGRX\",\n \"hdmi_port\": \"1\",\n \"display_state\": \"connected\",\n \"display_power\": \"\",\n \"display_dim\": \"477mmx268mm\",\n \"display_resolution\": \"none\",\n \"display_fps\": \"none\",\n \"display_capabilities\": []\n }\n]\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "display_id": { "type": "string" }, "display_name": { "type": "string" }, "display_model": { "type": "string" }, "host_device_uid": { "type": "string" }, "hdmi_port": { "type": "string" }, "display_state": { "type": "string" }, "display_power": { "type": "string" }, "display_dim": { "type": "string" }, "display_resolution": { "type": "string" }, "display_fps": { "type": "string" }, "display_capabilities": { "type": "array" } } }, "example": [ { "display_id": "1", "display_name": "Main Hall screen", "display_model": "SAM-SMB2230N", "host_device_uid": "MMAAZ112PI", "hdmi_port": "1", "display_state": "connected", "display_power": "1", "display_dim": "477mmx268mm", "display_resolution": "1920x1080", "display_fps": "60.00", "display_capabilities": [ { "rez": "1920x1080", "freqs": [ { "freq": "60.00*" }, { "freq": "50.00" }, { "freq": "59.94" } ], "selected": "60.00*" }, { "rez": "1600x1200", "freqs": [ { "freq": "60.00" } ], "selected": "" }, { "rez": "1680x1050", "freqs": [ { "freq": "59.88" } ], "selected": "" }, { "rez": "1280x1024", "freqs": [ { "freq": "75.02" }, { "freq": "60.02" } ], "selected": "" }, { "rez": "1440x900", "freqs": [ { "freq": "74.98" }, { "freq": "59.90" } ], "selected": "" }, { "rez": "1280x960", "freqs": [ { "freq": "60.00" } ], "selected": "" }, { "rez": "1280x800", "freqs": [ { "freq": "59.91" } ], "selected": "" }, { "rez": "1152x864", "freqs": [ { "freq": "75.00" } ], "selected": "" }, { "rez": "1280x720", "freqs": [ { "freq": "60.00" }, { "freq": "50.00" }, { "freq": "59.94" } ], "selected": "" }, { "rez": "1024x768", "freqs": [ { "freq": "75.03" }, { "freq": "70.07" }, { "freq": "60.00" } ], "selected": "" }, { "rez": "832x624", "freqs": [ { "freq": "74.55" } ], "selected": "" }, { "rez": "800x600", "freqs": [ { "freq": "72.19" }, { "freq": "75.00" }, { "freq": "60.32" }, { "freq": "56.25" } ], "selected": "" }, { "rez": "720x480", "freqs": [ { "freq": "60.00" }, { "freq": "59.94" } ], "selected": "" }, { "rez": "640x480", "freqs": [ { "freq": "75.00" }, { "freq": "72.81" }, { "freq": "66.67" }, { "freq": "60.00" }, { "freq": "59.94" } ], "selected": "" }, { "rez": "720x400", "freqs": [ { "freq": "70.08" } ], "selected": "" } ] }, { "display_id": "2", "display_name": "Second Hall Screen", "display_model": "none", "host_device_uid": "MMAAZ112PI", "hdmi_port": "2", "display_state": "unknown", "display_power": "1", "display_dim": "0mmx0mm", "display_resolution": "1024x768", "display_fps": "60.00", "display_capabilities": [ { "rez": "1024x768", "freqs": [ { "freq": "60.00*" } ], "selected": "60.00*" }, { "rez": "800x600", "freqs": [ { "freq": "60.32" }, { "freq": "56.25" } ], "selected": "" }, { "rez": "848x480", "freqs": [ { "freq": "60.00" } ], "selected": "" }, { "rez": "640x480", "freqs": [ { "freq": "59.94" } ], "selected": "" } ] }, { "display_id": "11", "display_name": "Entrance 1", "display_model": "", "host_device_uid": "NYBFYLP9ZJF", "hdmi_port": "1", "display_state": "", "display_power": "", "display_dim": "", "display_resolution": "none", "display_fps": "none", "display_capabilities": [] }, { "display_id": "12", "display_name": "Entrance 2", "display_model": "", "host_device_uid": "NYBFYLP9ZJF", "hdmi_port": "2", "display_state": "", "display_power": "", "display_dim": "", "display_resolution": "none", "display_fps": "none", "display_capabilities": [] }, { "display_id": "17", "display_name": "Center Wide Wall", "display_model": "SAM-SMB2230N", "host_device_uid": "YTES85MCGRX", "hdmi_port": "1", "display_state": "connected", "display_power": "", "display_dim": "477mmx268mm", "display_resolution": "none", "display_fps": "none", "display_capabilities": [] } ] } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/displays/{display_id}/resolution": { "post": { "summary": "Set Resolution & Frequency", "description": "This endpoint allows you to set a display's resolution and frequency configuration.", "operationId": "post_displays_Bydisplay_id_resolution", "tags": [ "displays" ], "parameters": [ { "name": "display_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "externalDocs": { "url": "https://docs.expedy.io/en/digital-signage/displays/post-displays-display-id-resolution", "description": "Full documentation for Set Resolution & Frequency" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "display_resolution": { "type": "string", "example": "1920x1080" }, "display_frequency": { "type": "string", "example": "60" } }, "required": [ "display_resolution", "display_frequency" ] }, "example": { "display_resolution": "1920x1080", "display_frequency": "50.00" } } } }, "responses": { "200": { "description": "OK\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| `last_ping` | `integer` | No | |\n\n**Response Example:**\n\n```json\n{\n \"request_uid\": \"1X5ERXL94BYVWHP92DK3MCASUGJ\"\n}\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "last_ping": { "type": "integer" } } }, "example": { "request_uid": "1X5ERXL94BYVWHP92DK3MCASUGJ" } } } } }, "security": [ { "apiKeyAuth": [] } ] } }, "/displays/{display_id}/orientation/{display_orientation}": { "get": { "summary": "Set Orientation", "description": "This endpoint allows you to set/change the display's orientation.\n\nValid arguments are : \"norotate\", \"rotateleft\", \"rotateright\", \"invert\"", "operationId": "get_displays_Bydisplay_id_orientation_Bydisplay_orientation", "tags": [ "displays" ], "parameters": [ { "name": "display_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "display_orientation", "in": "path", "required": true, "description": "norotate,rotateleft,rotateright,invert", "schema": { "type": "string" } } ], "externalDocs": { "url": "https://docs.expedy.io/en/digital-signage/displays/get-displays-display-id-orientation-display-orientation", "description": "Full documentation for Set Orientation" }, "responses": { "200": { "description": "OK\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| `last_ping` | `number` | No | (ex: `1641509604`) |\n\n**Response Example:**\n\n```json\n{\n \"last_ping\": 1641509604\n}\n```", "content": { "application/json": { "schema": { "type": "object", "properties": { "last_ping": { "type": "number", "example": "1641509604" } } }, "example": { "last_ping": 1641509604 } } } } }, "security": [ { "apiKeyAuth": [] } ] } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "API key issued by Expedy. Contact support to obtain one." } } }, "tags": [ { "name": "displays" } ] }