Versions Compared

Version Old Version 20 New Version Current
Changes made by

Gabriel Nisã Brandão Casaes Monteiro (Unlicensed)

thiago.morais

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.


Info
titleObservação
  1. Cancelamento de um cadastro de Operação de Transporte Padrão: Para operações do tipo Padrão o
cadastro da
  1. prazo de cancelamento é de 24 horas após a data da declaração da Operação de Transporte.
  2. Cancelamento de um cadastro de 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
  1. TAC-Agregado: O cancelamento pode ser feito em até 5 dias corridos a partir da data de emissão da declaração de transporte, contando essa data como primeiro dia.
    1. Exemplo: Data da declaração:01/03/2019
      1. Data limite de cancelamento: 05/03/2019
  2. 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.


Info
titleObservação

Caso a Operação de Transporte haja uma compra Casos de Uso:

  1. Compra de Vale-Pedágio Cartão
(que o mesmo não foi carregado através do Sistema NUMMUS) ou caso haja uma compra de Vale Pedágio TAG 'Sem Parar' (que não tenha sido confirmado através do método - ConfirmarPedagioTAG), o método - CancelarOperacaoTransporte irá cancelar essas compras de Vale Pedágio automaticamente. Se as compras de Vale Pedágio Cartão ou TAG estiverem sido confirmadas, o método - CancelarOperacaoTransporte não irá cancelar as compras de Vale Pedágio automaticamente, será necessário invocar o método - CancelarCompraValePedagio
  1. 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’.
  2. 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).
  3. 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’.
  4. 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

CancelarOperacaoTransporteRequest
NºCampoTipoObrigatórioDescriçãoObservação
1IdOperacaoIdOperacaoTransporteintSimId da Operação de Transporte.N/A
2MotivoCancelamentostringSimMotivo do cancelamento da Operação de Transporte.N/A

...

CancelarOperacaoTransporteResponse
NºCampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o Erro.NULO em caso de sucesso.
2IdCancelamentoOperacaoTransporteintSimRetorna o ID do Cancelamento da Operação de Transporte.N/A
3DataCancelamentoDatetime(YYYY-MM-DD)SimRetorna a Data de Cancelamento da Operação de Transporte.N/AExemplo: (2018-08-20T10:05:33)
4ProtocoloCancelamentostringSimRetorna o Protocolo de cancelamento da Operação de Transporte.N/A
5DadosCompraValePedagioRelacionadasList<DadosCompraValePedagioPosCancelamento>NãoRetorna 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
6DadosCompraValePedagioViaFacilRelacionadasList<DadosCompraValePedagioViaFacilPosCancelamento>NãoRetorna 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


DadosCompraValePedagioPosCancelamento
NºCampoTipoObrigatórioDescriçãoObservação
1IdCompraValePedagiointSimId Compra Vale-Pedágio CartãoN/A
2ValordecimalSimValorN/A
3IdStatusCompraValePedagioPosCancelamentointNãoStatus da Compra1 = Aguardando
2 = Confirmada
3 = Cancelada


DadosCompraValePedagioViaFacilPosCancelamento
NºCampoTipoObrigatórioDescriçãoObservação
1IdCompraValePedagioViaFacilintNãoId Compra Vale-Pedágio Via FácilN/A
2ValordecimalSimValorN/A
3IdStatusCompraValePedagioViaFacilPosCancelamentointSimStatus da Compra1 = Aguardando
2 = Confirmada
3 = Cancelada


Método

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

...

Code Block
languagexml
themeRDark
firstline1
titleCancelamentoOperacaoRequest
linenumberstrue
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>

...