You are on page 1of 24

CTAPLUS – Especificação para

operações de consulta à base


de dados via Web Service
Introdução
Este documento apresenta a especificação a ser utilizada por sistemas de
informação de terceiros para consulta à base dados do sistema CTAPlus.

Interface de integração
O sistema CTAPlus disponibilizará a sistemas de informação de terceiros as
seguintes interfaces de integração:

 Posto

 Empresa

 Tanque

 Bomba

 Frentista

 Motorista

 Veiculo

 Informação adicional

 Informação adicional opções

Posto
Função:
A interface “Posto” permite ler registros de postos de abastecimento da
base dados do CTAPLus associados ao cliente correspondente ao token de
acesso informado.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebPosto?token=<token de
acesso>&formato=<formato de retorno do arquivo>
Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebPosto” segue o
seguinte formato:

<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<POSTOS>
<POSTO>
<ID></ID>
<NOME></NOME>
<ENDERECO></ENDERECO>
<BAIRRO></BAIRRO>
<CIDADE></CIDADE>
<UF></UF>
<ATIVO></ATIVO>
<POSTO_COMERCIAL></POSTO_COMERCIAL>
<CNPJ></CNPJ>
<OBSERVACAO></OBSERVACAO>
<CODIGO_POSTO></CODIGO_POSTO>
</POSTO>
...
<POSTO>
...
</POSTO>
</POSTOS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebPosto” segue o
seguinte formato:

