Este método é responsável pela criação de novos usuários
- Endpoint: /api/retaguarda/v2/usuarios
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de usuários para que possam ser enviados vários na mesma requisição
Para que a baixa do usuário criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 4 = usuário
Requisição
Exemplo de body da requisição
[
{
"idRetaguardaPerfil": "string",
"nome": "string",
"cpf": "string",
"login": "string",
"senha": "string",
"administrador": 0,
"situacao": 0,
"senhaCriptografada": "string",
"matricula": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
idRetaguardaPerfil |
string |
Identificador do Perfil na retaguarda |
Não |
Tamanho Máximo: 100 caracteres |
| situacao | int | Situação do usuário () | Não | 0 - inativo, 1 - Ativo Se não enviado será cadastrado como 0 |
| senhaCriptografada | string | Senha do usuário criptografada | Não | Tamanho Máximo: 256 caracteres |
| senha | string | Senha do usuário | Sim |
Tamanho Máximo: 256 caracteres |
| nome | string | Nome do usuário | Sim |
Tamanho Máximo: 150 caracteres |
| matricula | string | Matrícula do usuário | Não | Tamanho Máximo: 50 caracteres |
| loteOrigem | string | Identificador do lote externo | Sim | |
| login | string | Login do usuário | Sim |
Tamanho Máximo: 30 caracteres |
| idRetaguarda | string | Identificador do usuário na retaguarda | Sim | Tamanho Máximo: 100 caracteres |
| idProprietario | string | Identificador do proprietário | Sim | |
| idInquilino | string | Identificador do inquilino | Sim | |
| cpf | string | CPF do usuário | Não |
Tamanho Máximo: 20 caracteres |
| administrador | int | Indica se é administrador | Não | 0 - não, 1 - sim Se não enviado será cadastrado como 0 |
Retorno
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.
Requisição
Exemplo de body da requisição
[
{
"administrador": 0,
"cpf": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaPerfil": "string",
"login": "string",
"loteOrigem": "string",
"matricula": "string",
"nome": "string",
"senha": "string",
"senhaCriptografada": "string",
"situacao": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
| idRetaguardaPerfil | string | Perfil associado ao usuário para validação de permissão de acesso a funcionalidades. | Sim | |
| nome | string | Nome do usuário | Sim |
Tamanho Máximo: 150 caracteres |
| cpf | string | CPF do usuário | Não |
Tamanho Máximo: 20 caracteres |
| login | string | Login do usuário | Sim |
Tamanho Máximo: 30 caracteres |
| senha | string | Senha do usuário | Sim |
Tamanho Máximo: 256 caracteres |
| administrador | int | Identifica se o usuário terá acesso administrador independente do seu perfil. | Sim | 0 - não, 1 - sim |
| situacao | int | Situação do usuário | Sim | 0 - inativo, 1 - Ativo |
| senhaCriptografada | string | Senha do usuário criptografada | Não | Tamanho máximo: 256 caracteres |
| matricula | string | Matrícula do usuário | Não | Tamanho máximo: 50 caracteres |
| idInquilino | string | Identificador do inquilino | Sim | |
| idRetaguarda | string | Identificador do usuário na retaguarda | Sim | Tamanho máximo: 100 caracteres |
| idProprietario | string | Identificador do proprietário | Sim | |
| loteOrigem | string | Identificador do lote externo | Sim |
Retornos
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas