sgrConsultaPF
Consults professional profile based on CPF.
| Parameters: sgrConsultaPF | |||
|---|---|---|---|
| keyaccess | string | Mandatory | Key returned by the sgrLogin method. |
| cdpas | integer | Mandatory | PAS code, returned by the sgrListPASUser method. |
| cdclient | integer | Mandatory | Client code, returned by the sgrListCompaniesPASUsers method. |
| cdparentsorigin | integer | Mandatory | Employee's nationality code, returned by the sgrListParents method. |
| nrdocumento | string | Mandatory | Professional's document number (CPF). |
Observation: To make it easier to understand the secondary methods, which must be called to return the codes required in the parameters above, an analogy will be presented between the secondary methods and the query screen in Clipas NET. It should be noted that, as they are different systems, the Web Service and Clipas NET do not necessarily have to contain the same fields.
Figure 1: Professional profile consultation screen in Clipas NET. In blue, the names of the parameters have been written. In red are the secondary methods.
METHOD RETURN (sgrData):
ReturnDataset: If the parameters are correct, the object's property will be displayed:
| Field | Type | Description |
|---|---|---|
| CDPFJ | integer | Professional profile code |
| DSNOME | string | Name |
| FLSITPF | Smallint | Professional status |
| DSSITUATION | string | Description of the situation. The registration status can be: 0 - Awaiting Search, 1 - In Search, 2 - Appointed, 3 - Not Appointed, 4 - Canceled, 5 - Awaiting Contact, 6 - Registration Expired, 7 - Provisional Release, 8 - No Search, 9 - Not Appointed - Driver's License Expired, 10 - Driver Suspended, 11 - Vehicle Under Maintenance, 12 - Released One Trip, 13 - Under Analysis. |
| CDVINC | char(1) | Professional link |
| DSVINC | string | Professional link (Description |
| DTCONSULTA | datetime | Date of consultation |
| DTEXPIRATION | datetime | Appointment due date |
| PASSWORD | string | Professional's password |
| NRFONE2 | string | Phone number 2 |
| NRDDD | string | DDD code |
| CDMOT | integer | Driver code |
| NRFONE1 | string | Phone number 1 |
| CDPAISORIGIN | integer | Country of origin code |
| CDOPERATION | integer | Individual's operation code in the company |
| CDUNIDADERESP | integer | Code of the unit responsible for the individual |
| NRDDD1 | string | Telephone DDD 1 |
| NRDD2 | string | DDD of Phone 2 |
ReturnDescription: If there is an error in the execution of the method, the object's property will display:
| Error | Description |
|---|---|
| The current user does not have permission to access company data: [cdcliente] | The user's PAS has no link to the customer entered. Check that the information has been entered correctly. If they are correct, contact the account manager, indicating the error message and the parameters filled in. |
| The CPF entered is invalid. The CPF entered is not in a valid format. You must enter it again. | |
| CPF not registered! |
If the query returns the message "CPF not registered", it means that you need to add it to the system. If the customer does not have the registration service, you can add them using the method below.