• Guia do Cliente
◼️ 9. Usuário
9.1.POST Cadastrar um usuário V1
URL
Entrada
JSON com os dados do usuário.
Request body
“`json
{
“login”: ” string “,
“nome”: ” string “,
“email”: ” string “,
“senha”: ” string q!”,
“telefoneFixo”: “string”,
“telefoneCelular”: “string”,
“idChefe”: “string”,
“registrosPorPagina”: “string”,
“alteraSenhaProximoLogin”: “string”,
“frequenciaTrocaSenha”: “string”,
“dataAgendamentoInativacao”: “string”,
“idHorarioTrabalho”: “string”,
“idCultura”: “string”,
“idCalendario”: “string”,
“notificacaoTTD”: “string”,
“clienteMaster”: “string”,
“idGrupoChefeImediato”: “string”,
“idClientePermissao”: “string”,
“idUnidadePermissao”: “string”
}
“`
| Campo | Valor | Obrigatório |
|---|---|---|
| ————————- | —————————————————————————————————————————————- | :———: |
| Login | Login do usuário limitado 50 caracteres | Sim |
| Nome | Nome do usuário limitado 250 caracteres | Sim |
| Email do usuário limitado 50 caracteres
ou |
Sim | |
| ClienteMaster | {0} = Não é Cliente Master
{1} = É Cliente Master |
Sim |
| AlteraSenhaProximoLogin | {0} = Não exige alteração de senha no próximo login
{1} = Exige alteração de senha no próximo login |
Sim |
| NotificacaoTTD | {0} = Não notifica o usuário quando documento com TTD vencida
{1} = Não notifica o usuário quando documento com TTD vencida |
Sim |
| RegistrosPorPagina | Quantidade de registros a exibir por página nos GRIDs Valor mínimo: {10}
Valor máximo: {500} |
Sim |
| IdCultura | {1} = Português
{2} = Espanhol {3} = Inglês |
Sim |
| TelefoneFixo | Limite de 15 caracteres:
(00) 00000-0000 Ou (00) 0000-0000 Ou “”(Sem valor) |
Sim |
| TelefoneCelular | Limite de 15 caracteres:
(00) 00000-0000 Ou (00) 0000-0000 Ou “”(Sem valor) |
Sim |
| FrequenciaTrocaSenha | Frequência em Meses:
Valor mínimo: {1} Valor máximo: {99} ou “”(Sem valor) |
Sim |
| DataAgendamentoInativacao | Data para inativação automática do usuário: Formato: aaaa-mm-dd ou “”(Sem valor) | Sim |
| IdChefe | Id usuário Chefe Imediato ou “”(Sem valor) | Sim |
| IdHorarioTrabalho | Id do horário de trabalho ou “”(Sem valor) | Sim |
| IdCalendario | Id do Calendário ou “”(Sem valor) | Sim |
| IdClientePermissao | Id do Cliente que será associado ao usuário | Sim |
| IdUnidadePermissao | Id da Unidade associado ao IdCliente | Sim |
O sistema retorna o id do usuário adicionado.
Response
“`json
Usuário adicionado com sucesso. IdUsuario: guid
“`
9.2.PATCH Alterar senha de um usuário V1
URL
https://api-rest.arquivar.com/api/Usuario/{IdUsuario}/AlterarSenhaUsuario
Entrada
• IdUsuario
• JSON com a nova senha
Request body
“`json
{
“novaSenha”: “string”//nova senha do usuário
}
“`
Saída/Retorno
O sistema retorna o status 200 OK.
Response
“`json
Registro alterado com sucesso.
“`
9.3.PATCH Alterar status de um usuário V1
URL
https://api-rest.arquivar.com/api/Usuario/{IdUsuario}/AlterarStatusUsuario
Entrada
• IdUsuario
• JSON com a nova senha
Request body
“`json
{
“novoStatus”: “I”
}
“`
Saída/Retorno
O sistema retorna o status 200 OK.
Response
“`json
Registro alterado com sucesso.
“`
—
Atualizado há 10 dias