2.0info: 3.20.0 Busca e Pesquisa de Candidatos description: Busca e Pesquisa de Candidatos x-senior-domain: Gestão de Pessoas x-senior-domain-path: hcm x-senior-service-path: candidatesearch contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /candidatesearch/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/whoIsRunning: post: description: Retorna o ip e hostname que recebeu a requisição. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o ip e hostname que recebeu a requisição. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/searchCandidates: post: description: Retorna todos os candidatos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: SimpleQueryString do elasticsearch offset: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. order: type: string allOf: – #/definitions/candidateOrder description: Ordenação sort: type: integer format: int64 description: Sentido da ordenação. ASC – 1, DESC – -1 default: 0 adherence: type: object allOf: – #/definitions/candidateAdherence description: Parametros da aderência. vacancyId: type: string description: Id da vaga booleanQuery: type: string description: Query booleana assessmentId: type: string description: Identificador do teste para ordenação functionId: type: string description: Identificador da função para ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas. totalElements: type: integer format: int64 description: Total de elementos encontrados. contents: type: array items: type: object allOf: – #/definitions/candidateSummary minimum: 1 description: Lista de candidatos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/countVacancyCandidates: post: description: Retorna todos os candidatos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: SimpleQueryString do elasticsearch responses: 200: description: Ok schema: type: object required: – subscribers – others properties: subscribers: type: integer format: int64 description: Total candidatos inscritos. others: type: integer format: int64 description: Total de candidatos do banco de talento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os candidatos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: SimpleQueryString do elasticsearch in: query type: string responses: 200: description: Ok schema: type: object required: – subscribers – others properties: subscribers: type: integer format: int64 description: Total candidatos inscritos. others: type: integer format: int64 description: Total de candidatos do banco de talento. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/countCandidatesByTenant: post: description: Retorna a quantidade total de candidatos em um dado tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – total properties: total: type: integer format: int64 description: Total de candidatos indexados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade total de candidatos em um dado tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Nome do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – total properties: total: type: integer format: int64 description: Total de candidatos indexados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidatesearch/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN educationStatusType: description: Situações da formação acadêmica type: string enum: – IN_PROGRESS – SUSPENDED – CANCELED – FINALIZED competencyType: description: Tipos de competências type: string enum: – KNOWLEDGE – ABILITY candidateOrder: description: Ordenações do candidato type: string enum: – NAME – ADHERENCE – SITUATION – ASSESSMENT_SCORE – SELECTED_REQUIREMENTS_MET – SUBSCRIPTION_DATE candidateSituation: description: Situação do candidato type: string enum: – SUBSCRIBED – SELECTED – ELIMINATED userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT vacanciesSituation: description: Situação do candidato na vaga. type: object required: – vacancy – situation properties: vacancy: type: string description: Identificador da vaga. situation: type: string allOf: – #/definitions/candidateSituation description: Situação do candidato. subscriptionDate: type: string format: date description: Data de inscrição checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status candidateAdherence: description: Parâmetros da aderência. type: object properties: tags: type: array items: type: string description: Tags buscadas. trajectorySession: type: boolean description: Seção de trajetória profissional. professionalExperienceSession: type: boolean description: Seção de histórico profissional. educationSession: type: boolean description: Seção de formação acadêmica. languageSession: type: boolean description: Seção de idiomas. competencySession: type: boolean description: Seção de conhecimentos e habilidades. positionSoughtSession: type: boolean description: Seção de cargos e áreas desejadas. candidateInterest: description: Interesse. type: object required: – id – interest – candidateId properties: id: type: string description: Identificador. interest: type: string description: Interesse. candidateId: type: string description: Id do candidato candidateJobPosition: description: Cargo. type: object required: – id – name – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidateEducation: description: Formação acadêmica. type: object required: – id – course – typeSituation – candidateId properties: id: type: string description: Identificador. course: type: string description: Curso. institution: type: string description: Instituição. level: type: string description: Nível typeSituation: type: string allOf: – #/definitions/educationStatusType description: Situação da formação acadêmica candidateId: type: string description: Id do candidato candidateLanguage: description: Idioma. type: object required: – id – name – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. level: type: string description: Nível candidateId: type: string description: Id do candidato candidateCompetency: description: Competências. type: object required: – id – name – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidatePositionSought: description: Cargo/área desejado. type: object required: – id – candidateId properties: id: type: string description: Identificador. job: type: string description: Cargo. area: type: string description: Área candidateId: type: string description: Id do candidato candidateDisability: description: Deficiência. type: object required: – id – name – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidateCompany: description: Empresa. type: object required: – id – name – candidateId properties: id: type: string description: Identificador. name: type: string description: Estabelecimento. candidateId: type: string description: Id do candidato candidateSummary: description: Dados básicos do candidato. discriminator: _discriminator type: object required: – id – _discriminator properties: id: type: string description: Identificador único. externalId: type: string description: Identificador único HCM. name: type: string description: Nome. birthday: type: string format: date description: Data de nascimento. attachment: type: string description: Anexo. photoAttachment: type: string description: Foto. photoThumbnailLink: type: string description: Url do thumbnail da foto. salaryExpectation: type: number format: double description: Salário desejado. disabilities: type: array items: type: object allOf: – #/definitions/candidateDisability description: Deficiências. candidateType: type: string description: Tipo do candidato subscribedVacancies: type: array items: type: string description: Quantidade de vagas em que o candidato está inscrito. state: type: string description: Estado. stateAbbreviation: type: string description: Sigla do estado. city: type: string description: Cidade. selected: type: boolean description: Indica se o candidato foi selecionado. eliminated: type: boolean description: Indica se o candidato foi eliminado. hasMessagesVacancy: type: boolean description: Indica se o candidato recebeu mensagem. hasMessages: type: boolean description: Indica se o candidato recebeu alguma mensagem. adherence: type: number format: double description: Aderência. visualized: type: boolean description: Indica se foi visualizado pelo usuário atual na vaga atual. selectedVacancies: type: array items: type: string description: Vagas em que o candidato foi selecionado. eliminatedVacancies: type: array items: type: string description: Vagas em que o candidato foi eliminado. receivedMessagesVacancies: type: array items: type: string description: Vagas em que o candidato recebeu mensagens. dismissed: type: boolean description: Ex-colaborador. hasAnnotations: type: boolean description: Possui comentários vacancies: type: array items: type: object allOf: – #/definitions/vacanciesSituation description: Vagas que o candidato concorre assessmentResults: type: array items: type: object allOf: – #/definitions/assessmentResult description: Resultados de teste do candidato grantedDataAccess: type: boolean description: Indica se o candidato concedeu acesso aos dados.\nEste campo irá armazenar a última ação efetuada pelo candidato no sentido de indicar se o acesso\nestá liberado ou não. Caso o candidato faça o aceite e revogação várias vezes, o histórico ficará\narmazenado, porém, aqui, só estará a última ação.\n hasIndications: type: boolean description: Indica se o candidato possui indicações. requirementsMet: type: array items: type: object allOf: – #/definitions/requirementsMet description: Requisitos da vaga atingidos pelo candidato _discriminator: type: string description: assessmentResult: description: Resultado de teste type: object required: – testResultId – testId properties: testResultId: type: string description: Identificador do resultado testId: type: string description: Identificador do teste functionId: type: string description: Identificador da função score: type: number format: double description: Nota candidate: description: Dados do candidato. allOf: – #/definitions/candidateSummary – type: object properties: email: type: string description: E-mail travelPossibility: type: boolean description: Disponibilidade para viagens. realocationPossibility: type: boolean description: Disponibilidade de mudança. competencies: type: array items: type: object allOf: – #/definitions/candidateCompetency description: Habilidades e Conhecimentos. interests: type: array items: type: object allOf: – #/definitions/candidateInterest description: Interesses. languages: type: array items: type: object allOf: – #/definitions/candidateLanguage description: Idiomas. positionsSought: type: array items: type: object allOf: – #/definitions/candidatePositionSought description: Cargos e áreas pretendidas. educations: type: array items: type: object allOf: – #/definitions/candidateEducation description: Graduações. country: type: string description: País. neighborhood: type: string description: Bairro. postalCode: type: string description: Código postal. companies: type: array items: type: object allOf: – #/definitions/candidateCompany description: Histórico profissional de empresas. jobPositions: type: array items: type: object allOf: – #/definitions/candidateJobPosition description: Histórico profissional de cargos. updatedDate: type: string format: date-time description: Data da última atualização. professionalSummary: type: string description: Resumo profissional. professionalGoal: type: string description: Objetivo profissional. requirementsMet: description: Requisitos da vaga atingidos pelo candidato type: object required: – vacancyId – fulfilledSelectedRequirements – vacancySelectedRequirementsNumber properties: vacancyId: type: string description: Identificador da vaga fulfilledSelectedRequirements: type: array items: type: string minimum: 1 description: Requisitos selecionados atingidos vacancySelectedRequirementsNumber: type: integer format: int64 description: Quantidade de requisitos da vaga notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE