Cancelamento da Viagem
Método responsável por realizar o cancelamento da viagem.
Request
- ENDPOINT: Viagem/CancelarViagem
- VERBO: POST
| Índice |
Chave |
Descrição |
Elem. |
Tipo |
Ocor. |
Tam. |
Versão |
| 1 |
CNPJAplicacao |
CNPJ Aplicação para autenticação |
E |
Caractere |
1-1 |
14 |
1.0 |
| 2 |
Token |
Gerado a partir do CNPJ de autenticação para validar permissões de acesso |
E |
Caractere |
1-1 |
100 |
1.0 |
| 3 |
DocumentoUsuarioAudit |
Documento do usuário que está realizando a operação |
E |
Caractere |
1-1 |
14 |
1.0 |
| 4 |
NomeUsuarioAudit |
Nome do usuário que está realizando a operação |
E |
Caractere |
1-1 |
60 |
1.0 |
| 5 |
DataEvento |
Data/Hora do cancelamento da viagem |
E |
Data |
1-0 |
yyyy-MM-dd |
1.0 |
| 6 |
CodigoViagem |
IDViagem - Código da viagem a ser cancelada |
E |
Inteiro |
1-1 |
10 |
1.0 |
| 7 |
MotivoCancelamento |
Motivo pelo qual se deseja cancelar a viagem |
E |
Caractere |
1-1 |
1-1 |
500 |
Modelo de Json - Request
{
"CNPJAplicacao": "",
"Token": "",
"DocumentoUsuarioAudit": "",
"NomeUsuarioAudit": "",
"DataEvento": "",
"CodigoViagem": 0,
"MotivoCancelamento": ""
}
Response
| Índice |
Chave |
Descrição |
Elem. |
Tipo |
Ocor. |
Tam. |
Versão |
| 1 |
Sucesso |
True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno False: Qualquer validação ou exceção não tratada pelo sistema que impediu o processo de ser concluído |
E |
Booleano |
1-1 |
True/False |
1.0 |
| 2 |
Mensagem |
Mensagem de retorno |
E |
Caractere |
1-1 |
100 |
1.0 |
Modelo de Json - Response
{
"Sucesso": true,
"Mensagem": null,
"Objeto": null,
"Faults": null
}