Obter Bloqueios de Agendamentos

Descrição

Recupera todos os bloqueios ativos aplicados sobre colaboradores, áreas ou recursos dentro do intervalo de datas informado.
Os bloqueios retornados descrevem o período afetado, o horário, os itens bloqueados e detalhes adicionais do bloqueio.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
startDate	date-time	Sim	Data inicial para pesquisa dos bloqueios.
endDate	date-time	Sim	Data final para pesquisa dos bloqueios.

📤 Estrutura da Resposta

A resposta é uma lista contendo os bloqueios ativos dentro do período solicitado.

Campo	Tipo	Descrição
`name`	string	Nome do bloqueio criado.
`startDate`	string	Data de início do bloqueio.
`endDate`	string	Data de término do bloqueio.
`startTime`	string	Horário de início do bloqueio (HH:MM).
`endTime`	string	Horário de término do bloqueio (HH:MM).
`description`	string	Descrição detalhada do bloqueio.
`totalBlocking`	boolean	Indica se o bloqueio é total (`true`) ou parcial (`false`).
`items`	objeto	Estrutura contendo os itens impactados pelo bloqueio (detalhado abaixo).

🧩 Estrutura de `items`

Agrupa todos os elementos que foram impactados pelo bloqueio.

`blockedEmployees` — Colaboradores Bloqueados

Campo	Tipo	Descrição
`idEmployee`	inteiro	Identificador do colaborador bloqueado.
`nameEmployee`	string	Nome do colaborador bloqueado.

`blockedAreas` — Áreas Bloqueadas

Campo	Tipo	Descrição
`idArea`	inteiro	Identificador da área bloqueada.
`nameArea`	string	Nome da área bloqueada.

`blockedResources` — Recursos Bloqueados

Campo	Tipo	Descrição
`nameResource`	string	Nome do recurso bloqueado.
`quantityResource`	inteiro	Quantidade bloqueada do recurso.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "name": "string",
        "startDate": "string",
        "endDate": "string",
        "startTime": "string",
        "endTime": "string",
        "description": "string",
        "totalBlocking": true,
        "items": {
            "blockedEmployees": [
                {
                    "idEmployee": 0,
                    "nameEmployee": "string"
                }
            ],
            "blockedAreas": [
                {
                    "idArea": 0,
                    "nameArea": "string"
                }
            ],
            "blockedResources": [
                {
                    "nameResource": "string",
                    "quantityResource": 0
                }
            ]
        }
    }
]

🟠400Bad Request

Get blocked appointments

Obter Bloqueios de Agendamentos#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

🧩 Estrutura de items#

blockedEmployees — Colaboradores Bloqueados#

blockedAreas — Áreas Bloqueadas#

blockedResources — Recursos Bloqueados#

Requisição