Guia técnico para implementação do Rastreamento de …

[Pages:16]Sistema de Rastreamento de Objetos - SRO

Guia t?cnico para implementa??o do Rastreamento de Objetos via WebService / SOAP

Vers?o 1.0 17 de julho de 2014

A comunica??o entre clientes e servidores ? feita atrav?s do SOAP (Simple Object Access Protocol). Esse protocolo ? definido em XML, sendo assim, as chamadas a procedures remotas (RPC) s?o codificadas em XML para transporte das mensagens ? usado o HTTP. Cada consulta ao sistema ? realizada atrav?s dos servi?os SOAP que tem como caracter?stica de funcionamento, uma requisi??o HTTP de POST contendo, dentro de seu payload, chamada envelope SOAP.



Um envelope SOAP nada mais ? que uma estrutura em XML que permite, dentro de seu conte?do, seja enviada informa??es relevantes ao seu servi?o.

Servi?os disponibilizados:

Servi?o

buscaEventos buscaEventosLista

Descri??o

Retorna mensagem XML de retorno do rastro SRO Retorna mensagem XML de retorno do rastro SRO

Conectando o servidor da ECT

Para ter acesso a este servi?o, o cliente dever?: 1. Solicitar junto ? ?rea comercial da ECT a disponibilidade do servi?o; 2. Receber, da ?rea comercial, a autoriza??o para execu??o do aplicativo, juntamente com uma identifica??o de usu?rio e senha de conex?o; 3. Implementar, em seus sistemas, as funcionalidades de conex?o com o servidor SRO. Cada consulta ao servidor SRO dever? informar, obrigatoriamente:

Para os servi?os: buscaEventos, buscaEventosLista, e RastroJson.

Campo usuario senha

tipo

Descri??o

Identifica??o do cliente.

Senha do cliente.

Defini??o de como a lista de identificadores de objetos dever? ser interpretada pelo servidor SRO.

Valores

Informado pela ?rea comercial dos Correios na ativa??o do servi?o. Este campo diferencia letras mai?sculas e min?sculas (case-sensitive).

Informado pela ?rea comercial dos Correios na ativa??o do servi?o. Este campo diferencia letras mai?sculas e min?sculas (case-sensitive).

L: lista de objetos. O servidor far? a consulta individual de cada identificador informado; F: intervalo de objetos. O servidor far? a consulta sequencial do primeiro ao ?ltimo objeto informado,

17 de julho de 2014

1

Sistema de Rastreamento de Objetos - SRO

n?o sendo necess?rio informar os valores intermedi?rios.

resultado lingua

Delimita??o do escopo da resposta a ser dada ? consulta do rastreamento de cada objeto.

Defini??o do idioma que ser? apresentado pelo servidor SRO.

T: ser?o retornados todos os eventos do objeto; U: ser? retornado apenas o ?ltimo evento do objeto.

101: Ser?o retornados todos os eventos no idioma Portugu?s 102: Ser?o retornados todos os eventos no idioma Ingl?s.

objetos

Lista de objetos a pesquisar.

Identificadores listados um ap?s o outro, sem espa?os ou s?mbolo separador. Exemplo: SQ458226057BRRA132678652BR

Abaixo mostra exemplos de envelopes SOAP que s?o estruturas XML que permite enviar informa??es do servi?o desejado dentro de seu conte?do.

buscaEventos:

ECT SRO L T 101 JF598971235BR

buscaEventosLista(M?todo que possibilita a consulta de at? 5.000 objetos):

ECT SRO

17 de julho de 2014

2

L T 101 JF598971235BR JF598971235BR JF598971235BR

Sistema de Rastreamento de Objetos - SRO

Regras de Formata??o de objetos

Abaixo est?o ?s regras para forma??o da lista de objetos a pesquisar:

1. Todos os identificadores objetos dever?o ter o formato padr?o de 13 (treze) posi??es. Sendo duas letras para identifica??o do servi?o, 8 (oito) caracteres num?ricos, 1 (um) d?gito verificador e duas letras finais para identifica??o do pa?s.

2. Estes identificadores s?o informados pelos Correios na postagem da encomenda. Ex: SQ458226057BR

3. N?o poder? haver espa?os em branco, ou outros caracteres separadores, entre um objeto e outro. Exemplo: para a pesquisa de 50 objetos ser? criada uma string de 650 caracteres (13 x 50).

Retorno das informa??es

As informa??es ser?o retornadas numa mensagem XML conforme o padr?o abaixo:

Elemento Pai

versao qtd objeto

Elemento filho

numero sigla nome categoria evento

Elemento filho

tipo status data hora descricao detalhe local codigo cidade uf

Descri??o

Vers?o do SRO XML Quantidade de objetos consultados N?mero do objeto Sigla do objeto solicitado Nome do objeto solicitado Categoria do objeto solicitado Tipo do evento de retorno Status do evento de retorno Data do evento Hora do evento Descri??o do evento Detalhe adicional do evento Local onde ocorreu o evento CEP da unidade ECT Cidade onde ocorreu o evento Unidade da Federa??o

Observa??es:

Os tipos e os status dos eventos s?o descritos no Anexo 1 deste manual, bem como sugest?es de a??es a ser tomadas pelo cliente;

Os dados do recebedor s? ser?o apresentados para os eventos de entrega (tipo=BDE status=01). Pode haver casos em que estes dados n?o existam e, portanto, n?o ser?o exibidos. Para o evento tipo=BDE status=11, poder?, caso exista, ser exibido o campo coment?rio;

17 de julho de 2014

3

Sistema de Rastreamento de Objetos - SRO

Para evitar uma quantidade excessiva de pesquisa, o cliente dever? registrar, no seu banco de dados, todos os objetos que tiveram seu rastreamento conclu?do. Para isso, indicamos que todos os objetos que forem retornados com o evento tipo BDE, BDI e BDR com status 01 est?o com o rastro conclu?do. N?o ser? mais necess?rio envi?-los para novas consultas.

O cliente poder? optar por gravar, na sua base de dados, todo o retorno relativo ao objeto rastreado e/ou apenas alguns dos eventos. Por exemplo: somente a entrega.

Abaixo est? um exemplo de uma mensagem XML de retorno:

2.0 1 JF598971235BR JF REMESSA ECON?MICA C/AR DIGITAL REMESSA ECON?MICA TAL?O/CART?O BDE 23 18/03/2014 18:37 Objeto devolvido ao remetente CTCE MACEIO 57060971 MACEIO AL

Anexo I Lista de status de eventos

A maior parte dos eventos ? informativa e n?o necessita de a??es espec?ficas por parte do cliente. Os eventos relacionados ? etapa final da entrega s?o os mais relevantes e s?o destacados na lista completa de eventos abaixo. A ?ltima coluna sugere o que apresentar ao usu?rio do site, seja ele destinat?rio ou remetente. Estas mensagens s?o compat?veis com as informa??es exibidas no rastreamento de objetos no site dos Correios.

Tipos

BDE BDI BDR

BDE

Status 0

1

Descri??o Objeto entregue ao destinat?rio

Objeto entregue ao

17 de julho de 2014

Detalhe Recebido por:

Recebido por:

O que o cliente deve fazer Finalizar a entrega. N?o ? mais necess?rio prosseguir com o acompanhamento. Finalizar a entrega. N?o ?

4

Sistema de Rastreamento de Objetos - SRO

Tipos

BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE

Status 2 3 4 5 6 7 8 9

10 12 19 20 21 22 23 24 25

Descri??o destinat?rio

Detalhe

A entrega n?o pode ser efetuada - Carteiro n?o atendido

Remetente n?o retirou objeto na Unidade dos Correios

Aguarde! Objeto estar? dispon?vel para retirada na unidade a ser informada.

Objeto em an?lise de destina??o

A entrega n?o pode ser efetuada - Cliente recusouse a receber

A entrega n?o pode ser efetuada

Objeto ser? devolvido ao remetente

Objeto ser? devolvido ao remetente

O que o cliente deve fazer

mais necess?rio prosseguir com o acompanhamento.

Acompanhar. O interessado dever? buscar o objeto em uma Unidade dos Correios.

Acompanhar. O interessado n?o buscou o objeto na unidade dos Correios durante o per?odo de guarda.

Acompanhar o retorno do objeto ao remetente.

Acompanhar o retorno do objeto ao remetente.

A entrega n?o pode ser efetuada - Cliente desconhecido no local A entrega n?o pode ser efetuada - Endere?o incorreto A entrega n?o pode ser efetuada - Endere?o incorreto Objeto n?o localizado

A entrega n?o pode ser efetuada - Cliente mudou-se

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

Objeto sujeito a atraso na entrega ou a devolu??o ao remetente

Objeto ser? devolvido ao remetente

Acompanhar

Acompanhar o retorno do objeto ao remetente.

F avor entrar em contato com os Correios.

Objeto ser? devolvido ao remetente

Acionar atendimento dos Correios.

Acompanhar o retorno do objeto ao remetente.

Remetente n?o retirou objeto na Unidade dos Correios

A entrega n?o pode ser efetuada - Endere?o incorreto

A entrega n?o pode ser efetuada - Carteiro n?o atendido

A entrega n?o pode ser efetuada - Carteiro n?o atendido

Objeto devolvido aos Correios

Objeto em an?lise de destina??o

Acionar atendimento dos Correios.

Objeto sujeito a atraso na entrega ou a devolu??o ao remetente

Ser? realizada nova tentativa de entrega

Acompanhar o retorno do objeto ao remetente.

Acompanhar

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

Acompanhar

Objeto devolvido ao remetente

Recebido por:

Acompanhar

Objeto dispon?vel para retirada em Caixa Postal

Acompanhar

A entrega n?o pode ser

A entrega dever? ocorrer no Acompanhar

17 de julho de 2014

5

Sistema de Rastreamento de Objetos - SRO

Tipos BDI BDR BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE

Status 26 28

32 33 34 35 36 37

38 40 41 42 43

45 46

Descri??o efetuada - Empresa sem expediente Destinat?rio n?o retirou objeto na Unidade dos Correios Objeto e/ou conte?do avariado

Objeto com data de entrega agendada

Detalhe pr?ximo dia ?til

O que o cliente deve fazer

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

F avor entrar em contato com os Correios.

Acionar atendimento dos Correios.

Acompanhar

A entrega n?o pode ser efetuada - Destinat?rio n?o apresentou documento exigido

A entrega n?o pode ser efetuada - Logradouro com numera??o irregular

Coleta ou entrega de objeto n?o efetuada

Objeto ser? devolvido ao remetente

Objeto sujeito a atraso na entrega ou a devolu??o ao remetente Ser? realizada nova tentativa de coleta ou entrega

Acompanhar o retorno do objeto ao remetente.

Acompanhar

Acompanhar

Coleta ou entrega de objeto Objeto ser? devolvido ao

n?o efetuada

remetente

Acompanhar o retorno do objeto ao remetente.

Objeto e/ou conte?do avariado por acidente com ve?culo

Objeto endere?ado ? empresa falida

A importa??o do objeto/conte?do n?o foi autorizada pelos ?rg?os fiscalizadores A entrega do objeto est? condicionada ? composi??o do lote Lote de objetos incompleto

F avor entrar em contato com os Correios.

Objeto ser? encaminhado para entrega ao administrador judicial

Objeto ser? devolvido ao remetente

Acionar atendimento dos Correios.

Acompanhar

Acompanhar o retorno do objeto ao remetente.

Acompanhar

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

