Manual Web Services

Multiportal

Versão 1.3

1
Histórico de revisão

Versão Data Responsável Descrição

1.0 10/11/2015 Daniel Lima Criação do Documento
1.1 24/03/2016 Daniel Lima Adição de novos serviços
1.2 17/05/2017 Daniel Lima Adição de novos serviços:
• controleAcesso
• consultaVinculoEquipamento
• trocaEquipamentoVeiculo
• vinculoEquipamentoVeiculo
• vinculoVeiculoCliente
Adição de novas operações para serviços
existentes.
1.3 06/08/2018 Daniel Lima Adição de novos serviços:
• dominioTipoVeiculo
• dominioCodigoRetorno
• vinculoClienteEmpresa
Remoção Anexo 10 - Tabela Códigos de
Retorno.

2
Introdução
A Multiportal disponibiliza uma interface para sincronismo e carga de dados através do
Web Service disponível na url abaixo:

http://webmportal.dynalias.net:83/services/IntegracaoAdmService?wsdl

Para utilização dos serviços descritos nesse endereço é necessário a utilização de

credenciais de acesso (id e senha). Caso não disponha das credenciais solicite para
suporte@multiportal.com.br ou cadastre no item “Veículo Integração” do menu
“Cadastros Gerais”.

O endereço do Web Service pode variar dependendo do ambiente em que o Portal do

cliente esta configurado. Dessa forma também é necessário confirmar essa questão
com o suporte da Multiportal.

Esse Web Service (IntegracaoAdmService) é composto pelos serviços listados abaixo:

• obtemVersaoWS (Serviço Privado)

• zeraTransacoes (Serviço Privado)
• sincroniza
• sincronizaCliente
• sincronizaVeiculo
• sincronizaEquipamento
• sincronizaUsuario
• sincronizaChip
• listarFabricantes
• controleAcesso
• consultaVinculoEquipamento
• trocaEquipamentoVeiculo
• vinculoEquipamentoVeiculo
• vinculoVeiculoCliente
• dominioTipoVeiculo

3
 • dominioCodigoRetorno
• vinculoClienteEmpresa

Os serviços indicados como privados são restritos a Multiportal e por essa razão não
serão detalhados nesse documento.

Esse Web Service possui algumas entidades relacionadas conforme diagrama a seguir:

Os identificadores, utilizados como chave, dessas entidades estão listados abaixo:

• Cliente – documento (CPF/CNPJ)
• Veículo – chassi
• Equipamento – número serial (serialNumber) + fabricante (Chave composta)

Detalhes do funcionamento dos serviços, parâmetros utilizados e retorno são

apresentados a seguir.

4
obtemVersaoWS

Serviço privado.

zeraTransacoes

Serviço privado.

sincroniza

Serviço que permite o sincronismo de todos os dados do cliente através e uma única
chamada. Não deve ser utilizado no escopo desse projeto.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 - Cadastro
cliente Cliente Anexo 1

Retorno:

Nome Detalhe
ResponseCode Anexo 2

5
sincronizaCliente

Serviço que permite o cadastro de novos clientes. Existem 2 tipos possíveis de

clientes no sistema monitoramento, Pessoa e Empresa. No cadastro do cliente é
possível especificar uma série de dados relacionados ao mesmo (Endereços, Contatos,
Veículos) além do usuário associado. Esse usuário associado é o usuário admin do
portal do cliente.

A opção de cadastro incremental (codigoOperacao = 4) é recomendável em casos de

inclusões recorrentes de novos veículos ou dispositivos para clientes que já foram
previamente cadastrados.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Cadastro
2 – Alteração
3 – Exclusão
4 – Cadastro Incremental
cliente Cliente Anexo 1

Retorno:

Nome Detalhe
ResponseCode Anexo 2

6
sincronizaVeiculo

Serviço que permite o cadastro dos veículos dos Clientes (Pessoa ou Empresa).

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Cadastro
2 – Alteração
3 – Exclusão
veiculo Veiculo Anexo 3

Retorno:

Nome Detalhe
ResponseCode Anexo 2

7
sincronizaEquipamento

Serviço que permite o cadastro de Equipamentos (Dispositivos). No cadastro do

dispositivo é possível informar os dados do Chip (Simcard).

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Cadastro
2 – Alteração
3 – Exclusão
equipamento Equipamento Anexo 4

Retorno:

Nome Detalhe
ResponseCode Anexo 2

8
sincronizaUsuario

Serviço que permite a criação e edição dos usuários que terão acesso ao sistema da
Multiportal. Ao criar ou editar um usuário é possível informar a qual Cliente (Pessoa
ou Empresa) o mesmo esta associado. Através dos parâmetros da entidade Usuário
também é possível informar qual grupo de acesso ao sistema da Multiportal. O grupo
de acesso é habilita quais funcionalidades o usuário terá permissão de acesso. Além
disso é possível informar se o usuário criado receberá ou não o e-mail de boas vindas
ao sistema.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Cadastro
2 – Alteração
3 – Exclusão
usuario Usuario Anexo 5

Retorno:

Nome Detalhe
ResponseCode Anexo 2

9
sincronizaChip

Serviço que permite alterar o status do chip. O novo status deve ser informado
conforme valores disponíveis no domínio do parâmetro (statusChip). A alteração do
status do chip pode ser feita de 2 maneiras:
1. Utilizando o identificador do chip (ICCID) representado no parâmetro serialChip.
2. Através da chave composta formada pelo identificador do equipamento e do
fabricante representando pelos parâmetros serialEquipamento e fabricante
respectivamente.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
statusChip Integer Dominio:
1 – Ativo
2 – Bloqueado
3 – Cancelado
4 – Suspenso
serialChip String
serialEquipamento String
fabricante Integer

Retorno:

Nome Detalhe
ResponseCode Anexo 2

URL Exemplo (Caso 1):

http://webmportal.dynalias.net:83/services/IntegracaoAdmService/sincronizaChip?
id=209&senha=6158a078c585d91d6dd64b17f9cf3c01&idTransacao=2016030700001&statusChip=
2&serialChip=89000000000000000015

Retorno Exemplo:

10
listarFabricantes

Serviço quer retorna a lista de fabricantes dos equipamentos. O código de

identificação do fabricante forma a chave composta de identificação do Equipamento
em conjunto com o número serial do mesmo.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial

Retorno:

Nome Detalhe
Dominio Anexo 6

URL Exemplo:

http://webmportal.dynalias.net:83/services/IntegracaoAdmService/listarFabricantes?
id=209&senha=6158a078c585d91d6dd64b17f9cf3c01

Retorno Exemplo:

11
controleAcesso

Serviço que permite habilitar ou desabilitar o acesso ao Portal para um usuário em

específico ou um conjunto de usuários pertencentes a um determinado Cliente
conforme código de operação utilizado.

O parâmetro cliente somente é necessário no caso das operações 1 e 2.

O parâmetro usuario somente é necessário no caso das operações 3 e 4.

Atenção: Embora exista essa possibilidade de habilitar e desabilitar o acesso dos

usuários, recomenda-se realizar esse controle de acesso através do Portal do próprio
cliente.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 - Habilita Todos Usuários do Cliente
2 - Desabilita Todos Usuários do Cliente
3 - Habilita Usuario
4 - Desabilita Usuario
cliente Cliente Anexo 1
usuario Usuario Anexo 5

Retorno:

Nome Detalhe
ResponseCode Anexo 2

12
consultaVinculoEquipamento

Serviço que permite a consulta dos vínculos entre Veículos e Equipamentos conforme
a chave de pesquisa e código de operação.

Caso a operação seja de pesquisa por data (codigoOperacao = 1) a chave de pesquisa

deve utilizar o padrão “AAAAMMDD”, exemplo: 20180801 referente ao dia 01 de
Agosto de 2018. Caso a operação seja de pesquisa por Veiculo (codigoOperacao = 2)
a chave de pesquisa utilizada para identificação do Veiculo é o chassi. Caso a
operação de pesquisa seja por Dispositivo (codigoOperacao = 3) a chave de pesquisa
é uma concatenação entre o serialNumber + “;” + fabricante.

Os resultados são apresentados no campo “elements” do objeto ResponseCode e

