Open topic with navigation

DOCUMENTATION PORTAL
Human Capital Management | HCM - senior X
Note: This page was translated using automation resources with the purpose of providing content in your language more quickly. Consequently, it may have grammatical errors and similar situations. If the content is not useful in this state, in the page footer you can access the original material in Brazilian Portuguese and also give us opinions on this translation.
Human Capital Management - senior X - User Manual > Colabbe - Digital Hiring > Integrations > Integration via APIs > Fetch all information from a pre-hiring (preAdmissionQuery)

Find information of a given pre-hire

Busca todas as informações de uma pré-admissão específica, com base no identificador único dessa pré-admissão.

Definições da API:

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/preAdmissionQuery

Substitua <url_plataforma> pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por: https://platform.senior.com.br

Cabeçalho (Header)

Authorization Bearer​ <access_token>
Content-Type application/json

Substitua <access_token> pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

* Obrigatórios

Parâmetro Tipo Descrição
preAdmissionId * String Identificador único da pré-admissão.

Exemplo

 { "preAdmissionId": "string", }

Respostas

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
result { } Resultados da requisição.
  preAdmissionId String Identificador único da pré-admissão.
  admissionDate String Data em que o novo colaborador será admitido.
  contract { } Informações de contrato com a empresa.
  personalData { } Informações pessoais do novo colaborador.
  document { } Documentos do novo colaborador.
  vacancyCode Long Número da vaga gerada pelo módulo Gestão de Recrutamento e Seleção (GRS) do HCM senior X. Este parâmetro é usado pelo GRS para enviar as informações da vaga e do candidato para as pré-admissões no sistema da Colabbe.
  dependents { } Relação de dependentes do novo colaborador.
ClosedConteúdo de contract:
Campo Tipo Descrição
employeeType String Tipo do colaborador.
employeeContract String Tipo de contrato.
eSocialCategory String Categoria do eSocial.
sefipCategory String Categoria da SEFIP.
unemploymentInsurance String Tipo do seguro desemprego.
raisType String Vínculo da RAIS.
customFields { } Campos customizados.
ClosedConteúdo de personalData:
Campo Tipo Descrição
basic { } Informações básicas do novo colaborador.
  employeeFullName String Nome completo.
  gender String Gênero.
  birthDate String Data de nascimento.
  preferredName String Nome pelo qual prefere ser chamado.
  mothersName String Nome da mãe.
  fathersName String Nome do pai.
  customFields { } Campos customizados.
complementary { } Informações complementares do novo colaborador.
  maritalStatus String Estado civil.
  degreeOfEducation String Grau de instrução.
  nationality String Nacionalidade.
  religion String Religião.
  race String Raça/Cor.
  socialName String Nome social.
  customFields { } Campos customizados.
birthPlace { } Informações do local de nascimento do novo colaborador.
  country String País do local de nascimento.
  state String Estado do local de nascimento.
  city String Cidade do local de nascimento.
  customFields { } Campos customizados.
address { } Informações do endereço do novo colaborador.
  country String País.
  state String Estado/unidade federativa.
  city String Cidade.
  cep String CEP.
  neighborhood String Bairro.
  addressType String Logradouro.
  address String Endereço.
  number String Número do endereço.
  additional String Informações adicionais sobre o endereço.
  customFields { } Campos customizados.
email { } E-mails de contato do novo colaborador.
  firstType String Tipo do e-mail principal.
  firstEmail String E-mail principal do novo colaborador.
  secondType String Tipo do e-mail secundário.
  secondEmail String E-mail secundário do novo colaborador.
  customFields { } Campos customizados.
phone { } Telefones de contato do novo colaborador.
  firstType String Tipo do telefone principal.
  firstPhone String Telefone principal do novo colaborador.
  secondType String Tipo do telefone secundário.
  secondPhone String Telefone secundário do novo colaborador.
  customFields { } Campos customizados.
ClosedConteúdo de document:
Campo Tipo Descrição
cpf { } Informações do Cadastro de Pessoa Física (CPF) do novo colaborador.
  number String Número do documento.
  customFields { } Campos customizados.
pis { } Informações do Programa de Integração Social (PIS) do novo colaborador.
  number String Número do documento.
  issueDate String Data de emissão do documento.
  customFields { } Campos customizados.
ctps { } Informações da Carteira de Trabalho e Previdência Social (CTPS) do novo colaborador.
  number String Número do documento.
  serie String Número de série do documento.
  digit String Dígito do número do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  customFields { } Campos customizados.
rg { } Informações do Registro Geral (RG) do novo colaborador.
  number String Número do documento.
  issuer String Órgão emissor do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  customFields { } Campos customizados.
passport { } Informações do Passaporte do novo colaborador.
  number String Número do documento.
  issuer String Órgão emissor do documento.
  issueDate String Data de emissão do documento.
  expiryDate String Data de validade do documento.
  issuerCountry String País de emissão do documento.
  issuerState String Estado de emissão do documento.
  customFields { } Campos customizados.
ric { } Informações do Registro de Identidade Civil (RIC) do novo colaborador.
  number String Número do documento.
  issuer String Órgão emissor do documento.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  expiryDate String Data de validade do documento.
  customFields { } Campos customizados.
voter { } Informações do Título de Eleitor do novo colaborador.
  number String Número do documento.
  votingDistrict String Zona eleitoral do documento.
  votingSection String Seção de votação do documento.
  issueDate String Data de emissão do documento.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  customFields { } Campos customizados.
cnh { } Informações da Carteira Nacional de Habilitação (CNH) do novo colaborador.
  number String Número do documento.
  category String Categoria da habilitação.
  issuer String Órgão emissor do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  expiryDate String Data de validade do documento.
  firstDriverLicenseDate String Data da primeira habilitação.
  customFields { } Campos customizados.
reservist { } Informações do Certificado de Reservista do novo colaborador.
  number String Número do documento.
  serie String Número de série do documento.
  ra String Número do Registro de Alistamento (RA).
  exemptionDate String Data de dispensa.
  hasCertificate Boolean Indica se a pessoa tem certificado de reservista.
  customFields { } Campos customizados.
civilCertificate { } Informações da Certidão Civil do novo colaborador.
  type String Tipo da certidão.
  issueDate String Data de emissão do documento.
  registry String Matrícula da certidão.
  term String Termo da certidão.
  book String Livro da certidão.
  sheet String Folha da certidão.
  notaryOffice String Cartório da certidão.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  customFields { } Campos customizados.
cns { } Informações do Cartão Nacional de Saúde (CNS) do novo colaborador.
  number String Número do documento.
  customFields { } Campos customizados.
dnv { } Informações da Declaração de Nascido Vivo (DNV) do novo colaborador.
  number String Número do documento.
  customFields { } Campos customizados.
bankAccount { }  
  bank String Identificador do banco.
  branch String Número da agência bancária.
  accountType String Tipo da conta.
  bankAccount String Conta bancária.
  digit String Dígito da conta.
  customFields { } Campos customizados.
receiveSalaryAdvance String

Indicativo se o novo colaborador gostaria de receber adiantamento salarial.
professionalRecord { } Informações do Conselho Profissional do novo colaborador.
  professionalAdvice String Conselho Profissional.
  number String Número.
  isTemporary String É temporário.
  mteNumber String Número no Ministério do Trabalho.
  shippingDate String Data de expedição.
  dueDate String Data de vencimento.
  customFields { } Campos customizados.
hiringMedicalExam { } Informação sobre a data do exame admissional do colaborador.
  examDate String Data do exame.
  customFields { } Campos customizados.
ClosedConteúdo de dependents:
Campo Tipo Descrição
fullName String Nome completo do dependente.
degreeOfKinship String Grau de parentesco com o dependente.
gender String Gênero do dependente.
birthDate String Data de nascimento do dependente.
mothersName String Nome da mãe do dependente.
maritalStatus String Estado civil do dependente.
declareIncomeTax String Indica se o dependente declara Imposto de Renda.
cpf { } Informações do Cadastro de Pessoa Física (CPF) do dependente.
  number String Número do documento.
  customFields { } Campos customizados.
rg { } Informações do Registro Geral (RG) do dependente.
  number String Número do documento.
  issuer String Órgão emissor do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  customFields { } Campos customizados.
ric { } Informações do Registro de Identidade Civil (RIC) do dependente.
  number String Número do documento.
  issuer String Órgão emissor do documento.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  issueDate String Data de emissão do documento.
  expiryDate String Data de validade do documento.
  customFields { } Campos customizados.
