sgrAdicionarPessoaFisicaRapidoV3
Method used to include the professional profile register when a search is not required.
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. |
cdpaisorigem | integer | Yes | Employee's nationality code, returned by the sgrListPais method. |
numDocOrgExp | integer | Yes | ID card issuing country. Code returned by the sgrListaOrgaoEmissorRG method, only when the country of origin is Brazil (cdpaisorigem=1), inform -1 in other cases. |
numDocUF | integer | No* | Code of the state where the CNH was issued. This code is returned by the sgrListaUF method. * Mandatory when the professional is a driver. |
strDocVinculo | string | Yes | Professional profile link code. This code is returned by the sgrListaTiposVinculoPF method. |
dtDocEmissao | string | Yes | Document issue date (CPF). Format 'YYYY-MM-DD'. |
dtDocEmissaoCNH | string | No* | CNH issue date. Enter '1900-01-01' when it does not exist. * Mandatory when the professional is a driver. |
dtDocVencCNH | string | No* | CNH expiration date. Enter '1900-01-01' when it does not exist. * Mandatory when the professional is a driver. |
dtDocVencMOOP | string | No | MOPP expiration date. Enter '1900-01-01' when it does not exist. |
strDocCPF | string | Yes | Document number (CPF). Enter only the digits. |
strDocRG | string | Yes | ID number. Enter only the digits. |
strDocNrCNH | string | No* | CNH number. Send “” (blank) when it doesn't exist. * Mandatory when the professional is a driver. |
strDocCategoria | string | No* | Driver's license category. Send “” (blank) when it doesn't exist. * Mandatory when the professional is a driver. |
strDocNrRegistro | string | No* | CNH registration number. Send “” (blank) when it doesn't exist * Required when the professional is a driver. |
dtDpBirth | string | Yes | Professional's date of birth. Format 'YYYY-MM-DD'. |
numDpNationality | integer | Yes | Nationality code. This code is returned by the sgrListNationality method. |
strDpName | string | Yes | Professional's name [50 characters] |
numEndCity | integer | Yes | City of residence code. This code is returned by the sgrListCities method |
strEndPhone1 | string | Yes | Phone number 1. |
strEndPhone2 | string | No | Phone number 2. Send “” (blank) when it doesn't exist. |
strEndFax | string | No | Fax number. Send “” (blank) when it doesn't exist. |
cdEntidadeMOPP | integer | No | MOPP registration entity code. This code is returned by the sgrListMOPPEntities method. Send -1 when no MOPP exists. |
nrMOPP | string | No | Professional's MOPP number. Send “” (blank) when it doesn't exist. |
dtContratacao | string | No | Date the professional was hired. Format 'YYYY-MM-DD'. Send “” (blank) when it doesn't exist. |
nrMatricula | string | No | Enrollment number (employee) at the client [30 characters]. Send “” (blank) when it doesn't exist. |
DDD1 | string | Yes | DDD of phone 1 |
DDD2 | string | No* | DDD of phone 2 * Required if strEndFone2 is filled in |
DDDFax | string | No* | Fax DDD * Required if strEndFax is filled |
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 registration 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: Quick FP registration 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 correctly entered, the ReturnDataset property will contain:
Field | Type | Description |
---|---|---|
CDPFJ | integer | Code of the professional profile registered in the execution of the method |
ReturnDescription: If there is an error in the execution of the method, the object's property will display:
Error | Description |
---|---|
Could not register professional profile | In this case, the Web Service must return the dataset with the errors that made registration impossible. The list of errors can be seen in Table 2 |
If the customer HAS THE REGISTRATION SERVICE, the following method is used to add them: sgrGerarPessoaFisicaV4