> For the complete documentation index, see [llms.txt](https://help.edgecontents.com/edgecontents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.edgecontents.com/edgecontents/apis/telas.md).

# Telas

## Endpoints

* ### Lista de telas por local

**URL:** \<seuprojeto>.edgecontents.com/ds/api/screen

**Método:** GET

**Autenticação:** Basic Auth

**Parâmetros de Consulta:**

| Parâmetro  | Tipo | Obrigatório | Descrição   |
| ---------- | ---- | ----------- | ----------- |
| id         | int  | Não         | ID do local |
| screen\_id | int  | Não         | ID da tela  |

**Exemplo de retorno:**

```json
{
    "5": {
        "name": "P5 LED",
        "abbreviation": "",
        "licenced": "false",
        "enabled": "true",
        "browser": "TB 2 HOMOLOGAÇÃO",
        "browser_id": 7,
        "internalid": "",
        "groups": [],
        "screen_images": [],
        "site_id": 1
    },
    "6": {
        "name": "TV Entrada",
        "abbreviation": "",
        "licenced": "true",
        "enabled": "true",
        "browser": "TV Entrada",
        "browser_id": 13,
        "internalid": "",
        "groups": [],
        "screen_images": [],
        "site_id": 6
    }
}
```

* ### Cadastro de telas

**URL:** \<seuprojeto>.edgecontents.com/ds/api/screen/add

**Método:** POST

**Autenticação:** Basic Auth

**Corpo da Requisição:**

| Campo        | Tipo   | Obrigatório | Descrição               |
| ------------ | ------ | ----------- | ----------------------- |
| name         | string | Sim         | Nome do player          |
| site         | int    | Sim         | ID do local             |
| browser      | int    | Sim         | ID do browser           |
| abbreviation | string | Não         | Abreviação do nome      |
| monitors     | int    | Não         | Quantidade de monitores |
| internalid   | string | Não         | ID interno              |
| licensed     | bool   | Não         | Player licenciado       |
| maintenance  | bool   | Não         | Player em manutenção    |

**Exemplo de requisição:**

```postman_json
[
    {
        "name": "Novo player",
        "site": 7,
        "browser": 28,
        "monitors": 2
    },
    {
        "name": "Novo player 2",
        "site": 7,
        "browser": 31,
        "abbreviation": "Nov. P2"
    }
]
```

**Exemplo de retorno:**

```json
{
    "successes": [
        {
            "id": "15",
            "name": "Novo player"
        },
        {
            "id": "16",
            "name": "Novo player 2"
        }
    ],
    "errors": []
}
```

* ### Edição de telas

**URL:** \<seuprojeto>.edgecontents.com/ds/api/screen/update

**Método:** POST

**Autenticação:** Basic Auth

**Corpo da Requisição:**

| Campo        | Tipo   | Obrigatório | Descrição               |
| ------------ | ------ | ----------- | ----------------------- |
| id           | int    | Sim         | ID do player            |
| name         | string | Não         | Nome do player          |
| browser      | int    | Não         | ID do browser           |
| abbreviation | string | Não         | Abreviação do nome      |
| monitors     | int    | Não         | Quantidade de monitores |
| internalid   | string | Não         | ID interno              |
| licensed     | bool   | Não         | Player licenciado       |
| maintenance  | bool   | Não         | Player em manutenção    |

**Exemplo de requisição:**

```postman_json
[
    {
        "id": 15,
        "licensed": true,
        "name": "Player P1"
    },
    {
        "id": 16,
        "maitenance": true
    }
]
```

**Exemplo de retorno:**

```json
{
    "successes": [
        {
            "id": "15",
            "name": "Player P1"
        },
        {
            "id": "16",
            "name": "Novo player 2"
        }
    ],
    "errors": []
}
```