sgrProcuraRota
Returns a list of the company's routes according to the search parameter.
PARAMETERS
| Field | Type | Required? | Description |
|---|---|---|---|
| keyaccess | string | Yes | Key returned by the sgrLogin method. |
| cdpas | integer | Yes | PAS code, returned by the sgrListPASUser method |
| cdcliente | integer | Yes | Customer code, returned by the sgrListaEmpresasPASUsuario method. |
| tipopesquisa | string | Yes | Type of search to be carried out. Enter 'n'/'N' to search by route name, or 'c'/'C' to query a code. |
| parametro | string | No | Parameter used in the search. If searching by name (searchtype = n), and the parameter is null, it lists all routes. Passing the parameter is mandatory when searching by code (typesearch = c). |
METHOD RETURN:
ReturnDataset: If the parameters are correct, the property will display:
| Field | Type | Description |
|---|---|---|
| CDROTA | integer | Route code |
| DSROTA | string | Route name |
ReturnDescription: If there is an error when executing the method, the property will display:
| Error | Description |
|---|---|
| Invalid parameter type! | You must enter 'n'/'N' to search for the route name, or 'c'/'C' to query a code. |
| There are no routes with the parameter entered! |