ObjetivoFazer o cadastro de um ou mais usuários no Comprovei.
Características
- As chamadas serão realizadas via
"SOAP" sobre HTTP;
- A origem do chamado do web service será o
sistema do cliente;
Autenticação
- As
chamadas terão autenticação a nível de transporte (Basic
Authentication);
- Solicite
o user / password ao administrador da conta.
POST http://soap.comprovei.com.br/importQueue/index.php HTTP/1.1
Accept-Encoding:
gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#uploadUsers"
Authorization: Basic {* user/password codificado em BASE64}
Content-Length: 117
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Descrição do método
Parâmetros de entrada
|
Atributo
|
Tipo
|
Obrigatório
|
Descrição
|
|
conteudoArquivo
|
Conjunto
de caracteres
|
Sim
|
Conteúdo
do arquivo XML codificado em Base64.
|
Estrutura do arquivo XML Estrutura Usuarios. TAG raiz que
contém todas as estruturas Usuario.
|
Atributo
|
Tipo
|
Obrigatório
|
Descrição
|
|
Usuario
|
Estrutura
Usuario
|
Sim
|
Contém
todas as informações do usuário a ser cadastrado.
|
Estrutura Usuario. Contém
diversas informações sobre o documento a ser importado.
|
Atributo
|
Tipo
|
Obrigatório
|
Descrição
|
|
Habilitar
|
Inteiro
|
Sim
|
Indica se o usuário será habilitado, caso
houver licença para tal.
|
|
Login
|
Conjunto
de caracteres
|
Sim
|
Login
do usuário para utilizar no sistema.
|
|
Senha
|
Conjunto de caracteres
|
Sim
|
Senha do usuário para utilizar no sistema.
|
|
Email
|
Conjunto de caracteres
|
Não
|
Email do usuário.
|
|
TipoUsuario
|
Inteiro
|
Sim
|
Tipo de usuário a ser cadastrado (ver tabela
tipo de usuário)
|
|
NomeCompleto
|
Conjunto de caracteres
|
Sim
|
Nome completo do usuário
|
|
Telefone
|
Conjunto de caracteres
|
Não
|
Telefone do usuário.
|
|
NumCNH
|
Conjunto de caracteres
|
Não
|
Número da CNH do usuário (somente
motorista).
|
|
VenctoCNH
|
Conjunto de caracteres
|
Não
|
Data de vencimento da CNH do usuário
(somente motorista). Formato: YYYY-MM-DD.
|
|
Regioes
|
Conjunto de caracteres
|
Não
|
Nome da Região para filtro automático no
Console. Pode ser enviado mais de uma região, separado por virgula.
|
|
Transportadoras
|
Conjunto de caracteres
|
Não
|
CNPJ da Transportadora para filtro no console.
Pode ser enviado mais de um CNPJ, separado por virgula.
|
|
Embarcadores
|
Conjunto de caracteres
|
Não
|
CNPJ do Embarcador para filtro no console.
Pode ser enviado mais de um CNPJ, separado por virgula.
|
Tipos de usuários
|
Valor
|
Descrição
|
|
2
|
Usuário
motorista.
|
|
3
|
Usuário
desktop.
|
|
5
|
Usuário
supervisor.
|
|
11
|
Usuário
transportador.
|
|
12
|
Usuário
embarcador.
|
Estrutura da requisição
Parâmetros de saída
|
Atributo
|
Tipo
|
Descrição
|
|
status
|
Conjunto de caracteres
|
Mensagem de sucesso ou de erro para a
chamada do método.
|
|
protocolo
|
Conjunto de caracteres
|
Protocolo para consultar a evolução do
pedido de importação. | Estrutura da saída
| 
