Pular para o conteúdo principal
Versão: 2.2.2

importUserV2

Este método possibilita inserir/editar:

  • Dados gerais de usuário;
  • Áreas e função (Identificador e nome);
  • Relacionamento entre usuário Área/Função/Equipe/Grupo de Acesso;
  • Relacionamento entre usuário e controlador de domínio;

Se o usuário já existir - matrícula já existente - as informações serão editadas e substituídas para as informações presentes na requisição.

  • Caso seja inserido valor ‘1’ no atributo UpdateType os atributos do tipo lista serão substituídos pelos presentes na requisição, caso nenhum valor ou 0 seja inserido, os valores serão adicionados aos já cadastrados no sistema.

A única diferença deste método importUserV2 para o método importUser, é que antes do sistema fazer toda a operação já realizada pelo método importUser, o sistema irá realizar a criação ou atualização das áreas e funções mencionadas no campo DeptPosArray.

Para a edição deste é necessário seguir o padrão abaixo documentado.

Classe Java
Requisiçãoweb/wwwroot/ws/java/administration/ImportUserV2RequestType.java
Retornoweb/wwwroot/ws/java/administration/ImportUserV2ResponseType.java

Requisição:

IdentificadorRequeridoDescrição
UserIdXMatrícula do usuário.
UserNameXDenominação do usuário.
UserLoginXNome utilizado pelo usuário para entrar no sistema
UserPasswordXSenha do usuário.
UserCounterSignContrassenha do usuário.
UserLanguageInformar código para idioma do usuário, conforme coluna "Código no banco de dados" da seção Localização, no documento Requisitos do Sistema
IsActiveUsuário habilitado (1 - Habilitado, 0 - Desabilitado).
IsEnabledUsuário bloqueado (1 - Bloqueado, 0 - Desbloqueado).
NumMaxConnectionsNúmero máximo de conexões simultâneas do usuário.
UserPhoneTelefone do usuário
UserEmailXEndereço de e-mail do usuário.
LeaderIdMatrícula do usuário líder
UserPhotoImagem do usuário em formato binário 64.
UserDomainIdIdentificador único do usuário no controlador de domínio.
DomainIdIdentificador do domínio AD cadastrado no SoftExpert Suite no qual o usuário está vinculado. (Utilizado na sincronização de dados do usuário com Controlador de Domínio).
AccGroupIdArrayLista de identificadores de grupo de acesso, separados por vírgula, caso queira se adicionar mais de um.
DeptPosArrayLista de identificadores e nomes de áreas e funções do usuário. Cada posição desta lista (array) representa uma área e função que irá possuir os seguintes campos:
DEPARTMENTID: String; Identificador da área;
DEPARTMENTNAME: String; Título da área;
POSITIONID: String; Identificador da função;
POSITIONNAME: String; Título da função;
TeamIdArrayLista de identificadores de equipe separados por vírgula caso se queira adicionar mais de uma equipe.
UpdateTypeDefinição de como as listas de valores dos parâmetros AccGroupIdArray, DeptPosArray e TeamIdArray serão considerados na importação do usuário:
▪ Ao salvar o usuário, quando informado 0, os valores informados nos parâmetros AccGroupIdArray, DeptPosArray e TeamIdArray serão acrescentados aos valores já definidos em cadastro prévio do usuário;
▪ Ao salvar o usuário, quando informado 1, os valores informados nos parâmetros AccGroupIdArray, DeptPosArray e TeamIdArray substituirão os valores já definidos em cadastro prévio do usuário;
Obs.: Caso o valor não seja informado, o sistema irá considerar 0 por padrão.
info
  • X¹ - Requerido se o campo DomaindId estiver preenchido.
  • X² - Requerido se o campo UserDomaindId estiver preenchido.
cuidado

Para saber qual é o identificador do controlador do domínio você deve selecionar o retorno da coluna OID da seguinte SQL:

select OID, * from ADAUTHLDAPCONFIG

Caso seja necessário fazer o vínculo do usuário com o AD via web service, recomendamos que seja desabilitada a sincronização de usuários. Para tal, basta acessar a tela Configuração -> Autenticação, ir na aba Opções Gerais e desmarcar a opção "Habilitar agendamento da sincronização".

cuidado

Você só pode inserir ou editar um usuário de cada vez utilizando esse método. Isso significa que não é possível atualizar uma lista de usuários enviando uma única requisição.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:admin">
<soapenv:Header/>
<soapenv:Body>
<urn:importUserV2>
<!--You may enter the following 19 items in any order-->
<urn:UserId>?</urn:UserId>
<urn:UserName>?</urn:UserName>
<urn:UserLogin>?</urn:UserLogin>
<urn:UserPassword>?</urn:UserPassword>
<!--Optional:-->
<urn:UserCounterSign>?</urn:UserCounterSign>
<!--Optional:-->
<urn:UserLanguage>?</urn:UserLanguage>
<!--Optional:-->
<urn:IsActive>?</urn:IsActive>
<!--Optional:-->
<urn:IsEnabled>?</urn:IsEnabled>
<!--Optional:-->
<urn:NumMaxConnections>?</urn:NumMaxConnections>
<!--Optional:-->
<urn:UserPhone>?</urn:UserPhone>
<!--Optional:-->
<urn:UserEmail>?</urn:UserEmail>
<!--Optional:-->
<urn:LeaderId>?</urn:LeaderId>
<!--Optional:-->
<urn:UserPhoto>cid:1016152952596</urn:UserPhoto>
<!--Optional:-->
<urn:UserDomainId>?</urn:UserDomainId>
<!--Optional:-->
<urn:DomainId>?</urn:DomainId>
<!--Optional:-->
<urn:AccGroupIdArray>?</urn:AccGroupIdArray>
<!--Optional:-->
<urn:DeptPosArray>
<!--Zero or more repetitions:-->
<urn:DeptPos>
<!--You may enter the following 4 items in any order-->
<urn:DepartmentID>?</urn:DepartmentID>
<urn:DepartmentName>?</urn:DepartmentName>
<urn:PositionID>?</urn:PositionID>
<urn:PositionName>?</urn:PositionName>
</urn:DeptPos>
</urn:DeptPosArray>
<!--Optional:-->
<urn:TeamIdArray>?</urn:TeamIdArray>
<!--Optional:-->
<urn:UpdateType>?</urn:UpdateType>
</urn:importUserV2>
</soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
UserIDMatrícula do usuário cadastrado ou editado.
StatusStatus da resposta da requisição.
DetailDetalhes da requisição.
CódigoDescrição
59Idioma não suportado pela base de dados
60Idioma inexistente