Totvs custom tabs box items |
---|
| Parâmetros de Entrada POST:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header |
| autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | content | request da api | sim | body |
| Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: Dados de preparação de ambiente.: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de currículo.Período de Estabilidade: - employeeIdcpf: Informação pertinente ao candidatofuncionário.
- namestartDate: Nome do candidato Data do Início do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade registrado.
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta SOAP UI POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v2/candidatesStabilityControl Image RemovedImage Added Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"companyId": "T1",
"branchId": "D MG 01 ",
"idemployeeId": "000001",
"NamestartDate": "JOÃO PEREIRA DA SILVAI20200101",
"BirthstabilityCode": "01/01/1990S01",
"HomeState": "MG",
"Naturalness": "Belo Horizonte",
"NickName": "Jão",
"Sex": "M",
"Nationality": "10",
"EducationalLevel": "9",
"Street": "Rua Mata Atlantica",
"Number": "333",
"District": "Planalto",
"State": "MG",
"City": "Belo Horizonte",
"Cep": "30100020",
"Country": "Brasil",
"ProfessionalRegistrationNumber": "Reg-00098",
"Cpf": "51427362653",
"ImageId": 844,
"PhoneNumber1": "4613636",
"PhoneNumber2": "4613636",
"identityNumber": "M 267392",
"IdentityNumberEmitterState": "MG",
"IdentityNumberEmitterAgency": "SSP",
"IdentityNumberEmissionDate": "1993-04-25T00:00:00",
"ElectoralCard": "123.334",
"ElectoralWard": "0012",
"ElectoralSection": "0006",
"WorkCard": "015116",
"WorkCardSerialNumber": "00001",
"WorkCardEmitterState": "MG",
"WorkCardEmissionDate": "1993-03-01T00:00:00",
"Nit": 0,
"DriversLicense": "13.344.543",
"DriversLicenseType": "A",
"DriversLicenseExpirationDate": "1997-02-05T00:00:00",
"MilitaryDischargeCertificate": "12856945678",
"MilitaryGrade": "CDI",
"BrazilConsort": 0,
"Naturalized": 0,
"BrazilianChildren": 0,
"BrazilianChildrenNumber": "2",
"Email": "[email protected]",
"PreviousTrainingInvestment": "2300.00",
"ShadeRace": "0",
"Disabled": 0,
"UserCode": "simone",
"PhoneNumber3": "21229000",
"Company": "RM SISTEMAS S.A",
"OccupationCode": "10",
"Rehabilitated": 0,
"Smoker": 0,
"AdjustsImageSize": 0,
"DeafPerson": 0,
"MutePerson": 0,
"BlindPerson": 0,
"MentallyImpairedPerson": 0,
"CurriculumApprovalDate": "2005-04-01T09:36:02.66",
"Student": 1,
"Teacher": 1,
"Candidate": 1,
"BibliosUser": 1,
"Employee": 1,
"FormerEmployee": 0,
"IntellectualImpairedPerson": 0,
"Deceased": 0,
"Age": 53,
"RegistryDate": "2019-05-02T20:32:12.931Z",
"WageExpectation": "1111.32",
"AreaOfInterestCode1": "15",
"AreaOfInterestCode2": "15",
"WageExpectationTradable": "1",
"azerienceTime": "15",
"WorkExperienceTimeArea1": "15",
"WorkExperienceTimeArea2": "15",
"ContraIndicated": "1",
"ContraindicationReason": "string",
"Available": "1",
"FormOfRecruitment": "string",
"ResumeSkillsId": "15",
"HierarchyLevelCode": "15",
"ProfessionalProfileDescription": "string",
"AreaOfInterestDescription1": "string",
"AreaOfInterestDescription2": "string",
"HierarchyLevelDescription": "string",
"ProfessionalSkillsResumeDescription": "string",
"Employee1": "string",
"PersonalEmail": "string",
"MaritalState": "string",
"Complement": "string",
"ArrivalDate": "2019-05-02T20:32:12.931Z",
"LetterModel19": "string",
"Rne": "string",
"ImmigrationDecree": "string",
"RneExpirationDate": "2019-05-02T20:32:12.931Z",
"WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
"VisaType": "string",
"PassportNumber": "string",
"NativeCountry": "string",
"PassportExpirationDate": "2019-05-02T20:32:12.931Z",
"AccessibilityFeaturesForJobLocal": "string",
"MilitaryDivision": "string",
"MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
"MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
"MilitaryRegion": "string",
"MilitarySituation": "string",
"ElectoralCardEmitterState": "string",
"BloodType": "string",
"Image": "string",
"NeighborhoodTypeCode": "15",
"NaturalnessCode": "string",
"NaturalisationDate": "2019-05-02T20:32:12.931Z",
"DriversLicenseEmitterAgency": "string",
"RneEmitterAgency": "string",
"CountryId": "1",
"DeceaseDate": "2019-05-02T20:32:12.931Z",
"DeathCertificateNumber": "string",
"NaturalisationGatehouse": "string",
"BrazilConditionClassification": "string",
"DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
"FirstJobYear": "15"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. | Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId | Informações de acesso ao sistema, campo contém informação do grupo de empresa | branchId | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | Name | QG_NOME | Nome do Candidato | "JOÃO PEREIRA SILVA" | RegistryDate | QG_DTCAD | Data do Registro | 2019-05-02T20:32:12 | District | QG_BAIRRO | Bairro | BARRA FUNDA | City | QG_MUNICIP | Municip | SAO PAULO | State | QG_ESTADO | Estado | SP | Cep | QG_CEP | Cep | 12345678 | PhoneNumber1 | QG_FONE | Fone | PhoneNumber2 | QG_FONECEL | Fone Celular | PhoneNumber3 | QG_FONECOM | Fone Comercial | identityNumber | QG_RG | RG | 123456789 | Cpf | QG_CIC | CPF | 12345678900 | WorkCard | QG_NUMCP | Num CP | WorkCardSerialNumber | QG_SERCP | Serie CP | WorkCardEmitterState | QG_UFCP | UF CP | DriversLicense | QG_HABILIT | Habilitação | MilitaryDischargeCertificate | QG_RESERV | Reservista | ElectoralCard | QG_TITULOE | Titulo Eleitor | Street + Number | QG_ENDEREC | Endereço | ElectoralWard+ElectoralSection | QG_ZONASEC | Zona Eleitoral | Sex | QG_SEXO | Sexo | F - Feminino; M - Masculino. | MaritalState | QG_ESTCIV | Estado Civil | C - Casado; D - Divorciado; M - União Estável; Q - Desquitado; S - Solteiro; V - Viúvo. | HomeState | QG_NATURAL | Naturalidade - UF | SP | Nationality | QG_NACIONA | Nacionalidade | 10 | Birth | QG_DTNASC | Data de Nascimento | 1900-01-01T01:01:01 | "001" | QG_SITUAC | Situac (Status Disponível) | Email | QG_EMAIL | Email | [email protected] | Disabled | QG_DFISICO | Deficiente fisico | 1- Sim; 2 - Não. | Naturalness | QG_MUNNASC | Naturalidade | SAO PAULO | AreaOfInterestCode1 | QG_AREA | Código da área de interesse 1 | HierarchyLevelCode | QG_NIVHIER | Código do nível hierárquico | WorkExperienceTime | QG_TPEXPER | Tempo de experiência profissional | WageExpectation | QG_PRETSAL | Pretensão Salarial | 1000.00 | ArrivalDate | QG_ANOCHEG | Data de chegada no Brasil | 1900-01-01T01:01:01 | ProfessionalSkillsResumeDescription | QG_MEMO2 | Descrição do resumo de qualificações | Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus: Mensagens de Pré-Validação Erro | Mensagem | Solução | API RESPONSE | 400 | Verificar se a propriedade (name) está preenchida. | Verificar se a propriedade json name está preenchida no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "VERIFICAR SE A PROPRIEDADE (Name) ESTÁ PREENCHIDA, POIS A MESMA É OBRIGATÓRIA PARA GERAÇÃO DO CADASTRO DE CURRÍCULO.\r\n"
} |
| 400 | Verificar se a propriedade (AreaOfInterestCode1) possui cadastro no Protheus. | É necessário analisar o cadastro dentro do Protheus, para checagem se o código da área de interesse existe no Protheus, é possível checar pela própria tela de currículo. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "VERIFICAR SE A PROPRIEDADE (AreaOfInterestCode1) POSSUI CADASTRO DO PROTHEUS E REENVIAR.\r\n"
} |
| 400 | Verificar se a propriedade (Cpf) está preenchida. | Verificar se a propriedade json cpf está preenchida no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "VERIFICAR SE A PROPRIEDADE (Cpf) ESTÁ PREENCHIDA, POIS A MESMA É OBRIGATÓRIA PARA GERAÇÃO DO CADASTRO DE CURRÍCULO.\r\n"
} |
| OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. Totvs custom tabs box items |
---|
| Parâmetros de Entrada PUT:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | "" | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | candidatesId | 'T1|D MG 01|12345678910' | Sim | request | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|QG_FILIAL|QG_CIC". | content | layout json | sim | body | "" | Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: Dados de preparação de ambiente. - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de currículo. - cpf: Informação pertinente ao candidato
- name: Nome do candidato.
| Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v2/candidates Image Removed Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"companyId":"T1",
"branchId":"D MG 01",
"id": "000001",
"Name": "JOÃO PEREIRA DA SILVAI",
"Birth": "01/01/1990",
"HomeState": "MG",
"Naturalness": "Belo Horizonte",
"NickName": "Jão",
"Sex": "M",
"Nationality": "10",
"EducationalLevel": "9",
"Street": "Rua Mata Atlantica",
"Number": "333",
"District": "Planalto",
"State": "MG",
"City": "Belo Horizonte",
"Cep": "30100020",
"Country": "Brasil",
"ProfessionalRegistrationNumber": "Reg-00098",
"Cpf": "51427362653",
"ImageId": 844,
"PhoneNumber1": "4613636",
"PhoneNumber2": "4613636",
"identityNumber": "M 267392",
"IdentityNumberEmitterState": "MG",
"IdentityNumberEmitterAgency": "SSP",
"IdentityNumberEmissionDate": "1993-04-25T00:00:00",
"ElectoralCard": "123.334",
"ElectoralWard": "0012",
"ElectoralSection": "0006",
"WorkCard": "015116",
"WorkCardSerialNumber": "00001",
"WorkCardEmitterState": "MG",
"WorkCardEmissionDate": "1993-03-01T00:00:00",
"Nit": 0,
"DriversLicense": "13.344.543",
"DriversLicenseType": "A",
"DriversLicenseExpirationDate": "1997-02-05T00:00:00",
"MilitaryDischargeCertificate": "12856945678",
"MilitaryGrade": "CDI",
"BrazilConsort": 0,
"Naturalized": 0,
"BrazilianChildren": 0,
"BrazilianChildrenNumber": "2",
"Email": "[email protected]",
"PreviousTrainingInvestment": "2300.00",
"ShadeRace": "0",
"Disabled": 0,
"UserCode": "simone",
"PhoneNumber3": "21229000",
"Company": "RM SISTEMAS S.A",
"OccupationCode": "10",
"Rehabilitated": 0,
"Smoker": 0,
"AdjustsImageSize": 0,
"DeafPerson": 0,
"MutePerson": 0,
"BlindPerson": 0,
"MentallyImpairedPerson": 0,
"CurriculumApprovalDate": "2005-04-01T09:36:02.66",
"Student": 1,
"Teacher": 1,
"Candidate": 1,
"BibliosUser": 1,
"Employee": 1,
"FormerEmployee": 0,
"IntellectualImpairedPerson": 0,
"Deceased": 0,
"Age": 53,
"RegistryDate": "2019-05-02T20:32:12.931Z",
"WageExpectation": "1111.32",
"AreaOfInterestCode1": "15",
"AreaOfInterestCode2": "15",
"WageExpectationTradable": "1",
"azerienceTime": "15",
"WorkExperienceTimeArea1": "15",
"WorkExperienceTimeArea2": "15",
"ContraIndicated": "1",
"ContraindicationReason": "string",
"Available": "1",
"FormOfRecruitment": "string",
"ResumeSkillsId": "15",
"HierarchyLevelCode": "15",
"ProfessionalProfileDescription": "string",
"AreaOfInterestDescription1": "string",
"AreaOfInterestDescription2": "string",
"HierarchyLevelDescription": "string",
"ProfessionalSkillsResumeDescription": "string",
"Employee1": "string",
"PersonalEmail": "string",
"MaritalState": "string",
"Complement": "string",
"ArrivalDate": "2019-05-02T20:32:12.931Z",
"LetterModel19": "string",
"Rne": "string",
"ImmigrationDecree": "string",
"RneExpirationDate": "2019-05-02T20:32:12.931Z",
"WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
"VisaType": "string",
"PassportNumber": "string",
"NativeCountry": "string",
"PassportExpirationDate": "2019-05-02T20:32:12.931Z",
"AccessibilityFeaturesForJobLocal": "string",
"MilitaryDivision": "string",
"MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
"MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
"MilitaryRegion": "string",
"MilitarySituation": "string",
"ElectoralCardEmitterState": "string",
"BloodType": "string",
"Image": "string",
"NeighborhoodTypeCode": "15",
"NaturalnessCode": "string",
"NaturalisationDate": "2019-05-02T20:32:12.931Z",
"DriversLicenseEmitterAgency": "string",
"RneEmitterAgency": "string",
"CountryId": "1",
"DeceaseDate": "2019-05-02T20:32:12.931Z",
"DeathCertificateNumber": "string",
"NaturalisationGatehouse": "string",
"BrazilConditionClassification": "string",
"DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
"FirstJobYear": "15"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa |
| branchId | RFX_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01 " | employeeId | RFX_MAT | Matrícula do Funcionário | "000001" | startDate | RFX_DATAI | Data de Início do Período | "20200101" | stabilityCode | RFX_TPESTB | Tipo de Estabilidade | "S01" |
Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus:
Mensagens de Validação Erro | Mensagem | Solução | API RESPONSE | 400 | Erro na execução da Operação. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "ERRO NA EXECUÇÃO DA OPERAÇÃO."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 500,
"errorMessage": "ERRO NO ACESSO AO ENDPOINT"
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
|
Totvs custom tabs box items |
---|
| Parâmetros de Entrada PUT:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | "" | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | stabilityId | 'T1|D MG 01|000001|20200101|S01' | Sim | request | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|RFX_FILIAL|RFX_MAT|RFX_DATAI|RFX_TPESTB". | content | layout json | sim | body | "" | Estrutura json com informações de cadastro do currículo: Dados de Período de Estabilidade: - endDate: Data do Final do Período de Estabilidade.
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v2/StabilityControl Image Added Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"endDate": "20200115"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa |
| branchId |
| Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial |
| employeeId | RFX_MAT | Matrícula do Funcionário. | "000001" | startDate | RFX_DATAI | Data de Início do Período | "20200101" | endDate | RFX_DATAF | Data do Final do Período | "20200115" | stabilityCode | RFX_TPESTB | Descrição do resumo de qualificações | "S01" |
| Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId | Informações de acesso ao sistema, campo contém informação do grupo de empresa | branchId | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | Name | QG_NOME | Nome do Candidato | "JOÃO PEREIRA SILVA" | RegistryDate | QG_DTCAD | Data do Registro | 2019-05-02T20:32:12 | District | QG_BAIRRO | Bairro | BARRA FUNDA | City | QG_MUNICIP | Municip | SAO PAULO | State | QG_ESTADO | Estado | SP | Cep | QG_CEP | Cep | 12345678 | PhoneNumber1 | QG_FONE | Fone | PhoneNumber2 | QG_FONECEL | Fone Celular | PhoneNumber3 | QG_FONECOM | Fone Comercial | identityNumber | QG_RG | RG | 123456789 | Cpf | QG_CIC | CPF | 12345678900 | WorkCard | QG_NUMCP | Num CP | WorkCardSerialNumber | QG_SERCP | Serie CP | WorkCardEmitterState | QG_UFCP | UF CP | DriversLicense | QG_HABILIT | Habilitação | MilitaryDischargeCertificate | QG_RESERV | Reservista | ElectoralCard | QG_TITULOE | Titulo Eleitor | Street + Number | QG_ENDEREC | Endereço | ElectoralWard+ElectoralSection | QG_ZONASEC | Zona Eleitoral | Sex | QG_SEXO | Sexo | F - Feminino; M - Masculino. | MaritalState | QG_ESTCIV | Estado Civil | C - Casado; D - Divorciado; M - União Estável; Q - Desquitado; S - Solteiro; V - Viúvo. | HomeState | QG_NATURAL | Naturalidade - UF | SP | Nationality | QG_NACIONA | Nacionalidade | 10 | Birth | QG_DTNASC | Data de Nascimento | 1900-01-01T01:01:01 | "001" | QG_SITUAC | Situac (Status Disponível) | Email | QG_EMAIL | Email | [email protected] | Disabled | QG_DFISICO | Deficiente fisico | 1- Sim; 2 - Não. | Naturalness | QG_MUNNASC | Naturalidade | SAO PAULO | AreaOfInterestCode1 | QG_AREA | Código da área de interesse 1 | HierarchyLevelCode | QG_NIVHIER | Código do nível hierárquico | WorkExperienceTime | QG_TPEXPER | Tempo de experiência profissional | WageExpectation | QG_PRETSAL | Pretensão Salarial | 1000.00 | ArrivalDate | QG_ANOCHEG | Data de chegada no Brasil | 1900-01-01T01:01:01 | ProfessionalSkillsResumeDescription | QG_MEMO2 | Descrição do resumo de qualificações | Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus: Mensagens de Pré-Validação Erro | Mensagem | Solução | API RESPONSE | 400 | Erro genérico de operação. | Analisar disponibilidade de ambiente Protheus e revisar parametrização. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "ERRO NA EXECUÇAO DA OPERAÇÃO."
} |
| 400 | Verificar se a propriedade (AreaOfInterestCode1) possui cadastro no Protheus. | É necessário analisar o cadastro dentro do Protheus, para checagem se o código da área de interesse existe no Protheus, é possível checar pela própria tela de currículo. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO NA BASE PARA O COMPANYID E BRANCHID"
} |
| 400 | Erro de sistema. | Verificar disponibilidade de ambiente e arquivo console.log | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "OCORREU UMA FALHA NO RETORNO DA INFORMAÇÃO."
} |
| OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. Totvs custom tabs box items |
---|
| Parâmetros de Entrada GET: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | page | request da api | Sim | query | 1 | pageSize | request da api | Sim | query | 2000 | O Limite | candidatesIds | T1|D RJ|123456789 | Sim | query | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA|QG_FILIAL|QG_CIC", caso tenha mais de um candidato a ser consultado, se faz necessário adicionar "," e colocar o novo bloco. ex: "GRUPO DE EMPRESA|QG_FILIAL|QG_CIC,GRUPO DE EMPRESA|QG_FILIAL|QG_CIC" | Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}//rh/v2/candidates Image Removed Response da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"companyId":"T1",
"branchId":"D MG 01",
"id": "000001",
"Name": "JOÃO PEREIRA DA SILVAI",
"Birth": "01/01/1990",
"HomeState": "MG",
"Naturalness": "Belo Horizonte",
"NickName": "Jão",
"Sex": "M",
"Nationality": "10",
"EducationalLevel": "9",
"Street": "Rua Mata Atlantica",
"Number": "333",
"District": "Planalto",
"State": "MG",
"City": "Belo Horizonte",
"Cep": "30100020",
"Country": "Brasil",
"ProfessionalRegistrationNumber": "Reg-00098",
"Cpf": "51427362653",
"ImageId": 844,
"PhoneNumber1": "4613636",
"PhoneNumber2": "4613636",
"identityNumber": "M 267392",
"IdentityNumberEmitterState": "MG",
"IdentityNumberEmitterAgency": "SSP",
"IdentityNumberEmissionDate": "1993-04-25T00:00:00",
"ElectoralCard": "123.334",
"ElectoralWard": "0012",
"ElectoralSection": "0006",
"WorkCard": "015116",
"WorkCardSerialNumber": "00001",
"WorkCardEmitterState": "MG",
"WorkCardEmissionDate": "1993-03-01T00:00:00",
"Nit": 0,
"DriversLicense": "13.344.543",
"DriversLicenseType": "A",
"DriversLicenseExpirationDate": "1997-02-05T00:00:00",
"MilitaryDischargeCertificate": "12856945678",
"MilitaryGrade": "CDI",
"BrazilConsort": 0,
"Naturalized": 0,
"BrazilianChildren": 0,
"BrazilianChildrenNumber": "2",
"Email": "[email protected]",
"PreviousTrainingInvestment": "2300.00",
"ShadeRace": "0",
"Disabled": 0,
"UserCode": "simone",
"PhoneNumber3": "21229000",
"Company": "RM SISTEMAS S.A",
"OccupationCode": "10",
"Rehabilitated": 0,
"Smoker": 0,
"AdjustsImageSize": 0,
"DeafPerson": 0,
"MutePerson": 0,
"BlindPerson": 0,
"MentallyImpairedPerson": 0,
"CurriculumApprovalDate": "2005-04-01T09:36:02.66",
"Student": 1,
"Teacher": 1,
"Candidate": 1,
"BibliosUser": 1,
"Employee": 1,
"FormerEmployee": 0,
"IntellectualImpairedPerson": 0,
"Deceased": 0,
"Age": 53,
"RegistryDate": "2019-05-02T20:32:12.931Z",
"WageExpectation": "1111.32",
"AreaOfInterestCode1": "15",
"AreaOfInterestCode2": "15",
"WageExpectationTradable": "1",
"azerienceTime": "15",
"WorkExperienceTimeArea1": "15",
"WorkExperienceTimeArea2": "15",
"ContraIndicated": "1",
"ContraindicationReason": "string",
"Available": "1",
"FormOfRecruitment": "string",
"ResumeSkillsId": "15",
"HierarchyLevelCode": "15",
"ProfessionalProfileDescription": "string",
"AreaOfInterestDescription1": "string",
"AreaOfInterestDescription2": "string",
"HierarchyLevelDescription": "string",
"ProfessionalSkillsResumeDescription": "string",
"Employee1": "string",
"PersonalEmail": "string",
"MaritalState": "string",
"Complement": "string",
"ArrivalDate": "2019-05-02T20:32:12.931Z",
"LetterModel19": "string",
"Rne": "string",
"ImmigrationDecree": "string",
"RneExpirationDate": "2019-05-02T20:32:12.931Z",
"WorkCardExpirationDate": "2019-05-02T20:32:12.931Z",
"VisaType": "string",
"PassportNumber": "string",
"NativeCountry": "string",
"PassportExpirationDate": "2019-05-02T20:32:12.931Z",
"AccessibilityFeaturesForJobLocal": "string",
"MilitaryDivision": "string",
"MilitaryCertificateEmissionDate": "2019-05-02T20:32:12.931Z",
"MilitaryCertificateEmitterAgency": "2019-05-02T20:32:12.931Z",
"MilitaryRegion": "string",
"MilitarySituation": "string",
"ElectoralCardEmitterState": "string",
"BloodType": "string",
"Image": "string",
"NeighborhoodTypeCode": "15",
"NaturalnessCode": "string",
"NaturalisationDate": "2019-05-02T20:32:12.931Z",
"DriversLicenseEmitterAgency": "string",
"RneEmitterAgency": "string",
"CountryId": "1",
"DeceaseDate": "2019-05-02T20:32:12.931Z",
"DeathCertificateNumber": "string",
"NaturalisationGatehouse": "string",
"BrazilConditionClassification": "string",
"DriversLicenseFirstEmissionDate": "2019-05-02T20:32:12.931Z",
"FirstJobYear": "15"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId | Informações de acesso ao sistema, campo contém informação do grupo de empresa | branchId | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | Name | QG_NOME | Nome do Candidato | "JOÃO PEREIRA SILVA" | RegistryDate | QG_DTCAD | Data do Registro | 2019-05-02T20:32:12 | District | QG_BAIRRO | Bairro | BARRA FUNDA | City | QG_MUNICIP | Municip | SAO PAULO | State | QG_ESTADO | Estado | SP | Cep | QG_CEP | Cep | 12345678 | PhoneNumber1 | QG_FONE | Fone | PhoneNumber2 | QG_FONECEL | Fone Celular | PhoneNumber3 | QG_FONECOM | Fone Comercial | identityNumber | QG_RG | RG | 123456789 | Cpf | QG_CIC | CPF | 12345678900 | WorkCard | QG_NUMCP | Num CP | WorkCardSerialNumber | QG_SERCP | Serie CP | WorkCardEmitterState | QG_UFCP | UF CP | DriversLicense | QG_HABILIT | Habilitação | MilitaryDischargeCertificate | QG_RESERV | Reservista | ElectoralCard | QG_TITULOE | Titulo Eleitor | Street + Number | QG_ENDEREC | Endereço | ElectoralWard+ElectoralSection | QG_ZONASEC | Zona Eleitoral | Sex | QG_SEXO | Sexo | F - Feminino; M - Masculino. | MaritalState | QG_ESTCIV | Estado Civil | C - Casado; D - Divorciado; M - União Estável; Q - Desquitado; S - Solteiro; V - Viúvo. | HomeState | QG_NATURAL | Naturalidade - UF | SP | Nationality | QG_NACIONA | Nacionalidade | 10 | Birth | QG_DTNASC | Data de Nascimento | 1900-01-01T01:01:01 | "001" | QG_SITUAC | Situac (Status Disponível) | Email | QG_EMAIL | Email | [email protected] | Disabled | QG_DFISICO | Deficiente fisico | 1- Sim; 2 - Não. | Naturalness | QG_MUNNASC | Naturalidade | SAO PAULO | AreaOfInterestCode1 | QG_AREA | Código da área de interesse 1 | HierarchyLevelCode | QG_NIVHIER | Código do nível hierárquico | WorkExperienceTime | QG_TPEXPER | Tempo de experiência profissional | WageExpectation | QG_PRETSAL | Pretensão Salarial | 1000.00 | ArrivalDate | QG_ANOCHEG | Data de chegada no Brasil | 1900-01-01T01:01:01 | ProfessionalSkillsResumeDescription | QG_MEMO2 | Descrição do resumo de qualificações | Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus: Mensagens de Pré-Validação de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus:
Mensagens de Pré-Validação Erro | Mensagem | Solução | API RESPONSE | 400 | Erro na execução da Operação. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado . | Erro | Mensagem | Solução | API RESPONSE | 400 | Problema com a parametrização para abertura de ambiente. | Revisar a composição do parâmetro de candidatesIds | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": ERRO AO PREPARAR O AMBIENTE COM A EMPRESA E FILIAL INFORMADOS!.\r\n"
} |
| 400 | Problema com parametrização para abertura de ambiente. | Revisar a composição do parâmetro de candidatesIds | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": ""DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO NA BASE PARA O COMPANYID E BRANCHID".\r\n: 400,
"errorMessage": "ERRO NA EXECUÇÃO DA OPERAÇÃO."
} |
400 | 500 | Possíveis falhas genéricas no meio da busca por candidatos | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamenteRevisar parâmetros de requisição e se o ambiente protheus está disponível. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400500,
"errorMessage": " "ERRO AONO BUSCARACESSO DADOS DO CURRÍCULO.\r\nAO ENDPOINT"
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
Totvs custom tabs box items |
---|
default | no |
---|
referencia | DELETE |
---|
| Parâmetros de Entrada DELETE:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | "" | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | candidatesid RJ|123456789MG 01|000001|20200101|S01' | Sim | query | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA| | QG|QG_CIC|RFX_MAT|RFX_DATAI|RFX_TPESTB". |
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta SOAP UI POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}//rh/v1v2/candidatesStabilityControl Image RemovedImage Added Situações de Erros Tratados O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Tratamento de erros de integração Protheus: Mensagens de Pré-Validação Tratamento de erros de integração Protheus:
Mensagens de Pré-Validação Erro | Mensagem | Solução | API RESPONSE | 400 | Erro na execução da Operação. | Verificar se a propriedade json stabilityId está preenchida e com dados válidos no pacote enviado | Erro | Mensagem | Solução | API RESPONSE | 400 | Erro genérico de ambiente | Verificar parametrização enviada via api e se o ambiente está no ar. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "ERRO NA EXECUÇAO DA OPERAÇÃO."
} |
| 400 | Validação de empresa e filial | Verificar a parametrização de empresa e filial no parâmetro candidatesid . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "DE-PARA DE EMPRESA E FILIAL NÃO ENCONTRADO ERRO NA BASEEXECUÇAO PARA O COMPANYID". STR0014: "E BRANCHID"DA OPERAÇÃO."
} |
400 | 500 | Falha no meio do processo de exclusão. | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente.verificar console.log, dados de empresa e filial. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400500,
"errorMessage": "OCORREU UMAERRO FALHA NO RETORNOACESSO DAAO INFORMAÇÃO.ENDPOINT"
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. |
|