neko/webpage/docs/api/screen-configurations-list.api.mdx
2025-03-22 17:52:56 +01:00

63 lines
No EOL
4 KiB
Text

---
id: screen-configurations-list
title: "Get List of Screen Configurations"
description: "Retrieve a list of all available screen configurations."
sidebar_label: "Get List of Screen Configurations"
hide_title: true
hide_table_of_contents: true
api: eJzVV91v2zYQ/1cOLFBsgiy7yYANfstcrwuapkOcrg9JMJyls8SaIlWScuoZ/t+HI6VYcdKi2J7mF0vkffzu+7QTHksnpjfCGlOPXG6JtLhLRUEut7Lx0mgxFVfkraQNAYKSzoNZASoFuEGpcKkIIiPkRq9k2VpkPpeJVJiG4tt5IaYiks0eUV1I50UqLLnGaEdOTHfiZDLhv8cgLjrNz+oC20EswLV5Ts6tWqW2DCE32pP2LBCbRsk8cIw/OZa6Ey6vqEZ+8tuGxFSgtbgVqZCeajc4N8tPlDPUxrJVXkas97Lw1YBMak8lWZEK+oJ1o0hMX538Mjl26XVFEFjZJF/1LszEPhUVybLy35b588mzIiPrMzItevq2xNNnBVpaWXIVMP8TsftUeOmZWSyehlbs+ZeKnyavnkYzyv7ckvPhX1py0DqygK2vSPsuTv8mgl+JVE3OYTn0gvNW6lIc2/2aPEpFBZC1xkLH99jeOV+96yT2dp4+b6cjuyELrS7IOm9MEbzYWZ/CsmUXrFpHDrwJ9hsr/yaQ/n9j/T4VNfnKcJWXFLQjl4UYYyPH3FzGMWvGj+tWpCJ6h5vQk4o3OarOeyIVrVViKirvm+l4rPiuMs5PTyeTidjfsaC8tdJvg6RfCS3Zs5ZB3Nzt052YGbOWNDy5NmvSDwcDCQv2aXTbkOvQIhr5lkKPYJh5IBGp0Fjz7eX87fu/FvPF4vz95RPvnj3Kbmid1CUgOHKO36OsULFDCx40s/XsswBQTMUyEH2vligSPNsddAw88BXjPrdktwfbAuv3qgvE0KBzVAA6QAjSoEGLNXmyMamkXpmgv0uuS1obOPvjXKSCEyOqOM0m2eSJ4kAaCucjLa+uZ4C64MeFydfkYUlOFuTgar64ZolcXo01G1lw+aEaeVkT8KsB5y1hLXWZAjdHi7mXG4LcKIVLE9M1DfIt1cYTFOTW3jSwanXOl6ik32a3+la/ePECZsYSXFNeaaNMKcnxxQiS5M+gbdFrA8OtIaJPklsNMIJglaINWSzJQZL017Ay9gA8BWXuRwo96XybQiXLavS5DTA6mxgttoUcWJdFFW9puzRoi0BSm9YR0Ia0d4CWwFvUrpbeUxHxha6PNfVuzo3WFKwOkBxhrci5g+eMznqDrxjvNTt6IUv2EueGLmBm6rrVfc70boiR6z0RTO+PQIYJUUSVB2FS97B+oKzM0odiIudxqaSratI+hfPZHHLUhSx4ltGXvEJd0o8ZQFR2EeJdoT9IaBumdTHu685n4+ivFSq1xHwdPFahLlTvrQfMBx/0CcjQ5xuyW18x9LlydLD1qIxewqKD8Q41lsRWJAmMYMFtip6blgFnDz5g4pD3BibJlTF1oPnAvEdiZ5bQhwKoTSFX2/DIxDyBrFHB2VFp2LC4mrizu4GC111RzCKLC4LPik+tY8nP724p1AyE79dfS8usV7DYOk81/E6ofAUv4R3vfXnU062pQVEkqyJZXlG+dkHow0KKCqR2vC1F/LFsfzf3cO7hTCn4aOzawbUpyVdkmeBVNqzFGHIHNRUSDwUWQpwkR+0l7eqQIRToMUmyW32SHSU4adfyHoSQJA23PudD5i5lIS11XSZJjstv0AaGFRjtOs0G+Zckff/jtrKSmkalRanpIchJEnN4EOeu63HqPApcyO7feEXgXleEtcGlvMqEGROaBm/hIfELk7ecaT2nSIWSOWkXNpJuupw1mFcEJ6HTPxr39/f3GYbbzNhy3LG68cX5bH65mI9OsklW+VqFgdIY52vUA8FvyEP//RA3VZgd7yGPJsvusHb9h6+fbqJ6+uLHjUKpeeYGu3bdfnTD45Y/f4ypw1wPH2Bh6Ruiu0sF7zpMv9st0dEHq/Z7Po7zeXpzl4oNWsl44nojKsKCbFiG1rRl7+Y5NbyabVC1cdIfrZO8Az2scW/m12K//wdBW+iV
sidebar_class_name: "get api-method"
info_path: docs/v3/api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get List of Screen Configurations"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/room/screen/configurations"}
context={"endpoint"}
>
</MethodEndpoint>
Retrieve a list of all available screen configurations.
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"List of screen configurations retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"width":{"type":"integer","example":1280,"description":"The width of the screen."},"height":{"type":"integer","example":720,"description":"The height of the screen."},"rate":{"type":"integer","example":30,"description":"The refresh rate of the screen."}},"title":"ScreenConfiguration"}}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>