# Lista de horários de funcionamento

Retorna lista dos horários de funcionamento.

Endpoint: GET /api/v3/opening-hours
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `week_day` (integer)
    Dia da semana do turno de horário de funcionamento.

- 0: Domingo
- 1: Segunda-feira
- 2: Terça-feira
- 3: Quarta-feira
- 4: Quinta-feira
- 5: Sexta-feira
- 6: Sábado

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

## Response 200 fields (application/json):

  - `data` (object)
    Representa um conjunto de horários de funcionamento.

  - `data.opening_hours` (array)
    Lista de horários de funcionamento.

  - `data.opening_hours.week_day` (integer)
    Dia da semana do turno de horário de funcionamento.

- 0: Domingo.
- 1: Segunda-feira.
- 2: Terça-feira.
- 3: Quarta-feira.
- 4: Quinta-feira.
- 5: Sexta-feira.
- 6: Sábado.

  - `data.opening_hours.time_start` (string)
    Hora de início do turno de horário de funcionamento no formato H:i.
    Example: "09:00"

  - `data.opening_hours.time_end` (string)
    Hora de fim do turno de horário de funcionamento no formato H:i.
    Example: "18:00"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields