WS005 - Enviar rotas para Comprovei a partir das chaves dos documentos

Objetivo

Enviar uma rota para a Comprovei. Uma rota é caracterizada por um conjunto de paradas para coleta e/ou entregas e associada a um motorista e um veículo.

Caso as informações do motorista e veículo não sejam enviadas, a rota deve ser liberada manualmente, através do painel web.

As informações que caracterizam uma rota são (campos chave):
  • Nome da rota
  • Data da rota
  • Motorista
  • Placa da veículo principal

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/WebServicePOD/server.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#sendDocsKeysToPOD"
Authorization: Basic {user / pass 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
 Método   sendDocsKeysToPOD
 Endereço de acesso http://soap.comprovei.com.br/WebServicePOD/server.php?wsdl
 Versão atual 1.0 (05/10/2016) - criação do método

Parâmetros de entrada
 Atributo Tipo Descrição
 conteudoArquivo MIME Base64 conteúdo do arquivo {nome_do_arquivo.xml} codificado em MIME Base64    
 nomeArquivo conjunto de caracteres {nome_do_arquivo.xml} para identificação no servidor

Histórico das versões
 Data Responsável Histórico
 10/10/2016 rmiura Criação do método

Parâmetros de saída

 Atributo Tipo Descrição
 status conjunto de caracteres mensagem de retorno informando se o upload e a importação dos dados foram realizados com sucesso.  

Estrutura do arquivo {nome_do_arquivo.xml}

 Atributo Tipo Obrigatório Descrição
+Rotas  sim Indicador de inicio e fim do arquivo .xml
    +Rota  sim Indicador de inicio da estrutura de um rota.  Um único arquivo .xml pode conter várias rotas e elas serão agrupadas na importação.
        Numero     string sim Número ou nome da rota. 
        rotadestino string nao Indicação do destino ou roteiro da rota (limitado a 30 caracteres)
        rotanome  string não Indicação do nome da rota
        Data string sim Data de inicio da operação da rota. Obrigatório o formato YYYYMMDD
        Regiao string não Região da rota
        +Transportadora  não Indicador de inicio da estrutura Transportadora. Uma rota pode conter uma única transportadora
            Codigo string não

 Código da transportadora. Normalmente é o cnpj sem pontos, traços ou barra. Somente números
            Razao string não Nome da transportadora. Pode-se utilizar um nome curto (nome fantasia)
        +Motorista  não Indicador de inicio da estrutura Motorista. Uma rota pode conter um único motorista. Informação não obrigatória, porém se não forem enviados a liberação da rota deverá ser manual
            Usuario string não Código de usuário do motorista no sistema Comprovei
            PlacaVeiculo string não Placa do veículo no formato AAA9999 (sem traço ou espaço)
        +Base   Indicador de inicio da estrutura das bases origem e destino. Essas informações são opcionais e devem ser necessariamente preenchidas nos casos de utilização da roteirização
            +Origem   Indicador de inicio da estrutura da base origem. Uma rota pode ter uma única base origem
                *codigo string não Código da base de origem
                Nome string não Nome da base de origem
                Rua string não Logradouro da base de origem (Rua, Avenida, Praça,etc)
                Numero string não Número
                Complemento string não Complemento do endereço
                Bairro string não Bairro
                Cidade string não Cidade
                Estado string não Estado
                CEP string não CEP (somente números, sem traço ou espaços)
                Pais string não País
            +Destino    Indicador de inicio da estrutura da base destino. Uma rota pode ter uma única base destino
                *codigo string não Código da base de destino
                Nome string não Nome da base destino
                Rua string não Logradouro da base de origem (Rua, Avenida, Praça,etc)
                Numero string não Número
                Complemento string não Complemento do endereço
                Bairro string não Bairro
                Cidade string não Cidade
                Estado string não Estado
                CEP string não CEP (somente números, sem traço ou espaços)
                Pais string não Pais
        +limites
   Indicador de início da estrutura de horários limites de início e término da rota
             inicio string não datahora limite para inicio da rota ***ATENÇÃO **** obrigatório ser no format AAAAMMDD HHMM
             fim string não datahora limite para fim da rota ***ATENÇÃO **** obrigatório ser no format AAAAMMDD HHMM
        +Paradas   Indicador de inicio da estrutura de paradas. Uma rota pode ter várias paradas
            +Parada   Indicador de início da estrutura de uma parada
                *numero string  sim Número da parada
                +Documento   Indicador de inicio da estrutura de um documento. Uma parada por tem um único documento. No caso de entregas com mais de um documento, deve-se criar uma nova parada para cada documento. O sistema identifica vários documentos em um mesmo endereço e realiza a consolidação
                    ChaveNota string sim Chave identificadora do documento fiscal. Em casos de documentos nao fiscais utilizar o proprio numero do documento.
* Campos marcados com asterisco são atributos da TAG.