sgrListaPontosRota
Returns a list of waypoints for a route.
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. |
| cdrota | integer | Yes | Route Code. This code is returned by the sgrListaRotas method. |
| cdcidorigem | integer | No | Origin city code. This code is returned by the sgrListaCidades method. |
| cdciddestino | integer | No | Destination city code. This code is returned by the sgrListaCidades method. |
METHOD RETURN:
ReturnDataset: If the access key provided is valid, the property will display:
| Field | Type | Description |
|---|---|---|
| CDTRECHO | integer | Section code |
| CDAPOIO | integer | Support point code |
| DSFANTASIA | string | Support point name |
| CDCID | integer | City code |
| NRFONE1 | char(12) | Support point phone number 1 |
| NRFONE2 | char(12) | Support point phone number 2 |
| NRFAX | string | Support point fax number |
| NRDDD | smallint | City area code |
| FLPARADA | string | Stop status (allowed or mandatory) |
| DSCIDADE | string | City name |
| DSNOMECID | string | City name |
| DSSIGLAUF | char(2) | State abbreviation |
| VLDISTTOT | decimal | Total distance |
| CDTIPOAPOIO | integer | Support point type code |
| DSTIPOAPOIO | string | Support point type |
| VLSEQ | integer | Support point sequence |
| VLLAT | decimal | Point latitude |
| VLLONG | decimal | Point longitude |
| SENTIDO | string | Point city |
| DSRUA | string | Point address street |
| NRNUM | char(6) | Address number |
| DSCOMPL | char(50) | Address complement |
| DSBAIRRO | string | Support point neighborhood |
| NRCEP | string | Support point zip code |
| VLKM | float | Point mileage |
| CDROD | char(7)] | Highway |
ReturnDescription: If there is an error executing the method, the property will display:
| Error | Description |
|---|---|
| The requested route does not exist or there are no stopping points on the route | No stopping point was found linked to the searched route. It is necessary to check whether the route code was entered correctly |