WS051 - Cancelar documentos

Objetivo

Cancelar um documento. As condições para cancelamento de um documento são:
  1. Documento não pode estar vinculado a nehuma rota (status = disponível)
  2. Não haver histórico de entregas para este documento
Essas 2 condições são obrigatórios para cancelar um documento.

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#sendDocsToPOD"
Authorization: Basic {* user/password 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   cancelDocuments
 Endereço de acesso http://soap.comprovei.com.br/WebServicePOD/server.php?wsdl
 Versão atual 2.2 (30/04/2016)

Histórico das versões
 Data Responsável Histórico
22/10/2015 rmiuraFormalização da versão 2.0
 30/04/2016 rmiura Alteração da url de conexão

Parâmetros de entrada
 Atributo Tipo Descrição
 DocumentKey conjunto de caracteres Chave do documento (Chave da DANFE). Em uma mesma chamada é permitido colocar mais de uma chave, para efetuar o cancelamento em lote. Veja exemplo do xml de entrada abaixo.

Estrutura do arquivo .xml de retorno

 Atributo Tipo Obrigatório Descrição
 Status          stringsimMensagem de retorno da solicitação de cancelamento por documento

Exemplo de arquivo xml de envio
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:cancelDocuments soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <batchOfCancelDocs xsi:type="urn:ArrayOfCancelDocs">
            <!--1 or more repetitions:-->
            <CancelDoc xsi:type="urn:CancelDoc">
               <DocumentKey xsi:type="xsd:string">35141210829506000161550070003173791185742104</DocumentKey>
            </CancelDoc>
         </batchOfCancelDocs>
      </urn:cancelDocuments>
   </soapenv:Body>
</soapenv:Envelope>

Exemplo de arquivo xml de retorno
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:cancelDocumentsResponse xmlns:ns1="urn:WebServiceComprovei">
         <status xsi:type="xsd:string">Document (key: 35141210829506000161550070003173791185742104) cancelled with success.</status>
      </ns1:cancelDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>