Operações relacionadas à estrutura da Empresa
Lista de Usuários #
GET /open_api/v1/users
Retorna listagem dos Usuários da Empresa
Parâmetros #
| Parâmetro | Em | Tipo | Obrig. | Descrição |
|---|---|---|---|---|
user_ids |
formData | array[integer] | Filtro de id do usuário da Empresa. | |
email |
query | string | Filtro pelo email do usuário. Permite busca parcial. | |
name |
query | string | Filtro pelo nome do usuário. Permite busca parcial. | |
order_by |
query | string | Retorna usuários ordenados pelos campos: name, email, created_at or updated_at fields. Valores: name, email, created_at, updated_at Padrão: created_at |
|
sort |
query | string | Retorna dados de forma asc ou desc. Valores: asc, desc Padrão: desc |
Resposta (200) #
Retorna listagem dos Usuários da Empresa
Lista de:
| Campo | Tipo | Descrição |
|---|---|---|
id |
integer | ID do usuário. |
name |
string | Nome do usuário. |
email |
string | E-mail do usuário. |
status |
string | Status do usuário. |
roles |
array[string] | Lista de papéis (roles) atribuídos ao usuário. |
Detalhes de um usuário #
GET /open_api/v1/users/{id}
Retorna detalhes de um usuário através do :id
Parâmetros #
| Parâmetro | Em | Tipo | Obrig. | Descrição |
|---|---|---|---|---|
id |
path | integer | ✔ |
Resposta (200) #
Retorna detalhes de um usuário através do :id
Lista de:
| Campo | Tipo | Descrição |
|---|---|---|
id |
integer | ID do usuário. |
name |
string | Nome do usuário. |
email |
string | E-mail do usuário. |
status |
string | Status do usuário. |
roles |
array[string] | Lista de papéis (roles) atribuídos ao usuário. |
departments |
array[Checkbits_Entities_Show_Department] | Hierarquia de departamentos do usuário. |
Dados da Empresa #
GET /open_api/v1/company
Retorna dados da Empresa
Resposta (200) #
Retorna dados da Empresa
Lista de:
| Campo | Tipo | Descrição |
|---|---|---|
id |
string | |
name |
string | |
corporate_name |
string |
Estrutura de departamentos #
GET /open_api/v1/departments
Retorna dados da Árvore de departamentos
Resposta (200) #
Retorna dados da Árvore de departamentos
Lista de:
| Campo | Tipo | Descrição |
|---|---|---|
id |
string | |
name |
string | |
children |
Checkbits_Entities_Show_Department |