Objeto apreendido por ?rg?o de fiscaliza??o ou outro ?rg?o anuente

Objeto recebido na unidade de distribui??o

F avor entrar em contato com os Correios.

Entrega prevista para o pr?ximo dia ?til

Acionar atendimento dos Correios.

Acompanhar

Tentativa de entrega n?o

Entrega prevista para o

Acompanhar

17 de julho de 2014

6

Sistema de Rastreamento de Objetos - SRO

Tipos BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR

BDE BDI BDR

BDE BDI BDR

BDE BDI BDR BDE BDI BDR

BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI BDR BDE BDI

Status 47 48 49 50

51

52

53 54 55 56 57 58 59 66 69

Descri??o efetuada

Detalhe pr?ximo dia ?til

O que o cliente deve fazer

Sa?da para entrega cancelada

Ser? efetuado novo lan?amento para entrega

Acompanhar

Retirada em Unidade dos Correios n?o autorizada pelo remetente As dimens?es do objeto impossibilitam o tratamento e a entrega Objeto roubado

Objeto roubado

Objeto roubado

Objeto reimpresso e reenviado

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

F avor entrar em contato com os Correios.

F avor entrar em contato com os Correios.

F avor entrar em contato com os Correios.

Acionar atendimento dos Correios.

Acionar atendimento dos Correios.

Acionar atendimento dos Correios.

Acompanhar

Para recebimento do objeto, ? necess?rio o pagamento do ICMS Importa??o

Solicitada revis?o do tributo estabelecido

Acompanhar. O interessado dever? pagar o imposto devido para retirar o objeto em uma Unidade dos Correios.

Acompanhar

Declara??o aduaneira ausente ou incorreta

Objeto ser? devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

Revis?o de tributo conclu?da - Objeto liberado

Acompanhar

Revis?o de tributo conclu?da O valor do tributo pode ter

- Tributo alterado

aumentado ou diminu?do

Acompanhar

Revis?o de tributo conclu?da Poder? haver incid?ncia de

- Tributo mantido

juros e multa.

Acompanhar

?rea com distribui??o

Restri??o de entrega

sujeita a prazo diferenciado domiciliar tempor?ria

Acompanhar

Objeto com atraso na entrega

Acompanhar

17 de julho de 2014

7

Sistema de Rastreamento de Objetos - SRO

Tipos BDR BLQ

CD CD CD CD CMT CO CUN CUN DO DO DO EST EST EST EST EST EST EST FC FC FC FC

FC FC

Status

1

0 1 2 3 0 1 0 1 0 1 2 1 2 3 4 5 6 9 1 2 3 4

5 7

Descri??o

Detalhe

Entrega de objeto bloqueada a pedido do remetente

Objeto recebido na Unidade dos Correios

Objeto recebido na Unidade dos Correios

Objeto recebido na Unidade dos Correios

Objeto recebido na Unidade dos Correios

Objeto recebido na Unidade dos Correios

Objeto coletado

Objeto recebido na Unidade dos Correios

Objeto recebido na Unidade dos Correios

Objeto encaminhado para

Objeto encaminhado para

Objeto encaminhado para

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Favor desconsiderar a informa??o anterior

Objeto ser? devolvido por solicita??o do remetente

Objeto com data de entrega agendada

Objeto mal encaminhado

A entrega n?o pode ser efetuada - Endere?o incorreto

Objeto devolvido aos Correios

A entrega n?o pode ser efetuada - Empresa sem expediente

Objeto em an?lise de destina??o

Encaminhamento a ser corrigido. Objeto sujeito a atraso na entrega ou a devolu??o ao remetente A entrega dever? ocorrer no pr?ximo dia ?til

O que o cliente deve fazer

Acompanhar

Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar Acompanhar o retorno do objeto ao remetente. Acompanhar Acompanhar Acompanhar

Acompanhar Acompanhar

17 de julho de 2014

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download