sgrIniciarViagem
Starts the Boarding Authorization.
PARAMETERS
Field | Type | Required? | Description |
---|---|---|---|
accesskey | string | Yes | Key returned by the sgrLogin method. |
cdpas | integer | Yes | PAS code, returned by the sgrListaPASUsuario method |
cdcliente | integer | Yes | Client code, returned by the sgrListaEmpresasPASUsuario method. |
cdviagem | integer | Yes | Boarding authorization number. |
METHOD RETURN:
ReturnID: Receives the value 0, indicating the start of the trip.
ReturnDescription: If there is an error in the execution of the method, the property will display:
Error | Description |
---|---|
There is a trip in progress for this license plate | A trip cannot be started using a vehicle that has a trip still in progress. You must change the vehicle or cancel the current trip using the sgrCancelarViagem or sgrFinalizarViagem methods. |
Unable to start the AE | This error may be caused by an incorrect parameter; the field to be corrected will be indicated in the returnDataset property. Therefore, you must check the parameters and run the method again. It may also indicate a timeout or a connection failure with the database. You must forward the information provided, as well as the method name, the time of issue and the customer code to the email: [email protected] so that the error can be validated. |
Trip not found | Unable to locate the boarding authorization. You must check the AE number and try again. |