{
"status": {
"codigo": “...”,
"mensagem": "..."
},
"postos": [
{
"id": “...”,
"nome": "...",
"endereco": "...",
"bairro": "...",
"cidade": "...",
"uf": "...",
"ativo": “...”,
"posto_comercial": “...”,
"cnpj": "...",
"observacao": "...",
"codigo_posto": “...”
}
]
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. POSTOS: Lista de todos os postos retornados pelo servidor;

3. POSTO: Entidade que armazena informações relativas a um posto;

a. ID: Identificação numérica e única do posto (inteiro);

b. NOME: Descrição textual do posto (Alfanumérico);

c. ENDEREÇO: Endereço comercial do posto (alfanumérico);

d. BAIRRO: Bairro do endereço do posto (alfanumérico);

e. CIDADE: Cidade do endereço comercial do posto


(alfanumérico);

f. UF: Sigla da unidade federativa do endereço comercial do


posto (Alfabético);

g. ATIVO: Indica se o cadastro do posto está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

h. POSTO_COMERCIAL: Indica se o posto é um posto comercial


(externo) ou interno do cliente (Lógico);

i. CNPJ: Valor do Número do cadastro nacional de pessoa


jurídica, para postos comerciais, caso contrário vazio
(numérico);

j. OBSERVACAO: Texto livre de observação para o posto


(alfanumérico);

k. CODIGO_POSTO: Código de identificação do posto fornecido


pelo cliente (alfanumérico);

Empresa
Função:
A interface “Empresa” permite ler registros de empresas cadastradas na
base dados do CTAPLus associadas ao cliente correspondente ao token de
acesso informado.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebEmpresa?token=<token de
acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebEmpresa” segue
o seguinte formato:
<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<EMPRESAS>
<EMPRESA>
<ID></ID>
<ATIVO></ATIVO>
<NOME></NOME>
<ENDERECO></ENDERECO>
<BAIRRO></BAIRRO>
<CIDADE></CIDADE>
<UF></UF>
<CNPJ></CNPJ>
<CONTATO></CONTATO>
<TELEFONE></TELEFONE>
<CODIGO_EMPRESA></CODIGO_EMPRESA>
</EMPRESA>
...
<EMPRESA>
...
</EMPRESA>
</EMPRESAS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebEmpresa”
segue o seguinte formato:

{
"status":{
"codigo":"...",
"mensagem":"..."
},
"empresa":[
{
"id":"...",
"cidade":"...",
"bairro":"...",
"contato":"...",
"uf":"...",
"ativo":"...",
"telefone":"...",
"nome":"...",
"cnpj":"...",
"endereco":"...",
"codigo_empresa":"...",
},
]
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:
1. STATUS: Contém informações relativas a requisição. No final do
documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. EMPRESAS: Lista de todos os postos retornados pelo servidor;

3. EMPRESA: Entidade que armazena informações relativas a um


posto;

a. ID: Identificação numérica e única da empresa (inteiro);

b. NOME: Nome da empresa (Alfanumérico);

c. ENDEREÇO: Endereço comercial da empresa (alfanumérico);

d. BAIRRO: Bairro do endereço da empresa (alfanumérico);

e. CIDADE: Cidade do endereço comercial da empresa


(alfanumérico);

f. UF: Sigla da unidade federativa do endereço comercial da


empresa (Alfabético);

g. ATIVO: Indica se o cadastro da empresa está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

h. CNPJ: Valor do Número do cadastro nacional de pessoa jurídica


da empresa (numérico);

i. CONTATO: Nome do contato da empresa (alfanumérico);

j. TELEFONE: Telefone comercial da empresa (numérico);

k. CODIGO_EMPRESA: Código de identificação da empresa


fornecido pelo cliente (alfanumérico);

Tanque
Função:
A interface “Tanque” permite ler registros de tanques de combustível da
base dados do CTAPLus associados ao cliente correspondente ao token de
acesso.

Tipo de requisição:
HTTP GET
URL de acesso:
http://www.ctaplus.com.br:8080/SvWebTanque?token=<token de
acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebTanque” segue
o seguinte formato:

<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<TANQUES>
<TANQUE>
<ID></ID>
<NOME></NOME>
<ATIVO></ATIVO>
<CAPACIDADE></CAPACIDADE>
<OCUPACAO_INICIAL></OCUPACAO_INICIAL>
<CODIGO_TANQUE></CODIGO_TANQUE>
<POSTO_ID></POSTO_ID>
<COMBUSTIVEL></COMBUSTIVEL>
</TANQUE>
...
<TANQUE>
...
</TANQUE>
</TANQUES>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebTanque” segue
o seguinte formato:
{
"tanques":[
{
"ativo":"...",
"combustivel":"...",
"ocupacao_inicial":"...",
"capacidade":"...",
"codigo_tanque":"...",
"nome":"...",
"id":"...",
"codigo_posto":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. TANQUES: Lista de todos os tanques retornados pelo servidor;

3. TANQUE: Entidade que armazena informações relativas a um


tanque;

a. ID: Identificação numérica e única do tanque (inteiro);

b. NOME: Identificação textual do tanque;

c. ATIVO: Indica se o cadastro do tanque está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

d. CAPACIDADE: Contém a máxima capacidade do tanque em


litros (numérico);

e. OCUPACAO_INICIAL: Contém a ocupação inicial do tanque em


litros (numérico);
f. CODIGO_TANQUE: Identificação fornecida pelo cliente para o
tanque (alfanumérico);

g. CODIGO_POSTO: Identificação numérica interna o posto onde


o tanque está instalado (numérico);

h. COMBUSTIVEL: Descrição do combustível armazenado no


tanque (Alfanumérico);

Bomba
Função:
A interface “Bomba” permite ler registros de bombas de abastecimento da
base dados do CTAPLus associados ao cliente correspondente ao token de
acesso.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebBomba?token=<token de
acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebBomba” segue
o seguinte formato:

<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<BOMBAS>
<BOMBA>
<ID></ID>
<NOME></NOME>
<NOME_CURTO></NOME_CURTO>
<ATIVO></ATIVO>
<TANQUE_ID></TANQUE_ID>
<CODIGO_BOMBA></CODIGO_BOMBA>
</BOMBA>
...
<BOMBA>
...
</BOMBA>
</BOMBAS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebBomba” segue
o seguinte formato:

{
"bombas":[
{
"ativo":"...",
"nome_curto":"...",
"codigo_tanque":"...",
"codigo_bomba":"...",
"nome":"...",
"id":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. BOMBAS: Lista de todas as bombas retornadas pelo servidor;


3. BOMBA: Entidade que armazena informações relativas a uma
bomba;

a. ID: Identificação numérica e única da bomba (inteiro);

b. NOME: Descrição textual da bomba;

c. ATIVO: Indica se o cadastro da bomba está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades (Lógico).

d. TANQUE_ID: Identificação numérica interna o tanque onde a


bomba está instalada (numérico);

e. CODIGO_BOMBA: Identificação fornecida pelo cliente para a


bomba (alfanumérico);

Frentista
Função:
A interface “Frentista” permite ler registros dos frentistas autorizados da
base dados do CTAPLus associados ao cliente correspondente ao token de
acesso.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebFrentista?token=<token de
acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebFrentista” segue
o seguinte formato:
<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<FRENTISTAS>
<FRENTISTA>
<ID></ID>
<NOME></NOME>
<CPF></CPF>
<ATIVO></ATIVO>
<NUMERO_RFID></NUMERO_RFID>
<OBSERVACAO></OBSERVACAO>
<TIPO></TIPO>
<CODIGO_FRENTISTA></CODIGO_FRENTISTA>
</FRENTISTA>
...
<FRENTISTA>
...
</FRENTISTA>
</FRENTISTAS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebFrentista”
segue o seguinte formato:

{
"frentistas":[
{
"ativo":"...",
"observacao":"...",
"tipo":"...",
"cpf":"...",
"codigo_frentista":"...",
"nome":"...",
"id":"...",
"numero_rfid":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:
1. STATUS: Contém informações relativas a requisição. No final do
documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. FRENTISTAS: Lista de todos os frentistas retornados pelo servidor;

3. FRENTISTA: Entidade que armazena informações relativas a um


frentista;

a. ID: Identificação numérica e única do frentista (inteiro);

b. NOME: Nome do frentista (alfanumérico);

c. CPF: Número do cadastro nacional de pessoa física do frentista


(numérico)

d. ATIVO: Indica se o cadastro do frentista está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

e. NUMERO_RFID: Contém o número de identificação do cartão


RFID do frentista utilizado para liberar a bomba de
abastecimento (alfanumérico/hexadecimal);

f. OBSERVACAO: Texto livre para observações sobre o frentista


(alfanumérico);

g. TIPO: Contém o tipo de frentista. Pode ser valorado como


FRENTISTA ou AFERIDOR. (Alfabético);

h. CODIGO_FRENTISTA: Identificação fornecida pelo cliente para


o frentista (alfanumérico);

Motorista
Função:
A interface “Motorista” permite ler registros dos motoristas registrados na
base dados do CTAPLus associados ao cliente correspondente ao token de
acesso.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebMotorista?token=<token de
acesso>&formato=<formato de retorno do arquivo>
Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebMotorista”
segue o seguinte formato:

<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<MOTORISTAS>
<MOTORISTA>
<ID></ID>
<NOME></NOME>
<SOBRENOME></SOBRENOME>
<NOME_CURTO></NOME_CURTO>
<ATIVO></ATIVO>
<NUMERO_RFID></NUMERO_RFID>
<CODIGO_MOTORISTA></CODIGO_MOTORISTA>
</MOTORISTA>
...
<MOTORISTA>
...
</MOTORISTA>
</MOTORISTAS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebMotorista”
segue o seguinte formato:

{
"motoristas":[
{
"ativo":"...",
"nome_curto":"...",
"nome":"...",
"id":"...",
"codigo_motorista":"...",
"numero_rfid":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. MOTORISTAS: Lista de todos os motoristas retornados pelo servidor;

3. MOTORISTA: Entidade que armazena informações relativas a um


motorista;

a. ID: Identificação numérica e única do motorista (inteiro);

b. NOME: Nome do frentista (alfanumérico);

c. SOBRENOME: Sobrenome do frentista (alfanumérico)

d. NOME_CURTO: Contém o nome abreviado do motorista


(alfanumérico);

e. ATIVO: Indica se o cadastro do motorista está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

f. NUMERO_RFID: Contém o número de identificação do cartão


RFID do motorista utilizado para liberar a bomba de
abastecimento (alfanumérico/hexadecimal);

g. CODIGO_MOTORISTA: Identificação fornecida pelo cliente


para o motorista (alfanumérico);
Veiculo
Função:
A interface “Veiculo” permite ler registros dos veículos registrados na base
dados do CTAPLus associados ao cliente correspondente ao token de acesso.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebVeiculo?token=<token de
acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em “SvWebVeiculo” segue
o seguinte formato:

<CTAPLUS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
<VEICULOS>
<VEICULO>
<ID></ID>
<ATIVO></ATIVO>
<NOME></NOME>
<NUMERO_RFID></NUMERO_RFID>
<FROTA></FROTA>
<PLACA></PLACA>
<MODELO></MODELO>
<CATEGORIA></CATEGORIA>
<USA_HORIMETRO></USA_HORIMETRO>
<USA_ODOMETRO></USA_ODOMETRO>
<CODIGO_VEICULO></CODIGO_VEICULO>
<EMPRESA_ID></EMPRESA_ID>
</VEICULO>
...
<VEICULO>
...
</VEICULO>
</VEICULOS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebVeiculo” segue
o seguinte formato:

{
"veiculos":[
{
"ativo":"...",
"frota":"...",
"usa_horimetro":"...",
"categoria":"...",
"codigo_empresa":"...",
"codigo_veiculo":"...",
"nome":"...",
"usa_odometro":"...",
"id":"...",
"numero_rfid":"...",
"modelo":"...",
"placa":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. VEICULOS: Lista de todos os veículos retornados pelo servidor;


3. VEICULO: Entidade que armazena informações relativas a um
veículo;

a. ID: Identificação numérica e única do veículo (inteiro);

b. ATIVO: Indica se o cadastro do veículo está ativo ou inativo.


Estar inativo significa que este dado é descartado do
processamento da maioria das funcionalidades do sistema
(Lógico);

c. NOME: Descrição livre do veículo (alfanumérico);

d. NUMERO_RFID: Contém o número de identificação do cartão


RFID do veículo utilizado para liberar a bomba de
abastecimento (alfanumérico/hexadecimal);

e. FROTA: Contém a identificação da frota a qual o veículo


pertence. Valor fornecido pelo cliente (alfanumérico);

f. PLACA: Contém a placa de identificação do veículo


(alfanumérico);

g. CATEGORIA: Contém a descrição da categoria do veículo.


Exemplos: CARRETA, ESCOLAR, URBANO, PASSEIO, etc.
(Alfanumérico)

h. MODELO: Contém a descrição do modelo do veículo


(alfanumérico);

i. USA_HORIMETRO: Determina se o horímetro é lançado no


processo de abastecimento para fins de controle de média de
consumo (Lógico);

j. USA_ODOMETRO: Determina se o odômetro é lançado no


processo de abastecimento para fins de controle média de
consumo (Lógico);

k. CODIGO_VEICULO: Identificação fornecida pelo cliente para o


veículo (alfanumérico);

l. EMPRESA_ID: Identificação numérica da empresa associada


ao veículo.

Informação Adicional
Função:
A interface “InformacaoAdicional” permite ler registros das informações
adicionais dos abastecimentos registrados na base dados do CTAPLus
associados ao cliente correspondente ao token de acesso.

Tipo de requisição:
HTTP GET
URL de acesso:
http://www.ctaplus.com.br:8080/SvWebInformacaoAdicional?token=<token
de acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.

Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em
“SvWebInformacaoAdicional” segue o seguinte formato:

<?xml version="1.0" encoding="UTF-8"?>


<CTAPLUS versao="1.0">
<INFORMACOES_ADICIONAIS>
<INFORMACAO_ADICIONAL>
<ID></ID>
<NOME></NOME>
<ATIVO></ATIVO>
<LIVRE></LIVRE>
<NOME_EQUIPAMENTO></NOME_EQUIPAMENTO>
<NUM_DIGITOS></NUM_DIGITOS>
<OPCIONAL></OPCIONAL>
<CASAS_DECIMAIS></CASAS_DECIMAIS>
<ORDEM></ORDEM>
</INFORMACAO_ADICIONAL>
<INFORMACAO_ADICIONAL>
...
</INFORMACAO_ADICIONAL>
</INFORMACOES_ADICIONAIS>
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
</CTAPLUS>
Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebVeiculo” segue
o seguinte formato:

{
"informacoes_adicionais":[
{
"ativo":"...",
"opcional":"...",
"ordem":"...",
"num_digitos":"...",
"nome":"...",
"casas_decimais":"..",
"id":"...",
"nome_equipamento":"...",
"livre":"..."
},
...
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;

a. CODIGO: Contém o código interno retornado pelo servidor


(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. INFORMACOES_ADICIONAIS: Lista de todas as informações


adicionais retornados pelo servidor;

3. INFORMAÇÃO_ADICIONAL: Entidade que armazena informações


relativas a uma informação adicional;

a. ID: Identificação numérica e única da informação adicional


(inteiro);

b. ATIVO: Indica se o cadastro da informação adicional está ativo


ou inativo. Estar inativo significa que este dado é descartado
do processamento da maioria das funcionalidades do sistema
(Lógico);
c. NOME: Descrição livre da informação adicional (alfanumérico);

d. ORDEM: Indica a ordem da informação adicional no conjunto


de informações adicionais associadas ao cliente (inteiro);

e. NUM_DIGITOS: Contém o número de dígitos que a informação


adicional possui quando representa um dado numérico
(inteiro);

f. CASAS_DECIMAIS: Contém a quantidade de casas decimais


quando a informação adicional representa um valor real
(numérico);

g. LIVRE: Determina se a informação adicional pode ser


preenchida livremente ou se deve seguir uma lista fechada de
valores (Lógico)

h. OPCIONAL: Determina se a informação adicional é de


preenchimento opcional ou obrigatório. (lógico);

Informação Adicional Opção


Função:
A interface “InformacaoAdicionalOpcao” permite ler registros das opções
associadas às informações adicionais não livres dos abastecimentos
registrados na base dados do CTAPLus associados ao cliente correspondente
ao token de acesso.

Tipo de requisição:
HTTP GET

URL de acesso:
http://www.ctaplus.com.br:8080/SvWebInformacaoAdicional?token=<token
de acesso>&formato=<formato de retorno do arquivo>

Parâmetros:
Os seguintes parâmetros podem ser utilizados para selecionar a informação
coletada:

Token de acesso (token):


Parâmetro obrigatório. Corresponde a um identificador único por cliente
fornecido pelos administradores do CTAPLus a seus clientes. Este token
determina de qual cliente as informações serão coletadas. Se não for
informado será retornado um erro;

Formato de retorno do arquivo (formato):


Parâmetro opcional. Corresponde ao formato no qual os dados serão
estruturados no arquivo de retorno. Este valor precisa ser ‘xml’ ou ‘json’,
caso contrário um erro será informado no retorno. Se não for informado, o
formato ‘xml’ será assumido por padrão.
Especificação do arquivo de retorno

Arquivo XML
O arquivo XML de retorno de uma chamada GET em
“SvWebInformacaoAdicional” segue o seguinte formato:

<CTAPLUS versao="1.0">
<INFORMACOES_ADICIONAIS_OPCOES>
<INFORMACAO_ADICIONAL_OPCAO>
<ID></ID>
<NOME></NOME>
<ATIVO></ATIVO>
<VALOR></VALOR>
<NOME_EQUIPAMENTO></NOME_EQUIPAMENTO>

<INFORMACAO_ADICIONAL_ID></INFORMACAO_ADICIONAL_ID>
</INFORMACAO_ADICIONAL_OPCAO>
</INFORMACOES_ADICIONAIS_OPCOES
<STATUS>
<CODIGO></CODIGO>
<MENSAGEM></MENSAGEM>
</STATUS>
</CTAPLUS>

Arquivo JSON
O arquivo JSON de retorno de uma chamada GET em “SvWebVeiculo” segue
o seguinte formato:

{
"informacoes_adicionais_opcoes":[
{
"id":"...",
"informacao_adicional":"...",
"nome_equipamento":"...",
"valor":"...",
"ativo":"..",
"nome":".."
},
{
...
}
],
"status":{
"codigo":"...",
"mensagem":"..."
}
}

Descrição dos campos


As descrições dos campos contidos nas tags XML do arquivo de retorno são:

1. STATUS: Contém informações relativas a requisição. No final do


documento estão descritos todos os valores possíveis;
a. CODIGO: Contém o código interno retornado pelo servidor
(inteiro);

b. MENSAGEM: Contém uma mensagem retornada pelo servidor


correspondente ao código (alfanumérico);

2. INFORMACOES_ADICIONAIS_OPCÕES: Lista de todas as opções


associadas às informações adicionais retornados pelo servidor;

3. INFORMAÇÃO_ADICIONAL_OPCAO: Entidade que armazena


informações relativas a uma opção de informação adicional;

a. ID: Identificação numérica e única da opção de informação


adicional (inteiro);

b. ATIVO: Indica se o cadastro da opção da informação adicional


está ativo ou inativo. Estar inativo significa que este dado é
descartado do processamento da maioria das funcionalidades
do sistema (Lógico);

c. NOME: Descrição livre da opção da informação adicional


(alfanumérico);

d. VALOR : Valor associado a opção (alfanumérico);

e. NOME_EQUIPAMENTO: Contém o nome resumido da opção


para apresentação na tela do equipamento CTAPlus
(Alfanumérico);

f. INFORMACAO_ADICIONAL_ID: Contém id da informação


adicional associada a opção (numérico);

Códigos de Erro

CÓDIGO MENSAGEM
001 Sucesso
002 Erro ao processar a requisição
003 Token não informado
004 Token inválido
005 Data inicial inválida
006 Data final inválida
007 Número máximo de registros inválido
009 Erro ao processar informações
010 XML não informado
011 XML inválido
012 Abastecimento de ID X não existe
013 Status da sincronização X não informado
014 Nenhum abastecimento informado
015 Nenhum carregamento informado
016 Carregamento de ID X não existe
017 Somente uma requisição é aceita por minuto
Hora inicial ou hora final não podem se especificadas sem
018
data correspondente.
019 Hora inicial ou hora final devem estar entre 00:00 e 23:59.
020 Formato de retorno inválido