appaweb descriÇÃo da interface de … (41) 3420-1100 4.1. descrição o que: webservice para...
TRANSCRIPT
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
APPAWEB
DESCRIÇÃO DA INTERFACE DE
CONCLUSÃO DA OPERAÇÃO NO PONTO
DE DESTINO
Versão 2.3
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
Histórico da Revisão
Data Versão Descrição Autor
[Categoria] 1.0 Versão Original Fabrício R.
Ferreira/OPENPORT
10/09/2015 1.1 Inclusão da obrigatoriedade dos campos xml Fabricio R.
Ferreira/OPENPORT
30/09/2015 1.2 Corrigindo a descrição dos campos no xml. Fabricio R.
Ferreira/OPENPORT
16/10/2015 2.0 Inclusão das informações do ambiente de
homologação
Fabricio R.
Ferreira/OPENPORT
27/10/2015 2.1 Informando a tecnologia do webservice; incluindo o
capítulo Outras informações importantes
Fabricio R.
Ferreira/OPENPORT
05/11/2015 2.2 Inclusão do webservice de saída da faixa Fabricio R.
Ferreira/OPENPORT
07/12/2015 2.3 Inclusão do endereço de produção Fabricio R.
Ferreira/OPENPORT
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
1. INTRODUÇÃO
Este documento tem como objetivo especificar as interfaces que serão disponibilizadas para os atores que precisarão informar ao APPAWEB a conclusão da operação de descarga direta constado nos armazéns de destino, conforme descrito na portaria 318-15 emitida em 20 de agosto de 2015.
O sistema APPA WEB disponibilizará dois modelos de integração para que todos os armazéns de destino possam realizar a integração dos dados do veículo e da carga, fechando o clico da viagem de descarga direta costado que teve início quando o veículo entrou na faixa portuária. Os modelos de integração são: Tela do Sistema, WebService.
2. TELAS DO SISTEMA: CADASTRO DA CONCLUSÃO DA VIAGEM
2.1. Descrição
O que: Tela para informar os dados do veículo e da carga no armazém de destino
Por quem: Operador portuário ou qualquer responsável pela carga
Porque: A partir dessa informação toda a carga será monitorada, bem como o tempo entre a origem e o destino, tais informações serão levadas em consideração no planejamento de descarga do navio
Onde: No Sistema APPAWEB (on-line) número e nome da tela ainda a definir
Como: Usuário devidamente habilitado, digitará na tela as informações do veículo e da carga.
Quando: Sempre que um veículo chegar ao armazém de destino com uma carga de descarga direta costado
Pré-Condições:
- Usuário deve estar cadastrado no sistema APPAWEB; - Ter usuário e senha do sistema APPAWEB;
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
2.2. Modelo da Tela
CAMPO DESCRIÇÃO
SEV Número da SEV do veículo em questão
Peso do veículo Peso do veículo na balança do armazém de retaguarda/destino
Veículo (Leitura) Placa do veículo associado a SEV
Armazém de Retaguarda
Código do armazém que está recebendo a carga
Data de pesagem Data e hora em que o veículo chegou ao armazém e realizou a pesagem
Ticket da pesagem Número do ticket gerado pela balança de entrada do armazém de retaguarda, caso exista.
ID Viagem APPAWEB Lista de viagens que estão destinadas ao armazém de retaguarda e que estão pendentes de informar a conclusão (sem informação de conclusão de viagem)
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
2.3. Regras da Tela As seguintes regras estão implementadas no cadastro da chegada via tela:
REGRA DESCRIÇÃO
RN.1 Valida se a viagem informada é válida
RN.2 Valida se a viagem informada tem como destino o Armazém informado
RN.3 Valida se a pesagem é coerente com a pesagem de saída da Faixa Portuária
RN.4 Permite alterar informação enviada pelo WebService
RN.5 Usuário só poderá informar dados do Armazém de retaguarda que ele estiver associado
2.4. Observações
a) Caso seja necessário por motivo de força maior registrar a chegada de
uma viagem em um local diferente do definido no Lote e impresso no
ticket, o usuário poderá na tela informar qual o novo armazém de destino
no campo Armazém de retaguarda, o sistema abrirá uma tela para que o
usuário justifique a alteração do armazém de destino.
b) O usuário poderá na tela alterar uma informação registrada pelo
webservice, porém será necessário informar na tela de justificativa o
motivo da alteração.
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
3. FLUXO DO PROCESSO DE WEBSERVICE
WebService
WebService
Inicio
Portão G3
Vinculo Conferete
Saída da Faixa
Dados da saída
Entrada na faixa
Appaweb
Comunica
BI CeleparTOLEDO
Comunica
Armazém retaguarda
Ws:ObterListaSaidaVeiculoFaixaArmazemReguarda()
Receber o veículo
Realizar pesagemWs:RegistrarChegadaViagem()
FIM
Cadastro SEV
TELA
4. WEBSERVICE – SAÍDA DA FAIXA PORTUÁRIA
Para obter os dados inicial da viagem que serão necessários para informar
na conclusão do veículo ao chegar no armazém de retaguarda, a APPA
disponibilizou um webservice nos padrões SOAP e RESTFUL que retorna
quais veículos deixaram a faixa portuária em um período especifico. Abaixo
segue o detalhamento do webservice
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
4.1. Descrição
O que: Webservice para listar quais veículos deixaram a faixa portuário em período de tempo especifico
Por quem: Sistema INFORGER da CELEPAR
Por quê: Para que os armazéns de retaguarda obtenham as informações sobre a viagem que saiu da faixa portuária com destino ao armazém de retaguarda especifico
Onde: No webservice disponibilizado no endereço “” método “”
Como:
Deverá ser solicitado o cadastramento do armazém de retaguarda no sistema APPAWEB, com o objetivo de obter as informações do webservice, após o cadastramento será informado a chave de acesso ao webservice.
Quando: O webservice deverá ser consumido sempre que houver a necessidade de ter as informações da viagem para ser informado no APPAWEB a conclusão das viagens.
Pré-Condições:
-Estar cadastrado no sistema APPAWEB - Ser um armazém de retaguarda. -O período entre a data inicial e a data final dos veículos que deixaram a faixa, é de no máximo de 7 dias.
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
4.2. Modelo do XML de Requisição dos Dados
IDENTIFICAÇÃO 001 obterListaSaidasVeiculosFaixaArmazemRetaguardaPorPeriodo
TIPO Ciclo Sempre que o veículo deixar a faixa portuária
DADOS
ID Nome Descrição Tamanho Tipo Formato
1 cnpjEmpresaResponsavel Refere-se ao número do CNPJ da empresa responsável pela carga,
14 Caracteres - Obrigatório
2 cpfSolicitanteCadastrado Numéricos, referente ao número do CPF cadastrado e vinculado à empresa responsável pela carga
11 Caracteres - Obrigatório
3 placaVeiculoPrincipal Placa de identificação do veículo, referente a identificação do veículo principal
07 Caracteres
Cccnnnn “c” representa os caracteres
alfabéticos e “n” representa os caracteres numéricos
Opcional
4 chaveAcesso Referente a chave de acesso ao serviço informada pela APPA;
32 Caracteres - Obrigatório
5 dataInicial Obrigatório para os métodos de busca por
período - Data
'yyyy-MM-dd' ou 'yyyy-MM-dd HH:mm'
Obrigatório
6 dataFinal Obrigatório para os métodos de busca por
período - Data
'yyyy-MM-dd' ou 'yyyy-MM-dd HH:mm'
Obrigatório
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
4.3. Acesso Para consumir o webservice para obter as informações das viagens que deixaram a
faixa portuária informações se fazem necessárias:
Endereço do Webservice
a) Homologação:
http://homolog.infoger.appa.pr.gov.br/appa-
ade02/rest/saidaVeiculosFaixa/obterListaSaidasVeiculosFaixaArmazemRetagu
arda
b) Produção:
i. Dados da Última Hora http://www.infoger.appa.pr.gov.br/appa-ade02/rest/saidaVeiculosFaixa/obterListaSaidasVeiculosFaixaArmazemRetaguarda?chave=&cnpj=&cpf=
ii. Pesquisa por Período http://www.infoger.appa.pr.gov.br/appa-ade02/rest/saidaVeiculosFaixa/obterListaSaidasVeiculosFaixaArmazemRetaguardaPorPeriodo?chave=&cnpj=&cpf=&dataInicial=&dataFinal=
Nome do Método
a) RESTFUL: obterListaSaidasVeiculosFaixaArmazemRetaguarda
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
4.4. Modelo do XML Retorno
Quando houver algum dado resultante da consulta aos serviços de Webservice de SAÍDA da faixa, será retornado um array de um
tipo complexo que conterá os seguintes dados:
DADOS
ID Nome Descrição Tam Tipo Formato
1 codigoBarrasAutorizacao Referente ao número da viagem no Appaweb
- Inteiro -
2 placaIdentificacaoVeiculo Placa de identificação do veículo, referente a placa do veículo principal;
- Caracteres cccnnnn “c” referentes ao prefixo da placa;“n” representa os caracteres numéricos
3 placaIdentificacaoCarreta01 Placa de identificação do veículo, referente a placa da primeira carreta;
- Caracteres cccnnnn “c” referentes ao prefixo da placa;“n” representa os caracteres numéricos
4 placaIdentificacaoCarreta02 Placa de identificação do veículo, referente a placa da segunda carreta;
- Caracteres cccnnnn “c” referentes ao prefixo da placa;“n” representa os caracteres numéricos
5 nomeCondutor Nome do condutor; 100 Caracteres -
6 cpfCondutor Número do documento CPF do condutor; 11 Caracteres -
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
7 nomeNavio Nome do navio vinculado à programação do navio;
30 Caracteres -
8 numeroProgramacaoNavio Número da programação do navio; - inteiro -
9 cnpjOperador CNPJ do operador do navio; 14 Caracteres -
10 nomeOperador Nome do operador do navio; 100 Caracteres -
11 codigoProduto Código do produto da carga (código ncm do produto, conforme tabela da ANTAQ);
8 Caracteres -
12 nomeProduto Nome do produto da carga, Conforme tabela da ANTAQ;
30 Caracteres -
13 dataEntrada Data/hora da entrada do veículo; - Data e hora -
14 dataSaida Data/hora da saída do veículo; - Data e hora -
15 pesoEntrada Peso do veículo registrado na balança de entrada; - Inteiro -
16 pesoSaida Peso do veículo registrado na balança de saída; - Inteiro -
17 cnpjImportador CNPJ do importador; 14 Caracteres -
18 nomeImportador Tipo texto, contendo até 100 caracteres alfa-numéricos, referente ao nome do importador;
100 Caracteres -
19 numeroLote Número do lote da carga; - Inteiro -
20 anoDocumento Ano de emissão do documento da carga; - Inteiro -
21 numeroDocumento Número de identificação do documento da carga; 15 Caracteres -
22 tipoDocumento Tipo do documento da carga, podendo ser “BL” ou “DI”;
2 Caracteres -
23 cnpjArmazemRetaguarda CNPJ da empresa de destino de um lote; 14 Caracteres -
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
24 nomeArmazemRetaguarda Nome da empresa de destino de um lote; 100 Caracteres -
25 cargaEstaZerada Indicação de uma carga de valor 0 (zero); - Logico Verdadeiro/Falso
26 terno Terno da carga; 3 Caracteres -
27 porao Porão da carga; 3 Caracteres -
28 cnpjArmazemFaixa CNPJ do armazém dentro da faixa portuária; 14 Caracteres -
29 nomeArmazemFaixa Nome do armazém dentro da faixa portuária 100 Caracteres -
30 cnpjTransportador CNPJ do armazém dentro da faixa portuária; 14 Caracteres -
31 nomeTransportador Nome do armazém dentro da faixa portuária. 100 Caracteres -
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
<saidaVeiculo> <anoDocumento>2013</anoDocumento> <cargaEstaZerada>false</cargaEstaZerada> <cnpjArmazemRetaguarda>11111111000111</cnpjArmazemRetaguarda> <cnpjImportador>22222222000122</cnpjImportador> <cnpjOperador>33333333000133</cnpjOperador> <codigoBarrasAutorizacao>65127226099491</codigoBarrasAutorizacao> <codigoProduto>4654</codigoProduto> <cpfCondutor>12345678912</cpfCondutor> <dataEntrada>2013-08-10T15:57:41.590-03:00</dataEntrada> <dataSaida>2013-08-10T19:06:53.513-03:00</dataSaida> <nomeArmazemRetaguarda>Armazem Retaguarda</nomeArmazemRetaguarda> <nomeCondutor>Condutor A</nomeCondutor> <nomeImportador>Importador B</nomeImportador> <nomeNavio>Navio C</nomeNavio> <nomeOperador>Operador D</nomeOperador> <nomeProduto>NITRATO DE POTASSIO</nomeProduto> <numeroDocumento>999999</numeroDocumento> <numeroLote>12</numeroLote> <numeroProgramacaoNavio>9977755</numeroProgramacaoNavio> <pesoEntrada>19440</pesoEntrada> <pesoSaida>50220</pesoSaida> <placaIdentificacaoCarreta01>AAA1234</placaIdentificacaoCarreta01> <placaIdentificacaoCarreta02>BBB1234</placaIdentificacaoCarreta02> <placaIdentificacaoVeiculo>CCC1234</placaIdentificacaoVeiculo> <tipoDocumento>DI</tipoDocumento> </saidaVeiculo> <saidaVeiculo> <anoDocumento>2013</anoDocumento> <cargaEstaZerada>false</cargaEstaZerada> <cnpjArmazemRetaguarda>11111111000111</cnpjArmazemRetaguarda> <cnpjImportador>22222222000122</cnpjImportador> <cnpjOperador>33333333000133</cnpjOperador> <codigoBarrasAutorizacao>75127226099491</codigoBarrasAutorizacao> <codigoProduto>4654</codigoProduto> <cpfCondutor>12345678912</cpfCondutor> <dataEntrada>2013-08-11T05:57:41.590-03:00</dataEntrada> <dataSaida>2013-08-11T07:06:53.513-03:00</dataSaida> <nomeArmazemRetaguarda>Armazem Retaguarda</nomeArmazemRetaguarda> <nomeCondutor>Condutor A</nomeCondutor> <nomeImportador>Importador B</nomeImportador> <nomeNavio>Navio C</nomeNavio> <nomeOperador>Operador D</nomeOperador> <nomeProduto>NITRATO DE POTASSIO</nomeProduto> <numeroDocumento>999999</numeroDocumento> <numeroLote>12</numeroLote> <numeroProgramacaoNavio>9977755</numeroProgramacaoNavio> <pesoEntrada>19520</pesoEntrada>
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
<pesoSaida>50100</pesoSaida> <placaIdentificacaoCarreta01>AAA1234</placaIdentificacaoCarreta01> <placaIdentificacaoCarreta02>BBB1234</placaIdentificacaoCarreta02> <placaIdentificacaoVeiculo>CCC1234</placaIdentificacaoVeiculo> <tipoDocumento>DI</tipoDocumento> </saidaVeiculo>
</saidasVeiculosFaixaDTOes>
Em caso de erro será retornado um objeto do tipo RetornoWS:
Campo Formato Descrição
retorno boolean Retorno do serviço (FALSE)
mensagem char() Mensagem retornada pelo serviço.
Exemplo:
<retornoWS>
<mensagem>Falha na autenticação [00]</mensagem>
<retorno>false</retorno>
</retornoWS>
Ou para erros na passagem de parâmetros:
<retornoWS>
<mensagem>Parâmetros inválidos [13]</mensagem>
<retorno>false</retorno>
</retornoWS>
4.5. Exemplo de Chamada
http://homolog.infoger.appa.pr.gov.br/appa-
ade02/rest/saidaVeiculosFaixa/obterListaSaidaVeiculosFaixaOperadorPortuari
o?chave=xxxxxxxxxxxxxxxxxxxx&cnpj=12345678000123&cpf=12345678901&p
laca=AAA1234&dataInicial=2013-08-01&dataFinal=2013-08-05
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
5. WEBSERVICE – CONCLUSÃO DA VIAGEM
5.1. Descrição
O que: Webservice para receber a informação do veículo e da carga no armazém de retaguarda
Por quem: Sistema do Armazém de retaguarda
Por quê: A partir dessa informação toda a carga será monitorada, bem como o tempo entre a origem e o destino, tais informações serão levadas em consideração no planejamento de descarga do navio
Onde: No Sistema APPAWEB (on-line) via webservice na tecnologia RESTFUL, e nos endereços de homologação e produção informados abaixo.
Como: O sistema de do armazém será cadastrado e será gerado uma chave de acesso, a partir desse momento o sistema estará apto a consumir o webservice (RESTFUL-PUT) passando o xml conforme modelo.
Quando: Sempre que um veículo chegar ao armazém de retaguarda com uma carga de descarga direta costado e realizar a pesagem
Pré-Condições:
- Sistema devidamente cadastrado e habilidade para consumir o webservice - Conhecer a tecnologia RESTFUL para webservice;
5.2. Modelo do XML
XML-Portaria
318.xml
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
Campos IDENTIFICAÇÃO 001 INTEGRAÇÃO Conclusão Viagem
TIPO Ciclo Sempre que o veículo chegar ao armazém de retaguarda
DADOS
ID Nome Descrição Tam Tipo Formato U.E.
1 SEV Número da SEV do veículo está atualizando momento da chegada no armazém
18 Inteiro - - Opcional
2 pesoChegada Peso do veículo na balança de chegada do armazém de retaguarda/destino (kg)
10 Inteiro - - Obrigatório
3 Placa Placa do veículo que está sendo pesado (esse campo será validado com a SEV)
16 Caracteres - - Obrigatório
4 codigoArmazem CNPJ do armazém de retaguarda. 14 Caracteres - - Obrigatório
5 datachegada Data e hora da pesagem no armazém de retaguarda - Data YYYY-MM-
DDTHH:mm:ss - Obrigatório
6 ticketPesagem Código do ticket na pesagem do armazém de retaguarda, caso exista.
20 Caracteres - - Opcional
7 idViagemAppaWeb Número da viagem informada pelo Appaweb para emissão da nota fiscal. Campo único informado pelo Appaweb
18 Inteiro - - Obrigatório
8 nrNotaFiscal Número da nota fiscal referente a viagem em questão 20 Caracteres - - Opcional
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
5.3. Modelo do XML Retorno
O seguinte xml será o retorno ao processamento do xml enviado para o
APPAWEB
DADOS
ID Nome Descrição Tam Tipo Formato U.E.
1 Retorno
Campo informando se o processamento foi feito com sucesso (true) ou ocorreu algum erro no processamento (false)
- Boolean - - Obrigatório
2 Msg Mensagem de erro caso o processamento não tenha ocorrido com sucesso
200 String - - Obrigatório
5.4. Regra do Webservice
As seguintes regras estão implementadas no Webservice:
REGRA DESCRIÇÃO
RN.1 Valida se a viagem informada é válida
RN.2 Valida se a viagem informada tem como destino o Armazém informado
RN.3 Valida se a chave de identificação é válida
RN.4 Valida se a chave de identificação pertence a empresa informada no campo código do Armazém
RN.5 Valida se o destino da viagem é o mesmo que está sendo informado no campo código do Armazém
RN.6 Não é permitido atualização de registro já enviado
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
6. ACESSOS
6.1. Webservice
Para consumir o Webservice repassando as informações conforme descrito
anteriormente, as seguintes informações se fazem necessárias:
Endereço do Webservice
a) Homologação:
http://www.homologacao.appaweb.appa.pr.gov.br/appawebservices/api
/ControleAcesso/RegistrarChegadaViagem/
b) Produção:
http://www.appaweb.appa.pr.gov.br/appawebservices/api/controleacesso/RegistrarChegadaViagem
Chave de Acesso
Chave padrão para os armazéns:
a) Homologação:
CC32EC58-A423-491E-A25F-CAFF2DB74D8D
b) Produção:
A empresa deverá solicitar através de pedido protocolado junto à APPA,
contendo uma folha de rosto com a solicitação e o ANEXO I da Portaria
155/15 devidamente preenchido. Após protocolado, será enviada a chave
para o e-mail informado.
E S T A D O D O P A R A N Á
SECRETARIA DE INFRAESTRUTURA E
LOGÍSTICA
Administração dos Portos de Paranaguá e Antonina
DEINFO – DEPARTAMENTO DE INFORMÁTICA E ORGANIZAÇÃO
Av. Ayrton Senna da Silva, 161 – Dom Pedro II – CEP- 83.203-800 Paranaguá/PR
Tel: (41) 3420-1100
6.2. Tela
Para acessar a tela para cadastramento das informações conforme descrito
anteriormente, as seguintes informações se fazem necessárias:
o Número da tela: 9002
o Caminho da tela no menu: menu\Controle de
Acesso\Operacionais\Armazéns de retaguarda
7. OUTRAS INFORMAÇOES IMPORTANTES
a) A tecnologia utilizada para o WS RegistrarChegadaViagem é RESTFUL,
nesta tecnologia não é gerado WSDL, as informações devem ser enviadas
pelo método PUT conforme boas práticas da tecnologia;
b) O conteúdo do campo idViagemAppaWeb, deve ser obtido através do
Webservice:
obterListaSaidasVeiculosFaixaArmazemRetaguardaPorPeriodo campo
codigo, que já é conhecido de todos;
c) O campo SEV pode ser enviado em branco, caso o armazém não tenha a
informação;
d) Deve ser informado ao e-mail [email protected], quais usuários farão
a digitação dos dados na tela, para que seja providenciado o acesso ao
sistema;
e) Os dados que devem ser informados no webservice
RegistrarChegadaViagem, não são os mesmos impressos no ticket de saída
da balança, mas sim as informações disponibilizadas no webservice
obterListaSaidasVeiculosFaixaArmazemRetaguardaPorPeriodo utilizado
para gerar a nota fiscal;
f) O campo nrNotaFiscal deve ser preenchido com o número da nota fiscal em
alguns casos a nota fiscal é gerado pela MIC.