2.0info: 1.0.0 Portal de Talentos – Controle das notificações do candidato description: Controle de notificações para usuarios do Portal de Talentos x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: careersnotification 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: /careersnotification/queries/healthcheck: post: description: Verifica se o serviço está ativo 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: Verifica se o serviço está ativo 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 /careersnotification/queries/getNotifications: post: description: Busca as notificações do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate properties: idCandidate: type: string description: Identificador do candidato page: type: integer format: int64 description: Número da página default: 0 size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 200 default: 10 responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/notificationDTO minimum: 1 description: Lista de notificações totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as notificações do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idCandidate description: Identificador do candidato in: query required: true type: string – name: page description: Número da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/notificationDTO minimum: 1 description: Lista de notificações totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/queries/getUnreadNotificationsCount: post: description: Busca a quantidade de notificações não lidas do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate properties: idCandidate: type: string description: Identificador do candidato responses: 200: description: Ok schema: type: object required: – unreadNotificationsCount properties: unreadNotificationsCount: type: integer format: int64 description: Quantidade de notificações não lidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a quantidade de notificações não lidas do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idCandidate description: Identificador do candidato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – unreadNotificationsCount properties: unreadNotificationsCount: type: integer format: int64 description: Quantidade de notificações não lidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/queries/getHistoryNotification: post: description: Primitiva que busca o histórico de notificações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idType – idData properties: idType: type: string description: Identificador do tipo de notificação idData: type: array items: type: string minimum: 1 description: Identificador do dado relacionado responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/historyRegister minimum: 1 description: Lista de registros de histórico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/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 /careersnotification/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 /careersnotification/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 /careersnotification/actions/saveNotification: post: description: Salva a notificação do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate – idType properties: idCandidate: type: string description: Identificador do candidato idType: type: string description: Identificador do tipo de notificação idData: type: string description: Identificador do dado relacionado idRedirect: type: string description: Identificador de redirecionamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/saveVacancy: post: description: Salva uma vaga no banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idExternal – title properties: idExternal: type: string description: Identificador externo da vaga type: string description: Título da vaga externalCompanyId: type: string description: Identificador externo da empresa da vaga responses: 200: description: Ok schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Dados da vaga salva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/saveCompanyProfile: post: description: Salva um perfil de empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idExternal – name – tenant properties: idExternal: type: string description: Identificador externo da empresa name: type: string description: Nome da empresa tenant: type: string description: Tenant da empresa picture: type: string description: URL da logo da empresa responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyDTO description: Dados da empresa salva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/deleteNotification: post: description: Primitiva para deletar a notificação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateId – notificationId properties: candidateId: type: string description: Identificador do candidato notificationId: type: string description: Identificador da notificação responses: 200: description: Ok schema: type: object required: – unreadNotificationsCount properties: unreadNotificationsCount: type: integer format: int64 description: Quantidade de notificações não lidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/readNotification: post: description: Primitiva para marcar a notificação como lida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateId – notificationId properties: candidateId: type: string description: Identificador do candidato notificationId: type: string description: Identificador da notificação responses: 200: description: Ok schema: type: object required: – notification – unreadNotificationsCount properties: notification: type: object allOf: – #/definitions/notificationDTO description: Notificação lida unreadNotificationsCount: type: integer format: int64 description: Quantidade de notificações não lidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/readAllNotifications: post: description: Primitiva para marcar todas as notificaçôes de um candidato como lidas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateId properties: candidateId: type: string description: Identificador do candidato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/saveNotificationBatch: post: description: Primitiva responsável por salvar um lote de notificações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidates – idType properties: candidates: type: array items: type: string minimum: 1 description: Lista contendo os IDs dos candidatos idType: type: string description: Identificador do tipo de notificação idData: type: string description: Identificador do dado relacionado idRedirect: type: string description: Identificador de redirecionamento responses: 200: description: Ok schema: type: object required: – notifications properties: notifications: type: array items: type: object allOf: – #/definitions/basicNotificationDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/saveHistoryNotification: post: description: Primitiva que salva o histórico de notificações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idType – idData – status properties: idType: type: string description: Identificador do tipo de notificação idData: type: string description: Identificador do dado relacionado status: type: string allOf: – #/definitions/historyProcessingStatus description: Status do processamento responses: 200: description: Ok schema: type: object required: – history properties: history: type: object allOf: – #/definitions/historyRegister description: Registro de histórico salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/deleteAllNotifications: post: description: Primitiva responsável por deletar todas as notificações de um candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate properties: idCandidate: type: string description: Identificador do candidato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/deleteAllReadNotifications: post: description: Primitiva responsável por deletar todas as notificações lidas que ultrapassaram o período de retenção configurado na pdl tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – excludedRecordsCount properties: excludedRecordsCount: type: integer format: int64 description: Quantidade de valores excluídos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersnotification/actions/deleteAllUnreadNotifications: post: description: Primitiva responsável por deletar todas as notificações não lidas que ultrapassaram o período de retenção configurado na pdl tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – excludedRecordsCount properties: excludedRecordsCount: type: integer format: int64 description: Quantidade de valores excluídos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim historyProcessingStatus: type: string enum: – PROCESSING – COMPLETED – FAILED description: Status do processamento do histórico de notificações: * `PROCESSING` – Em processamento * `COMPLETED` – Concluído * `FAILED` – Com falha userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – 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 basicNotificationDTO: description: discriminator: _discriminator type: object required: – id – idCandidate – read – _discriminator properties: id: type: string description: Identificador da notificação idCandidate: type: string description: Identificador do candidato read: type: boolean description: Status de leitura da notificação idType: type: string description: Identificador do tipo de notificação idData: type: string description: Identificador do dado relacionado idRedirect: type: string description: Identificador de redirecionamento _discriminator: type: string description: notificationDTO: description: allOf: – #/definitions/basicNotificationDTO – type: object required: – dateCreated – message properties: dateCreated: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de criação da notificação image: type: string description: Imagem da notificação message: type: string description: mensagem da notificação route: type: string description: Rota de redirecionamento da notificação vacancyDTO: description: Representa a entidade de vaga type: object required: – id – title – company – externalId properties: id: type: string description: Identificador da vaga type: string description: Título da vaga company: type: object allOf: – #/definitions/companyDTO description: Identificador da empresa externalId: type: string description: Identificador externo da vaga companyDTO: description: Representa a entidade de empresa type: object required: – id – idExternal – picture – tenant – name properties: id: type: string description: Identificador da empresa idExternal: type: string description: Identificador externo da empresa picture: type: string description: Logo da empresa tenant: type: string description: Tenant da empresa name: type: string description: Nome da empresa historyRegister: description: Representa o registro histórico type: object required: – idType – idData – status properties: id: type: string description: Identificador do registro do histórico idType: type: string description: Identificador do tipo de notificação idData: type: string description: Identificador do dado relacionado status: type: string allOf: – #/definitions/historyProcessingStatus description: Status do registro histórico 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage