2.0info: 2.8.1 HCM – Careers Privacy description: HCM – Careers Privacy x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careersprivacy 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: /careersprivacy/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 /careersprivacy/queries/findBearerByUserId: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userId properties: userId: type: string description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/bearerDTO description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: userId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/bearerDTO description: default: description: Error response schema: #/definitions/genericError /careersprivacy/queries/termOfUseAndPrivacy: post: description: Busca o termo de uso e privacidade cadastrado na base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: language: type: string description: Idioma default: en-US responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO default: description: Error response schema: #/definitions/genericError get: description: Busca o termo de uso e privacidade cadastrado na base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: language description: Idioma in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO default: description: Error response schema: #/definitions/genericError /careersprivacy/queries/getAccountExclusionJustificationOptions: post: description: Busca as opções de justificativa de exclusão de conta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – options properties: options: type: array items: type: object allOf: – #/definitions/justificationExclusionDTO minimum: 1 description: Lista de opções de justificativas de exclusão de conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as opções de justificativa de exclusão de conta tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – options properties: options: type: array items: type: object allOf: – #/definitions/justificationExclusionDTO minimum: 1 description: Lista de opções de justificativas de exclusão de conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersprivacy/queries/companiesUseCandidateData: post: description: Lista de dados das empresas que consumiram os dados do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userId properties: userId: type: string description: Identificador do cadastro do candidato responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companiesUsedCandidateDataDTO minimum: 1 description: Lista de empresas que utilizam os dados do candidato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista de dados das empresas que consumiram os dados do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: userId description: Identificador do cadastro do candidato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companiesUsedCandidateDataDTO minimum: 1 description: Lista de empresas que utilizam os dados do candidato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersprivacy/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 /careersprivacy/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 /careersprivacy/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersprivacy/actions/acceptTerm: post: description: Aceite do termo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – term properties: term: type: object allOf: – #/definitions/termAcceptDto description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersprivacy/actions/registerBearer: post: description: Salva as informações do candidato na tabela Bearer tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/registerBearerDTO responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersprivacy/actions/acceptCookies: post: description: Salvar os termos de aceitação de cookies tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/registerCookieDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/acceptedCookieDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersprivacy/actions/registerCompanyUseCandidate: post: description: Salvar histórico de compartilhamento de dados com a empresa na tabela CompanyUsedBearerData tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/registerCompanyUseCandidateDto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN consentCategoryCookiesEnum: description: Categoria de cookies a serem aceites type: string enum: – REQUIRED – FUNCTIONAL – MARKETING 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 companiesUsedCandidateDataDTO: description: Empresas que utilizam os dados do candidato type: object required: – companyId – companyName properties: companyId: type: string description: Identificador da empresa companyName: type: string description: Nome da empresa bearerDTO: description: Dados do bearer type: object required: – id – userId – candidateId – typeDocument – documentNumber – country properties: id: type: string description: Identificador do registro userId: type: string description: Identificador do usuário candidateId: type: string description: Identificador do candidato typeDocument: type: string description: Tipo de documento documentNumber: type: string description: Número do documento country: type: string description: País de origem termOfUseAndPrivacyDTO: description: Termo de uso e privacidade type: object required: – situation – publishedDate – publishedBy – title – content properties: situation: type: string description: Situação do termo (rascunho ou publicado) publishedDate: type: string format: date-time description: Data de publicação publishedBy: type: string description: Usuário responsável pela publicação type: string description: Título em um idioma específico content: type: string description: Conteúdo em um idioma específico registerCompanyUseCandidateDto: description: Dados de compartilhamento das informações do candidato para a empresa type: object required: – candidateId – companyId – companyName – tenant properties: candidateId: type: string description: Identificador do candidato companyId: type: string description: Identificador da empresa companyName: type: string description: Nome da empresa tenant: type: string description: Tenant termAcceptDto: description: Dados do termo de aceite type: object required: – userId – country – language – documentType – documentNumber properties: userId: type: string description: Id do usuario no external user country: type: string description: País do usuario language: type: string description: Idioma documentType: type: string description: Tipo de documento do usuário documentNumber: type: string description: Numero de documento do usuario registerBearerDTO: description: Dados do candidato para registro do bearer type: object required: – userId – candidateId properties: userId: type: string description: Identificador do usuário candidateId: type: string description: Identificador do candidato registerCookieDTO: description: Payload com dados necessários para salvar termos de aceitação de cookies type: object required: – urlReference – categories properties: urlReference: type: string description: Url a ser registrado categories: type: array items: type: string allOf: – #/definitions/consentCategoryCookiesEnum minimum: 1 description: Lista de categorias acceptedCookieDTO: description: Payload de resposta após consentimento de cookies type: object required: – cookie – expiresAt properties: cookie: type: string description: Id do cookie expiresAt: type: string format: date-time description: Data de expiração do cookie justificationExclusionDTO: description: Justificativa de exclusão de conta type: object required: – id – translations – additional properties: id: type: string description: Identificador único da justificativa translations: type: array items: type: object allOf: – #/definitions/justificationContentTranslationDTO minimum: 1 description: Lista de conteúdos em seus respectivos idiomas additional: type: array items: type: string minimum: 1 description: Condições adicionais ao campo justificationContentTranslationDTO: description: Conteúdo da justificativa internacionalizável type: object required: – language – content properties: language: type: string description: Idioma content: type: string description: Conteúdo 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