Objetivo

Método para cancelar uma Operação de Transporte. Uma Operação de Transporte só pode ser cancelada quando a mesma estiver com o status: Declarada.

Observação

Cancelamento de um cadastro de Operação de Transporte: o cadastro da Operação de Transporte poderá ser cancelado até a data estipulada para o término da viagem acrescida de uma margem de 20% do tempo decorrido, desde que não tenha sido consultado pela fiscalização da ANTT.
Não é possível realizar rajadas para esse método, a TARGET limita 50 requisições por minuto, aconselhamos requisições por demanda, caso o limite de 50 requisições seja ultrapassado, iremos bloquear as requisições apenas para o método que ultrapassou o limite durante 5 minutos.

Observação

Casos de Uso:

Compra de Vale-Pedágio Cartão dentro de uma Operação de Transporte (Compra não foi carregada no cartão)
1. Cancelamos a compra automaticamente ao invocarem o método – ‘CancelarOperacaoTransporte’.
Compra de Vale-Pedágio Cartão dentro de uma Operação de Transporte (A compra foi carregada no cartão)
1. Cancelaremos a “compra” ao invocarem o método – ‘CancelarOperacaoTransporte’.
  1. Entendam que a compra só poderá ser cancelada na ANTT. Não podemos alterar o status de uma compra para cancelada, onde o cartão da mesma já tenha sido carregado.
  2. Não se preocupem, a Ciapetro já sabe o processo de estorno com a TARGET (Backoffice Bradeco).
Compra de Vale-Pedágio TAG dentro de uma Operação de Transporte (A TAG não foi carregada)
1. Cancelamos a compra automaticamente ao invocarem o método – ‘CancelarOperacaoTransporte’.
Compra de Vale-Pedágio TAG dentro de uma Operação de Transporte (A compra foi confirmada e a TAG foi carregada)
1. Iremos fazer com que a compra de Vale-Pedágio TAG que já foi carregada, seja cancelada ao invocarem o método – ‘CancelarOperacaoTransporte’.
2. Obs. Importante: Lembrando que a compra talvez não seja cancelada por dois motivos (Validações da própria API do Sem Parar)
  1. A compra foi realizada há mais de 3h.
  2. O veículo já passo pela primeira praça de pedágio.
    1. Mesmo que a compra tenha ocorrido no período inferior ao prazo de 3h.

Request

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CancelarOperacaoTransporteRequest
1	IdOperacao	int	Sim	Id da Operação de Transporte.	N/A
2	MotivoCancelamento	string	Sim	Motivo do cancelamento da Operação de Transporte.	N/A

Response

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
CancelarOperacaoTransporteResponse
1	Erro	ErroResponse - string	Não	Retorna o Erro.	NULO em caso de sucesso.
2	IdCancelamentoOperacaoTransporte	int	Sim	Retorna o ID do Cancelamento da Operação de Transporte.	N/A
3	DataCancelamento	Datetime(YYYY-MM-DD)	Sim	Retorna a Data de Cancelamento da Operação de Transporte.	Exemplo: (2018-08-20T10:05:33)
4	ProtocoloCancelamento	string	Sim	Retorna o Protocolo de cancelamento da Operação de Transporte.	N/A
5	DadosCompraValePedagioRelacionadas	List<DadosCompraValePedagioPosCancelamento>	Não	Retorna um Objeto referente a uma compra de Vale-Pedágio Cartão que está associada a Operação de Transporte que foi buscada.	N/A
6	DadosCompraValePedagioViaFacilRelacionadas	List<DadosCompraValePedagioViaFacilPosCancelamento>	Não	Retorna um Objeto referente a uma compra de Vale-Pedágio Via Fácil que está associada a Operação de Transporte que foi buscada.	N/A

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosCompraValePedagioPosCancelamento
1	IdCompraValePedagio	int	Sim	Id Compra Vale-Pedágio Cartão	N/A
2	Valor	decimal	Sim	Valor	N/A
3	IdStatusCompraValePedagioPosCancelamento	int	Não	Status da Compra	1 = Aguardando 2 = Confirmada 3 = Cancelada

Nº	Campo	Tipo	Obrigatório	Descrição	Observação
DadosCompraValePedagioViaFacilPosCancelamento
1	IdCompraValePedagioViaFacil	int	Não	Id Compra Vale-Pedágio Via Fácil	N/A
2	Valor	decimal	Sim	Valor	N/A
3	IdStatusCompraValePedagioViaFacilPosCancelamento	int	Sim	Status da Compra	1 = Aguardando 2 = Confirmada 3 = Cancelada

Método

Abaixo, segue o método - 'CancelarOperacaoTransporte'.

CancelamentoOperacaoRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:CancelarOperacaoTransporte>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:cancelamentoOperacaoRequest>
            <tms:IdOperacao>?</tms:IdOperacao>
            <tms:MotivoCancelamento>?</tms:MotivoCancelamento>
         </tms:cancelamentoOperacaoRequest>
      </tms:CancelarOperacaoTransporte>
   </soapenv:Body>
</soapenv:Envelope>

Cancelar

CancelamentoOperacaoRequest

Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
    <tms:CancelarOperacaoTransporte>
      <tms:auth>
        <tms:Usuario>tms.exemplo</tms:Usuario>
        <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
      </tms:auth>
      <tms:cancelamentoOperacaoRequest>
        <tms:IdOperacao>132329</tms:IdOperacao>
        <tms:MotivoCancelamento>Contrato cancelado pelo usuarioRODRIGO.MOMESSO</tms:MotivoCancelamento>
      </tms:cancelamentoOperacaoRequest>
    </tms:CancelarOperacaoTransporte>
  </soapenv:Body>
</soapenv:Envelope>

Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tmsfrete.v2.targetmp.com.br/FreteTMSService/CadastrarAtualizarTransportadorResponse</Action>
  </s:Header>
  <s:Body>
    <CancelarOperacaoTransporteResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
      <CancelarOperacaoTransporteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Erro i:nil="true" />
        <IdCancelamentoOperacaoTransporte>1534</IdCancelamentoOperacaoTransporte>
        <DataCancelamento>2018-08-20T17:27:14.1192547</DataCancelamento>
        <ProtocoloCancelamento>C18000000002527</ProtocoloCancelamento>
		<DadosCompraValePedagioRelacionadas i:nil="true" />
        <DadosCompraValePedagioViaFacilRelacionadas i:nil="true" />
      </CancelarOperacaoTransporteResult>
    </CancelarOperacaoTransporteResponse>
  </s:Body>
</s:Envelope>