compreende a concatenação dos campos chassi, serialNumber, fabricante,
data_inicio_vinculo, data_fim_vinculo.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Pesquisa por Data
2 – Pesquisa por Veiculo
3 – Pesquisa por
Dispositivo
chave String Chave de pesquisa
conforme o código de
operação utilizado.

Retorno:

Nome Detalhe
ResponseCode Anexo 2

13
trocaEquipamentoVeiculo

Serviço que permite que a troca de um equipamento seja realizada de forma mais
prática, sem a necessidade de precisar desvincular o antigo equipamento e vincular o
novo. Para utilização desse serviço é necessário que ambas as entidades (Veiculo e
Equipamento Antigo) estejam cadastradas. O Equipamento Novo é facultativo de estar
cadastrado.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
chassi String Identificador do Veículo
equipamentoAntigo Equipamento Anexo 4
equipamentoNovo Equipamento Anexo 4
data String Data da troca no formato:
aaaaMMddHHmmss

Exemplo: 20170517093000

Retorno:

Nome Detalhe
ResponseCode Anexo 2

14
vinculoEquipamentoVeiculo

Serviço que permite o vinculo ou desvinculo do equipamento de um veiculo. Esse tipo

de operação é útil quando é feita a troca do equipamento de um veículo ou quando o
equipamento é retirado em definitivo de um veículo.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Vinculo
2 – Desvinculo
chassi Equipamento Identificador do Veículo
equipamento Equipamento Anexo 4
data String Data da troca no formato:

aaaaMMddHHmmss

Exemplo: 20170517093000

Retorno:

Nome Detalhe
ResponseCode Anexo 2

15
vinculoVeiculoCliente

Serviço que permite o vinculo ou desvinculo do veiculo de um cliente. Esse tipo de

operação é útil quando um veículo muda de proprietário. Para utilização desse serviço
é necessário que ambas as entidades (Veiculo e Cliente) estejam cadastradas.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Vinculo
2 – Desvinculo
chassi Equipamento Identificador do Veículo
cliente Cliente Anexo 1
data String Data da troca no formato:

aaaaMMddHHmmss

Exemplo: 20170517093000

Retorno:

Nome Detalhe
ResponseCode Anexo 2

16
vinculoClienteEmpresa

Serviço que permite o vinculo ou desvinculo de um Cliente (propriedade

categoriaCliente do “Anexo 1 – Cliente” configurado com o valor = “C” ) de uma
Empresa (propriedade categoriaCliente do “Anexo 1 – Cliente” configurado com o
valor = “E”). Em algumas operações, como no caso de associações, é necessário
realizar essa modelagem entre Empresa – Cliente - Veiculo.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial
idTransacao Long Identificador da Transação
codigoOperacao Integer 1 – Vinculo
2 – Desvinculo
documentoCliente String Documento identificador do Cliente
tipoDocumentoCliente String F – Física; J - Jurídica
documentoEmpresa String Documento identificador da Empresa
tipoDocumentoEmpresa String F – Física; J - Jurídica

Retorno:

Nome Detalhe
ResponseCode Anexo 2

17
dominioTipoVeiculo

Serviço que retorna o domínio dos tipos de veículos (propriedade tipoVeiculo do Anexo
3 – Veiculo). O objetivo desse serviço é facilitar a inclusão de novos tipos desse
domínio utilizado no sincronismo.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial

Retorno:

Nome Detalhe
ResponseCode Anexo 2

URL Exemplo:

http://webmportal.dynalias.net:83/services/IntegracaoAdmService/
dominioTipoVeiculo?id=209&senha=6158a078c585d91d6dd64b17f9cf3c01

Retorno Exemplo:

18
dominioCodigoRetorno

Serviço que retorna o domínio dos códigos de retorno do Web Service. Nas chamadas
aos serviços do Web Service sempre é retornado um código de retorno informando se
a execução foi bem sucedida ou não (propriedade “statusCode” do Anexo 2 –
ResponseCode). Cada código representa o motivo da falha ou sucesso da execução.
Foi criado esse serviço para facilitar a inclusão de novos códigos de retorno de
validações realizadas.

