2.0info: 5.2.0 HCM – Careers Search Backend description: Foundation do HCM x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careerssearch 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: /careerssearch/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/healthcheckDTO 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/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/queries/findProfileByDocumentTypeNumber: post: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type – document properties: type: type: string description: Tipo do Documento document: type: string description: Número do Documento responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Dados do perfil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: type description: Tipo do Documento in: query required: true type: string – name: document description: Número do Documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Dados do perfil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/queries/findProfileById: post: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id do perfil responses: 200: description: Ok schema: type: object allOf: – #/definitions/profileDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: id do perfil in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/profileDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/queries/searchVacancies: post: description: Retorna informações das vagas e empresa anunciante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – match properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. maximum: 100 default: 10 filter: type: string description: Termo de pesquisa match: type: object allOf: – #/definitions/searchVacancyMatchDTO description: 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/searchSummaryDTO minimum: 1 description: Lista de vagas. default: description: Error response schema: #/definitions/genericError /careerssearch/queries/fetchCities: post: description: Retorna informações das vagas e empresa anunciante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – match properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. maximum: 100 default: 10 filter: type: string description: Termo de pesquisa match: type: object allOf: – #/definitions/searchVacancyMatchDTO description: responses: 200: description: Ok schema: type: object required: – cities properties: cities: type: array items: type: string minimum: 1 description: Lista de cidades. default: description: Error response schema: #/definitions/genericError /careerssearch/queries/findVacancyById: post: description: Retorna a vaga pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – vacancy – company properties: vacancy: type: object allOf: – #/definitions/detailedVacancyDTO description: Dados detalhados da vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Dados da empresa default: description: Error response schema: #/definitions/genericError get: description: Retorna a vaga pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – vacancy – company properties: vacancy: type: object allOf: – #/definitions/detailedVacancyDTO description: Dados detalhados da vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Dados da empresa default: description: Error response schema: #/definitions/genericError /careerssearch/queries/getPartnerCompanies: post: description: Retorna as últimas 8 empresas parceiras que tiveram os perfis publicados e possuem fotos de perfil tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/basicCompanyInfoForHighlightedJobOportunityDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna as últimas 8 empresas parceiras que tiveram os perfis publicados e possuem fotos de perfil tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/basicCompanyInfoForHighlightedJobOportunityDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careerssearch/queries/getMostRecentlyPublishedVacancyPerCompanyForHomeCarousel: post: description: Retorna uma lista de vagas de destaque mais recente por cada companhia com limite declarado por default tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/mostRecentlyPublishedVacancyPerCompanyDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de vagas de destaque mais recente por cada companhia com limite declarado por default tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/mostRecentlyPublishedVacancyPerCompanyDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careerssearch/queries/searchCompanies: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. maximum: 100 default: 10 filter: type: string description: Termo de pesquisa localizations: type: array items: type: object allOf: – #/definitions/searchLocalizationDTO description: Termos para o filtro de localizaçã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/basicCompanyInfoDTO minimum: 1 description: Lista de Empresas default: description: Error response schema: #/definitions/genericError /careerssearch/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 /careerssearch/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/genericError /careerssearch/actions/saveProfile: post: description: Realiza a criação do Perfil Empregador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Informações do Perfil responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Mensagem de Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/actions/saveVacancy: post: description: Realiza a criação das Vagas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/vacancyDTO minimum: 1 description: Informações das Vagas responses: 200: description: Ok schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/vacancyDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/actions/deleteProfile: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identificationType – identificationNumber properties: identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/actions/deleteVacancy: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da vaga gerado no GRS responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssearch/actions/deleteVacancyBatch: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacanciesIds properties: vacanciesIds: type: array items: type: string minimum: 1 description: Lista de vagas pelo Id gerado no GRS responses: 200: description: Ok schema: type: object required: – removedVacancies properties: removedVacancies: type: array items: type: object allOf: – #/definitions/detailedVacancyDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN hiringRegimeTypeDTO: description: type: string enum: – CLT – PJ – COOPERATED – TRAINEE jobModelTypeDTO: description: type: string enum: – HYBRID – IN_PERSON – REMOTE experienceTypeDTO: description: type: string enum: – ENTRY_LEVEL – MID_LEVEL – SENIOR_LEVEL – LEARNER – TRAINEE – INTERNSHIP – SPECIALIST – COORDINATION – MANAGEMENT – DIRECTORSHIP searchTypeDTO: description: Tipo de pesquisa type: string enum: – VACANCY – COMPANY 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 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/healthcheckDTO description: Status companyDTO: description: Armazena as informações da empresa type: object required: – name properties: id: type: string description: Identificador do registro identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação name: type: string description: Nome address: type: object allOf: – #/definitions/addressDTO description: Endereço profileDTO: description: Armazena as informações do perfil da empresa type: object required: – id – company properties: id: type: string description: Identificador do registro tenant: type: string description: Tenant about: type: string description: About profilePicture: type: object allOf: – #/definitions/attachmentDTO description: Foto do perfil coverPicture: type: object allOf: – #/definitions/attachmentDTO description: Foto de Capa sector: type: string description: Setor website: type: string description: Website size: type: string description: Tamanho socialNetworks: type: array items: type: string format: byte description: Redes Sociais company: type: object allOf: – #/definitions/companyDTO description: Informações da Empresa addressDTO: description: Armazena as informações do endereço type: object properties: id: type: string description: Identificador do registro city: type: string description: Cidade province: type: string description: Província country: type: string description: País attachmentDTO: description: Armazena as informações dos anexos type: object required: – extension – size properties: name: type: string description: Nome contentType: type: string description: Tipo extension: type: string description: Extensão size: type: integer format: int64 description: Tamanho pictureUrl: type: string description: Url público do arquivo type: string description: Versão default: 1.0 salaryDTO: description: Armazena as informações do salário type: object properties: id: type: string description: Identificador do registro startRange: type: number format: double description: Faixa Inicial endRange: type: number format: double description: Faixa Final informationDTO: description: Armazena as informações diversas type: object properties: id: type: string description: Identificador do registro description: type: string description: Descrição publicationDTO: description: Armazena as informações de publicação type: object properties: id: type: string description: Identificador do registro startDate: type: string description: Data inicio endDate: type: string description: Data término searchSummaryDTO: description: Retorno da pesquisa de vagas type: object properties: vacancy: type: object allOf: – #/definitions/searchSummaryVacancyDTO description: Vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Data inicio searchSummaryVacancyDTO: description: Armazena as informações das vagas retornadas type: object properties: id: type: string description: Identificador do registro type: string description: Title jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho localization: type: object allOf: – #/definitions/searchLocalizationDTO description: Localization publication: type: object allOf: – #/definitions/publicationDTO description: Publicação searchSummaryCompanyDTO: description: Armazena as informações das empresas retornadas type: object properties: id: type: string description: Identificador do registro picture: type: object allOf: – #/definitions/attachmentDTO description: Imagem de perfil name: type: string description: Nome sector: type: string description: Setor de atuação da empresa address: type: object allOf: – #/definitions/searchLocalizationDTO description: Dados de localização publicationDate: type: string description: Data de publicação tenant: type: string description: Tenant identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação searchLocalizationDTO: description: Armazena as informações da localização da empresa retornada type: object required: – city properties: id: type: string description: Identificador do registro city: type: string description: Cidade province: type: string description: Estado/Província country: type: string description: País searchVacancyMatchDTO: description: Armazena as informações dos filtros de pesquisa type: object required: – type properties: type: type: string allOf: – #/definitions/searchTypeDTO description: Tipo de pesquisa localizations: type: array items: type: object allOf: – #/definitions/searchLocalizationDTO description: Filtro Localização companies: type: array items: type: object allOf: – #/definitions/searchVacancyCompanyDTO description: Filtro empresas searchVacancyCompanyDTO: description: Armazena as informações da empresa para pesquisa de vagas type: object required: – id properties: id: type: string description: Identificador do registro mostRecentlyPublishedVacancyPerCompanyDTO: description: Armazena as informações básicas da oportunidade de trabalho mais destacada por empresa type: object required: – id – code – title – pcd – publishDate – company properties: id: type: string description: Identificador da vaga code: type: integer format: int64 description: Código type: string description: Título jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho traduzida em formato type value pcd: type: boolean description: PCD localization: type: object allOf: – #/definitions/addressDTO description: Localização da vaga publishDate: type: string description: Publicação company: type: object allOf: – #/definitions/basicCompanyInfoForHighlightedJobOportunityDTO description: Informações básicas da companhia basicCompanyInfoForHighlightedJobOportunityDTO: description: Armazena as informações básicas da companhia para as vagas de destaque type: object required: – id – name – tenant – picture properties: id: type: string description: Identificador da empresa name: type: string description: Nome da empresa tenant: type: string description: Tenant identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação picture: type: object allOf: – #/definitions/attachmentDTO description: Profile picture da empresa SearchSummaryPicture: description: Armazena as informações da imagem da empresa retornada type: object required: – version properties: contentType: type: string description: Content Type extension: type: string description: Extension size: type: integer format: int64 description: Size idBlobService: type: string description: Id do Arquivo no BlobService type: string description: Versão translatedEnumDTO: description: Estrutura que armazenará a declaração do enum e o seu valor traduzido type: object required: – type – value properties: type: type: string description: Nome de declaração do enum value: type: string description: Valor traduzido do enum de acordo ao idioma homologado basicVacancyDTO: description: Estrutura para representar as informações básicas de uma vaga discriminator: _discriminator type: object required: – company – _discriminator properties: id: type: string description: Identificador do registro code: type: integer format: int64 description: Código type: string description: Título pcd: type: boolean description: PCD salary: type: object allOf: – #/definitions/salaryDTO description: Salário positions: type: integer format: int64 description: Quantidade about: type: object allOf: – #/definitions/informationDTO description: About requirements: type: object allOf: – #/definitions/informationDTO description: Requisitos duties: type: object allOf: – #/definitions/informationDTO description: Obrigações questionnaire: type: string description: Identificador do questionário company: type: object allOf: – #/definitions/companyDTO description: Empresa localization: type: object allOf: – #/definitions/addressDTO description: Localização publication: type: object allOf: – #/definitions/publicationDTO description: Publicação _discriminator: type: string description: detailedVacancyDTO: description: allOf: – #/definitions/basicVacancyDTO – type: object properties: hiringRegime: type: object allOf: – #/definitions/translatedEnumDTO description: Regime de Contratação jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho experience: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Nível de Experiência fieldSettingsConfig: type: object allOf: – #/definitions/fieldSettingsConfigDTO description: Configurações da candidatura vacancyDTO: description: allOf: – #/definitions/basicVacancyDTO – type: object properties: hiringRegime: type: string allOf: – #/definitions/hiringRegimeTypeDTO description: Regime de Contratação jobModel: type: array items: type: string allOf: – #/definitions/jobModelTypeDTO description: Modalidade de Trabalho experience: type: array items: type: string allOf: – #/definitions/experienceTypeDTO description: Nível de Experiência fieldSettingsConfig: type: object allOf: – #/definitions/fieldSettingsConfigDTO description: Configurações da candidatura basicCompanyInfoDTO: description: Estrutura para representar os dados mínimos/necessários da empresa type: object required: – id – name – localization properties: id: type: string description: Id do perfil da empresa name: type: string description: Nome da empresa profilePicture: type: object allOf: – #/definitions/attachmentDTO description: Foto de Perfil localization: type: object allOf: – #/definitions/addressDTO description: Endereço tenant: type: string description: Tenant da Empresa identificationNumber: type: string description: Identificação da Empresa fieldSettingsConfigDTO: description: type: object properties: groups: type: array items: type: object allOf: – #/definitions/fieldSettingsGroupDTO description: Groups fieldSettingsGroupDTO: description: type: object properties: id: type: string description: Identificador do registro enabled: type: boolean description: Enabled subGroups: type: array items: type: object allOf: – #/definitions/fieldSettingsSubGroupDTO description: SubGroups fieldSettingsSubGroupDTO: description: type: object properties: id: type: string description: Identificador do registro enabled: type: boolean description: Enabled fields: type: array items: type: object allOf: – #/definitions/fieldSettingsFieldDTO description: Fields fieldSettingsFieldDTO: description: type: object properties: id: type: string description: Identificador do registro enabled: type: boolean description: Enabled required: type: boolean description: Required 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