sgrConsultaVeic
Performs a vehicle query based on the license plate.
PARAMETERS:
| Field | Type | Req. | Description |
|---|---|---|---|
| keyaccess | string | Yes | Key returned by the sgrLogin method. |
| cdpas | integer | Yes | PAS code, returned by the sgrListaPASUsuario method |
| cdclient | integer | Yes | Client code, returned by the sgrListCompaniesPASUser method. |
| cdparentsorigin | integer | Yes | Employee's nationality code, returned by the sgrListParents method. |
| nrplaca | string | Yes | Vehicle license plate number. |
Observation: To make it easier to understand the secondary methods, which must be called to return the codes required in the parameters listed above, an analogy between the secondary methods and the query screen in Clipas NET will be presented below.
Note that, as they are different systems, the Web Service and Clipas NET do not necessarily have to contain the same fields.
Figure 1: Vehicle query screen in Clipas NET. In blue, the names of the parameters have been written. In red are the secondary methods.
METHOD RETURN:
ReturnDataset: If the parameters are correct, the dataset will display:
| Field | Type | Description |
|---|---|---|
| CDVEIC | integer | Vehicle code |
| NRPLACA | string | Vehicle license plate |
| FLSITVEIC | integer | Situation |
| DSSITUATION | string | Description of the situation. The status of the registration can be: 0-Waiting for Search; 1-In Search; 2-Indicated; 3-Not Indicated; 4-Cancelled; 5-Waiting for Contact; 6-Registration Expired; 7-Provisional Release; 8-No Search; 9-Not Indicated - Driver's License Expired; 10-Driver Suspended; 11-Vehicle Under Maintenance; 12-Released One Trip; 13-In Analysis. |
| DTCONSULTA | datetime | Date of Consultation |
| DTEXPIRATION | datetime | Expiration Date |
| PASSWORD | string | Driver Password |
| DSTPVEIC | string | Vehicle Type Description |
| FLSITMANUT | string | Maintenance status code |
| DSSITMANUT | string | Maintenance situation Description |
| CDVIAGLOGISTICA | integer | Indicates whether it is on a logistics trip |
| CDOPERACAO | integer | Vehicle operation code at the customer |
| CDUNIDADERESP | integer | Code of the unit responsible for the vehicle at the client |
ReturnDescription: If there is an error in the execution of the method, the object's property will display:
License plate not registered: If the query returns this message, it means that the vehicle searched for has not yet been entered into the system. If the customer does not have the registration service, to add it, simply use the following object and method.