Parâmetros:

Nome Tipo Detalhe

id String Credencial
senha String Credencial

Retorno:

Nome Detalhe
ResponseCode Anexo 2

URL Exemplo:

http://webmportal.dynalias.net:83/services/IntegracaoAdmService/
dominioCodigoRetorno?id=209&senha=6158a078c585d91d6dd64b17f9cf3c01

Retorno Exemplo:

19
Anexo 1 – Cliente

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do cliente do sistema
que esta chamando o Web Service. Informação será útil
nas análises e manutenções posteriores
tipoCliente Texto N F – Física; J - Jurídica
documento Texto N Se for tipoCliente = F – CPF
Se for tipoCliente = J – CNPJ
categoriaCliente Texto N C - Cliente (Pessoa)
E - Empresa
nome Texto N Se for tipoCliente = F – Nome do Cliente
Se for tipoCliente = J – Nome da Empresa
clienteFinal Bool S Não utilizar esse campo
email Texto N
numeroContrato Texto S Caso exista algum número de contrato entre o cliente a
empresa que esta fazendo a integração
diaVencimentoFatura Int S Utilizada na rotina de faturamento.
tempoContrato Int S 1 – 12 meses
2 – 24 meses
3 – 36 meses
formaPagamento Int S 1 - Boleto
2 - Cartão de Crédito
3 - Cheque
4 - Depósito
5 - Dinheiro
nomeFantasia Texto S Caso tipoCliente = J
nroInscricaoMunicipal Int S Caso tipoCliente = J
ufInscricaoMunicipal Texto S Caso tipoCliente = J.
Unidade Federativa. Ex: SP, RJ
nroInscricaoEstadual Int S Caso tipoCliente = J
recolheIss Bool S Caso tipoCliente = J
True – se recolhe
False – se não recolhe
rg Texto S Caso seja tipoCliente = F
Documento do cliente
rgInscricao Texto S Ex: SSP
sexo Texto S Masculino; Feminino
estadoCivil Texto S Solteiro
Casado
Separado
Viúvo
nomeMae Texto S Caso seja tipoCliente = F
dtNascimento Texto S Caso seja tipoCliente = F
listaEnderecos Endereco S Lista de Endereços
listaContatos Contato S Lista de Contatos
listaVeiculos Veiculo S Lista de Veículos
usuario Usuario S Usuario que será criado associado ao Cliente

20
Anexo 2 – ResponseCode

Parâmetro Tipo Descrição

transactionId Texto Identificador da Transação passado na chamada
statusCode Texto Código do Erro ou Retorno - Dominio disponível no serviço:
dominioCodigoRetorno
statusDescription Texto Descrição do Erro ou Retorno
elements Texto[] Utilizado nos serviços de consulta que retornam mais de um
valor

Anexo 3 – Veiculo

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do veículo do sistema que
esta chamando o Web Service. Informação será útil nas
análises e manutenções posteriores.
chassi Texto N
placa Texto S
tipoVeiculo Int N Dominio disponível no serviço: dominioTipoVeiculo
marca Texto S Fabricante do veículo. Exemplo: Fiat, Ford, etc
modelo Texto S
anoModelo Int S Exemplo: 2014
anoFabricacao Int S Exemplo: 2014
cor Texto S
codigoRenavam Int S
codigoFipe Int S
apelido Texto S Algumas empresas utilizam códigos ou outros
identificadores para representar o veículo. Utilize esse
campo com esse propósito caso tenha necessidade
agendamento Bool S Não utilizar esse campo
listaEquipamento Equipamento S Lista de Equipamentos

