2.0info: 2.1.0 Notificações do Aplicativo do Colaborador description: Notificações do Aplicativo do Colaborador x-senior-domain: Mobilidade x-senior-domain-path: mobile x-senior-service-path: app_employee_notification 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/mobilesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /app_employee_notification/queries/healthcheck: post: description: Retorna as informações de healthcheck do serviço. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Estado atual do serviço. checks: type: object allOf: – #/definitions/healthcheckChecks description: Verificações efetuadas e seus respectivos estados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de healthcheck do serviço. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Estado atual do serviço. checks: type: object allOf: – #/definitions/healthcheckChecks description: Verificações efetuadas e seus respectivos estados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/getUserNotifications: post: description: Retorna uma lista ordenada e paginada das notificações do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página de notificações a serem exibidas. default: 1 size: type: integer format: int64 description: Quantidade de notificações que devem ser exibidas por página. default: 10 responses: 200: description: Ok schema: type: object allOf: – #/definitions/pagedNotificationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista ordenada e paginada das notificações do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página de notificações a serem exibidas. in: query type: integer format: int64 – name: size description: Quantidade de notificações que devem ser exibidas por página. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/pagedNotificationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/getUserNotificationSettings: post: description: Retorna uma lista ordenada das configurações de notificações do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – settings properties: settings: type: array items: type: object allOf: – #/definitions/userSettingData minimum: 1 description: Lista ordenada das configurações de notificações do usuário corrente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista ordenada das configurações de notificações do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – settings properties: settings: type: array items: type: object allOf: – #/definitions/userSettingData minimum: 1 description: Lista ordenada das configurações de notificações do usuário corrente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/getUserTokenData: post: description: Retorna as informações de registro do dispositivo do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de registro do dispositivo do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/getNumberOfUnreadNotifications: post: description: Retorna a quantidade de notificações não lidas do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – number properties: number: type: integer format: int64 description: Quantidade de notificações não lidas do usuário corrente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de notificações não lidas do usuário corrente. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – number properties: number: type: integer format: int64 description: Quantidade de notificações não lidas do usuário corrente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/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 /app_employee_notification/queries/exportUserToken: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/exportUserSetting: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/queries/exportNotification: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/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 /app_employee_notification/actions/migrateSchema: post: description: Executa as migrações de base de dados do serviço. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/clearDeviceToken: post: description: Efetua a limpeza do token do dispositivo do usuário corrente. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/deleteAllUserNotifications: post: description: Exclui todas as notificações do usuário corrente. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/markNotificationAsRead: post: description: Marca a notificação identificada pelo seu identificador único como lida. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationId properties: notificationId: type: string description: Identificador único da notificação a ser marcada como lida. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/registerDeviceToken: post: description: Registra o token do dispositivo do usuário corrente e cria as configurações iniciais, caso elas ainda não existam. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceToken – devicePlatform properties: deviceToken: type: string description: Token do dispositivo para envio de notificações push. devicePlatform: type: string allOf: – #/definitions/platform description: Plataforma do dispositivo do usuário. responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/registerDeviceTokenStatus description: Indica a forma que o registro do token do dispositivo do usuário foi registado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/sendPushNotification: post: description: Esta primitiva é privada e não deve ser utilizada sem autorização.\nEfetua o envio de uma notificação push para o usuário informado no parâmetro.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username – title – content – type properties: username: type: string description: Nome de usuário do usuário que irá receber a notificação. type: string description: Título da notificação. content: type: string description: Mensagem da notificação. additionalParameters: type: string description: JSON contendo informações adicionais que poderão ser utilizadas para interpretar a notificação. type: type: string allOf: – #/definitions/notificationType description: Tipo da notificação. responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/deliveryStatus description: Contém o estado de entrega da notificação. O estado USER_NOT_FOUND não irá gerar registro de envio. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/toggleUserNotificationSetting: post: description: Habilita ou desabilita as notificações de uma determinada configuração do usuário corrente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationType – notificationEnabled properties: notificationType: type: string allOf: – #/definitions/notificationType description: Tipo de notificação. notificationEnabled: type: boolean description: Indica se a notificação está habilitada ou não. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/importUserToken: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/importUserSetting: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/actions/importNotification: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/signals/sendPushNotifications: post: description: Esta primitiva é privada e não deve ser utilizada sem autorização.\nEfetua o envio de notificações push para os usuários informados no parâmetro.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – usernames – title – content – type properties: usernames: type: array items: type: string minimum: 1 description: Lista de nomes de usuário dos usuários que irão receber a notificação. type: string description: Título da notificação. content: type: string description: Mensagem da notificação. additionalParameters: type: string description: JSON contendo informações adicionais que poderão ser utilizadas para interpretar a notificação. type: type: string allOf: – #/definitions/notificationType description: Tipo da notificação. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/importUserTokenEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/exportUserTokenEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/importUserSettingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/exportUserSettingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/importNotificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/events/exportNotificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userToken responses: 200: description: The created resource schema: #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userToken responses: 200: description: The created resource schema: #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editUserToken responses: 200: description: Ok schema: #/definitions/editUserToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userToken responses: 200: description: Ok schema: #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userToken responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userSetting: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userSetting responses: 200: description: The created resource schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userSetting responses: 200: description: The created resource schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userSetting/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editUserSetting responses: 200: description: Ok schema: #/definitions/editUserSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userSetting responses: 200: description: Ok schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/{parentId}/userSettings: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/userSetting responses: 200: description: The created resources schema: type: array items: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/userSetting responses: 200: description: The created resources schema: type: array items: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/{parentId}/userSettings/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editUserSetting responses: 200: description: Ok schema: #/definitions/editUserSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/userSetting responses: 200: description: Ok schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userSetting 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userSetting/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userSetting responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/notification: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notification responses: 200: description: The created resource schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notification responses: 200: description: The created resource schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/notification/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editNotification responses: 200: description: Ok schema: #/definitions/editNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notification responses: 200: description: Ok schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/{parentId}/notifications: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/notification responses: 200: description: The created resources schema: type: array items: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/notification responses: 200: description: The created resources schema: type: array items: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/userToken/{parentId}/notifications/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editNotification responses: 200: description: Ok schema: #/definitions/editNotification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notification responses: 200: description: Ok schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/notification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /app_employee_notification/entities/notification/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckStatus: type: string enum: – UP – DOWN description: Contém os estados do healthcheck da plataforma.: * `UP` – Saudável. * `DOWN` – Ruim. notificationType: type: string enum: – HCM_FEEDBACK_RECEIVED – HCM_FEEDBACK_REQUESTED – HCM_PERSONAL_DATA_UPDATE – HCM_PERSONAL_DOCUMENTS_UPDATE – HCM_PERSONAL_CONTACTS_UPDATE – HCM_PERSONAL_ADDRESS_UPDATE – HCM_VACATION_REQUEST_APPROVED – HCM_VACATION_REQUEST_RETURNED – HCM_VACATION_REQUEST_REJECTED – HCM_MOODS_RECEIVED – HCM_PONTO_RECEIVED – HCM_VACATION_REQUEST_EXPIRED – HCM_PAYROLL_LOAN – HCM_SOCIAL – HCM_SOCIAL_POST – HCM_SOCIAL_SPACE description: Contém os tipos de notificação push que podem ser enviadas ao aplicativo.: * `HCM_FEEDBACK_RECEIVED` – Feedback recebido. * `HCM_FEEDBACK_REQUESTED` – Feedback solicitado. * `HCM_PERSONAL_DATA_UPDATE` – Atualização de dados pessoais. * `HCM_PERSONAL_DOCUMENTS_UPDATE` – Atualização de documentos. * `HCM_PERSONAL_CONTACTS_UPDATE` – Atualização de contatos. * `HCM_PERSONAL_ADDRESS_UPDATE` – Atualização de endereço. * `HCM_VACATION_REQUEST_APPROVED` – Solicitação de férias aprovada. * `HCM_VACATION_REQUEST_RETURNED` – Solicitação de férias retornada * `HCM_VACATION_REQUEST_REJECTED` – Solicitação de férias rejeitada. * `HCM_MOODS_RECEIVED` – Pesquisa do moods recebida. * `HCM_PONTO_RECEIVED` – Solicitação de ponto recebida. * `HCM_VACATION_REQUEST_EXPIRED` – Solicitação de férias expiradas. * `HCM_PAYROLL_LOAN` – Empréstimos consignados * `HCM_SOCIAL` – Notificação do Social. * `HCM_SOCIAL_POST` – Notificação de post do social. * `HCM_SOCIAL_SPACE` – Notificação do space do social. deliveryStatus: type: string enum: – USER_NOT_FOUND – USER_HAS_NOT_ALLOWED – MISSING_DEVICE_TOKEN – DELIVERY_ERROR – SUCCESS description: Contém os estados de entrega de notificação push ao aplicativo.: * `USER_NOT_FOUND` – Usuário não registrado para envio de notificação push. * `USER_HAS_NOT_ALLOWED` – Usuário não autorizou o envio de notificações push. * `MISSING_DEVICE_TOKEN` – Token do dispositivo do usuário não encontrado. * `DELIVERY_ERROR` – Erro ao enviar notificação push. * `SUCCESS` – Notificação push enviada com sucesso. registerDeviceTokenStatus: type: string enum: – CREATED – UPDATED – ERROR_ON_UPDATE – ERROR_ON_CREATE description: Contém os estados relacionados ao registro de token do dispositivo do usuário.: * `CREATED` – Registro criado. * `UPDATED` – Registro atualizado. * `ERROR_ON_UPDATE` – Ocorreu um erro ao tentar atualizar o registro existente do usuário. * `ERROR_ON_CREATE` – Ocorreu um erro ao tentar criar o registro do usuário. platform: type: string enum: – ANDROID – IOS description: Plataformas móveis que suportam notificações push.: * `ANDROID` – Android * `IOS` – iOS 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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckChecks: description: Contém a verificação e seu respectivo estado para retornar ao healthcheck da plataforma. type: object required: – name – status properties: name: type: string description: Nome do estado. status: type: string allOf: – #/definitions/healthcheckStatus description: Estado. notificationData: description: Contém as informações de notificações do usuário. type: object required: – id – title – content – additionalParameters – notificationType – createdDate – hasRead properties: id: type: string description: Identificador único da notificação. type: string description: Título da notificação. content: type: string description: Mensagem da notificação. additionalParameters: type: string description: JSON contendo informações adicionais que poderão ser utilizadas para interpretar a notificação. notificationType: type: string allOf: – #/definitions/notificationType description: Tipo de notificação. createdDate: type: string format: date-time description: Data e hora da entrega da notificação push. hasRead: type: boolean description: Indica se a notificação push foi lida pelo usuário. pagedNotificationData: description: Retorno paginado das notificações do usuário corrente. type: object required: – records properties: records: type: integer format: int64 description: Indica quantos registros foram encontrados. notifications: type: array items: type: object allOf: – #/definitions/notificationData description: Notificações encontradas. userSettingData: description: Contém as informações de configuração de notificações do usuário. type: object required: – id – notificationType – notificationEnabled properties: id: type: string description: Identificador único do configuração. notificationType: type: string allOf: – #/definitions/notificationType description: Tipo de notificação. notificationEnabled: type: boolean description: Indica se a notificação está habilitada ou não. userToken: description: Armazena as informações dos tokens dos dispositivos do usuário associado as notificações. type: object required: – username – deviceToken – devicePlatform properties: id: type: string format: uuid description: Identificador único do usuário. username: type: string maxLength: 255 description: Nome de usuário da plataforma. deviceToken: type: string maxLength: 4000 description: Token do dispositivo do usuário responsável pela notificação push. devicePlatform: type: string allOf: – #/definitions/platform description: Plataforma do dispositivo do usuário. notifications: type: array items: type: object allOf: – #/definitions/notification description: Notificações associadas ao usuário. userSettings: type: array items: type: object allOf: – #/definitions/userSetting description: Configurações associadas ao usuário. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editUserToken: type: object required: – id allOf: – #/definitions/userToken userSetting: description: Armazena as configurações de notificações do usuário. type: object required: – notificationType – notificationOrder properties: id: type: string format: uuid description: Identificador único do configuração. userToken: type: object allOf: – #/definitions/userToken description: Usuário associado a configuração. notificationType: type: string allOf: – #/definitions/notificationType description: Tipo de notificação. notificationEnabled: type: boolean description: Indica se a notificação está habilitada ou não. default: true notificationOrder: type: integer format: int64 description: Ordem em que a configuração será exibida. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editUserSetting: type: object required: – id allOf: – #/definitions/userSetting notification: description: Armazena as informações da notificação push enviada ao usuário. type: object required: – title – content – notificationType properties: id: type: string format: uuid description: Identificador único da notificação. userToken: type: object allOf: – #/definitions/userToken description: Usuário associado a notificação. type: string maxLength: 255 description: Título da notificação. content: type: string maxLength: 4000 description: Mensagem da notificação. additionalParameters: type: string maxLength: 4000 description: JSON contendo informações adicionais que poderão ser utilizadas para interpretar a notificação. notificationType: type: string allOf: – #/definitions/notificationType description: Tipo de notificação. deliveryStatus: type: string allOf: – #/definitions/deliveryStatus description: Estado de entrega da notificação push. deliveryDate: type: string format: date-time description: Data e hora da entrega da notificação push. hasRead: type: boolean description: Indica se a notificação push foi lida pelo usuário. default: false readDate: type: string format: date-time description: Data e hora da leitura da notificação push. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNotification: type: object required: – id allOf: – #/definitions/notification 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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