Consulta informações sobre os departamentos com base nos filtros fornecidos.

GET

/v2/Empresas/Departamentos

Este endpoint permite consultar os departamentos no sistema com base em parâmetros de filtro fornecidos no modelo.
Ele valida a quantidade de registros solicitados e retorna os departamentos correspondentes.

Validações:

Verifica se o número total de registros solicitado não ultrapassa 500.

Exemplo de Requisição:

Valores e Descrições dos Enums:

Enum TipoDepartamento

Valor	Descrição
1	Escritório
2	Empresa
3	Ambos

Enum AtivoInativoEnum

Valor	Descrição
1	Ativo
2	Inativo

Exemplo de resposta (sucesso):

{
  "status": true,
  "message": "Ok",
  "data": [
    {
      "IdDepartamento": 1,
      "NomeDepartamento": "TI",
      "Ambiente": "1",
      "Status": "1"
    },
    {
      "IdDepartamento": 2,
      "NomeDepartamento": "RH",
      "Ambiente": "2",
      "Status": "1"
    }
  ]
}

Exemplo de resposta (erro):

{
  "status": false,
  "message": "Total de registros não pode ser superior a 500",
    "dados": null
}

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Retorna a lista de departamentos conforme o filtro informado.

Body

🟠400Solicitação incorreta

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/Empresas/Departamentos?IdDepartamento&Ambiente&Status&TotalRegistros&Pagina' \
--header 'Authorization: <api-key>'

Response Example

200 - Exemplo 1

{
    "sucesso": true,
    "mensagens": "string",
    "dados": {
        "idDepartamento": 0,
        "nomeDepartamento": "string",
        "ambiente": "string",
        "status": "string"
    }
}

Modificado em 2025-09-24 14:39:45

Página anterior

Cadastro de uma nova empresa no sistema.

Próxima página

Edição de uma empresa existente no sistema.