21
Anexo 4 – Equipamento

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do dispositivo do sistema
que esta chamando o Web Service. Informação será útil
nas análises e manutenções posteriores.
serialNumber Texto N Serial do dispositivo
fabricante Int N Verificar serviço : listarFabricantes
firmware Texto S Versão do firmware
msisdn Texto S Número da linha do Chip
iccid Texto S Serial do Chip
statusChip Int S 1 – Ativo (default)
2 – Bloqueado
3 – Cancelado
4 – Suspenso
operadora Texto S Tim
Claro
Oi
Vivo
ip Texto S Ip de comunicação configurado no equipamento
porta Int S Porta de comunicação configurado no equipamento
localInstalacao Texto S Local onde o dispositivo foi instalado. Útil no caso de uma
manutenção ou retirada.
tipoChip Int S 1 – Pré-pago
2 – Pós-pago
tipoEquipamento Int S 1 – Fixo
2 - Móvel
tipoComunicacao Int S 1 – GPRS
2 – Satélite
3 – Híbrido
dtInstalacao Texto S Padrão: AAAAMMDD
Exemplo: 20160323

22
Anexo 5 – Usuario

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do usuário do sistema
que esta chamando o Web Service. Informação será útil
nas análises e manutenções posteriores.
login Texto N Login de acesso ao sistema
senha Texto N Senha de acesso inicial (sem criptografia). Caso não
informado será igual ao login.
nome Texto N
tipoUsuario Texto N A – Administrador
C - Cliente
codigosGrupo Texto N Lista de grupos de acesso ao sistema delimitados por ";"
caso possua mais de um grupo. Cada grupo possui um
conjunto de funcionalidades no sistema liberadas. Para
obter o código do grupo entre no portal de
monitoramento, menu Administração >> Grupos. Em
caso de dúvidas suporte@multiportal.com.br. Exemplo:
10;25;91
documentoCliente Texto S Documento do cliente caso deseje associar usuário ao
cliente
email Texto S Endereço para qual será enviado o e-mail de boas vindas
enviarEmail Bool S True – se será enviado o e-mail de boas vindas
False – se não será enviado o e-mail (default)

Anexo 6 – Dominio

Parâmetro Tipo Descrição

codigo Texto Código ou valor de identificação
descricao Texto Descrição do código ou valor

23
Anexo 7 – Endereco

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do endereço do sistema que
esta chamando o Web Service. Informação será útil nas análises
e manutenções posteriores.
tipoEndereco Int N 1 - Residencial
2 - Comercial
3 - Cobrança
4 - Entrega
tipoLogradouro Int N Anexo 9
logradouro Texto N
numero Int N
bairro Texto N
cidade Texto N
uf Texto N Exemplo: SP, RJ, PB
cep Int N Exemplo: 04726160
complemento Texto S
latitude Double S
longitude Double S

24
Anexo 8 – Contato

Parâmetro Tipo Opcional Descrição

codigoIntegracao Int S Código Opcional de identificação do contato do sistema que
esta chamando o Web Service. Informação será útil nas
análises e manutenções posteriores.
nome Texto N Nome do Contato
tipoContato Int N 1 - Telefone Comercial
2 - Telefone Celular
3 - Telefone Residencial
4 - Nextel
5 - E-mail
6 - Msn
7 - Skype
relacao Int N 1 – Amigo(a)
2 – Parente,
3 – corretor
4 – Trabalho
5 – Empregado(a)
6 – Conjugue
7 – Proprietário
8 – Emergência
9 – Não Informado
valor Texto N Valor do contato. Se tipo contato = 5 (e-mail) o valor será o e-
mail propriamente dito contato@mportal.com.br

Se o tipo contato = 1 (Comercial), o valor será (11) 4055-1410

palavraChave Texto S Utilizado em alguns casos pela central de monitoramento
cpf Texto S CPF do contato
rg Texto S RG do contato
horarioComercial Bool S True – se somente poderá ser contatado em horário comercial
False – se poderá ser contatado em qualquer horário

25
Anexo 9 – Tipo Logradouro

Tipo Descrição
AC ACESSO
AL ALAMEDA
ANTIGA ESTR ANTIGA ESTRADA
AV AVENIDA
BC BECO
CAM CAMINHO
COR CORREDOR
ESTR ESTRADA
LD LADEIRA
LRG LARGO
PAS PASSEIO
PASS PASSAGEM
PCA PRACA
PTE PONTE
Q QUADRA
R RUA
ROAN RODO ANEL
ROD RODOVIA
SRV SERVIDAO
TV TRAVESSA
V VILA
V AC VIA DE ACESSO
VD VIADUTO
VE VIELA
VIA VIA

26
27