sus { } Informações do Cartão do sistema único de saúde (SUS).
  number String Número do documento.
  customFields { } Campos customizados.
vaccinationBooklet { } Informações da Caderneta de Vacinação.
  customFields { } Campos customizados.
proofOfEnrollment { } Informações do comprovante de matrícula.
  customFields { } Campos customizados.
birthCertificate { } Informações da Certidão de Nascimento do dependente.
  type String Tipo da certidão.
  issueDate String Data de emissão do documento.
  registry String Matrícula da certidão.
  term String Termo da certidão.
  book String Livro da certidão.
  sheet String Folha da certidão.
  notaryOffice String Cartório da certidão.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  customFields { } Campos customizados.
deathCertificate { } Informações da Certidão de Óbito do dependente.
  type String Tipo da certidão.
  issueDate String Data de emissão do documento.
  registry String Matrícula da certidão.
  term String Termo da certidão.
  book String Livro da certidão.
  sheet String Folha da certidão.
  notaryOffice String Cartório da certidão.
  issuerCity String Cidade de emissão do documento.
  issuerState String Estado de emissão do documento.
  customFields { } Campos customizados.
customFields { } Campos customizados.
ClosedConteúdo de customFields:
Campo Tipo Descrição
field String Nome do campo customizado.
value String Valor do campo customizado.
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "result": { "preAdmissionId": "string", "admissionDate": "2022-02-10", "contract": { "employeeType": "string", "employeeContract": "string", "eSocialCategory": "string", "sefipCategory": "string", "unemploymentInsurance": "string", "raisType": "string", "company": { "id": "string", "companyName": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "branchOffice": { "id": "string", "branchOfficeName": "string", "tradingName": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "jobPosition": { "id": "string", "name": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "personalData": { "basic": { "employeeFullName": "string", "gender": "string", "birthDate": "2022-02-10", "preferredName": "string", "mothersName": "string", "fathersName": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "complementary": { "maritalStatus": "string", "degreeOfEducation": 0, "nationality": "string", "religion": "string", "race": "string", "socialName": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "birthPlace": { "country": "string", "state": "string", "city": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "address": { "country": "string", "state": "string", "city": "string", "cep": "string", "neighborhood": "string", "addressType": "string", "address": "string", "number": "string", "additional": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "email": { "emailPersonal": "string", "emailBusiness": "string", "firstType": "string", "firstEmail": "string", "secondType": "string", "secondEmail": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "phone": { "firstType": "string", "firstPhone": "string", "secondType": "string", "secondPhone": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] } }, "document": { "cpf": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "pis": { "number": "string", "issueDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ctps": { "number": "string", "serie": "string", "digit": "string", "issuerState": "string", "issueDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "rg": { "number": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "passport": { "number": "string", "issuer": "string", "issueDate": "2022-02-10", "expiryDate": "2022-02-10", "issuerCountry": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ric": { "number": "string", "issuer": "string", "issuerCity": "string", "issuerState": "string", "issueDate": "2022-02-10", "expiryDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "voter": { "number": "string", "votingDistrict": "string", "votingSection": "string", "issueDate": "2022-02-10", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "cnh": { "number": "string", "category": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-10", "expiryDate": "2022-02-10", "firstDriverLicenseDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "reservist": { "number": "string", "serie": "string", "ra": "string", "exemptionDate": "2022-02-10", "hasCertificate": true, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "civilCertificate": { "type": "string", "issueDate": "2022-02-10", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "cns": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "dnv": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "bankAccount": { "bank": "string", "branch": 0, "accountType": "string", "bankAccount": "string", "digit": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "receiveSalaryAdvance": "string" }, "dependents": [ { "fullName": "string", "degreeOfKinship": "string", "gender": "string", "birthDate": "2022-02-10", "mothersName": "string", "maritalStatus": "string", "declareIncomeTax": "string", "cpf": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "rg": { "number": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ric": { "number": "string", "issuer": "string", "issuerCity": "string", "issuerState": "string", "issueDate": "2022-02-10", "expiryDate": "2022-02-10", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "sus": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "vaccinationBooklet": { "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "proofOfEnrollment": { "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "deathCertificate": { "type": "string", "issueDate": "2022-02-10", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "birthCertificate": { "type": "string", "issueDate": "2022-02-10", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] } ] "vacancyCode": 3 } }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).