sgrCancelarViagem
Cancels the Boarding Authorization.
PARAMETERS
| Field | Type | Required? | Description |
|---|---|---|---|
| keyaccess | string | Yes | Key returned by the sgrLogin method. |
| cdpas | integer | Yes | PAS code, returned by the sgrListPASUser method |
| cdclient | integer | Yes | Customer code, returned by the sgrListCompaniesPASUser method. |
| cdviagem | integer | Yes | Boarding authorization number. |
| flencerramonitoracao | integer | Yes | Always enter the value 1. |
| dsjustificativa | string | Yes | Reason for cancellation. |
METHOD RETURN:
If the trip is canceled, the method returns ReturnID = 0, and the ReturnDescription property displays the message “AE Cancellation Process successfully completed.” or “Monitoring completed and AE cancellation successfully carried out.”.
ReturnDescription: If there is an error when executing the method, the property will display:
| Error | Description |
|---|---|
| An error occurred when changing the data of the canceled AE. Cancellation not made. | For the errors above, you must check the data entered and try again. If the problem persists, send the parameters, together with the issuance time and customer code to the email: [email protected] to validate the error. |
| An error occurred when removing the AE number in Monitoring. Cancellation not made. | |
| An error occurred when changing the status of travel documents. Cancellation not made. | |
| An error occurred while sending AE Cancellation email. Cancellation not made. | |
| An error occurred while deleting data from AE ref. Continuous Steering. Cancellation not made. | |
| An error occurred while deleting data from AE ref. Working Day. Cancellation not made | |
| An error occurred while deleting data from AE ref. Rest stop. Cancellation not made. | |
| An error occurred while deleting data from AE ref. Accident Prevention. Cancellation not made. | |
| An error occurred while removing AE Scheduling data. Cancellation not made. | |
| An error occurred while downloading Missed Start of Trip alert(s) from this AE. Cancellation not made. | |
| An error occurred when linking the AE (new) with Monitoring. Cancellation not made. | |
| An error occurred when finishing monitoring this AE. Cancellation not made. | |
| Unable to record the AE Cancel event to adjust the Monitoring PPM. Cancellation not made. | |
| The AE Cancellation event CheckPoint record could not be entered, but the remainder of the Cancellation process has completed. | |
| AE's situation is different from Nova. It is not possible to cancel it. | It is only possible to update and cancel trips that have not yet started. |