DOCUMENTAÇÃO CORPORATIVA
CancelarOperacaoTransporte
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 Padrão: Para operações do tipo Padrão o prazo de cancelamento é de 24 horas após a data da declaração da Operação de Transporte.
- Cancelamento de um cadastro de Operação de Transporte 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.
- Exemplo: Data da declaração:01/03/2019
- Data limite de cancelamento: 05/03/2019
- Exemplo: Data da declaração:01/03/2019
- 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)
- 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)
- Cancelaremos a “compra” ao invocarem o método – ‘CancelarOperacaoTransporte’.
- 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.
- Não se preocupem, a Ciapetro já sabe o processo de estorno com a TARGET (Backoffice Bradeco).
- Cancelaremos a “compra” ao invocarem o método – ‘CancelarOperacaoTransporte’.
- Compra de Vale-Pedágio TAG dentro de uma Operação de Transporte (A TAG não foi carregada)
- 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)
- Iremos fazer com que a compra de Vale-Pedágio TAG que já foi carregada, seja cancelada ao invocarem o método – ‘CancelarOperacaoTransporte’.
- Obs. Importante: Lembrando que a compra talvez não seja cancelada por dois motivos (Validações da própria API do Sem Parar)
- A compra foi realizada há mais de 3h.
- O veículo já passo pela primeira praça de pedágio.
- Mesmo que a compra tenha ocorrido no período inferior ao prazo de 3h.
Request
CancelarOperacaoTransporteRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | IdOperacaoTransporte | 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
CancelarOperacaoTransporteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
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 |
DadosCompraValePedagioPosCancelamento | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
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 |
DadosCompraValePedagioViaFacilPosCancelamento | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
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>