2.0info: 1.3.2 HCM – Clocking Event Collector Foundation Report description: HCM – Clocking Event Collector Foundation Report x-senior-domain: HCM – Clocking Event Collector Foundation x-senior-domain-path: hcm_clocking_event_foundation x-senior-service-path: report 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/hcm_clocking_event_foundationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /report/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/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 /report/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 /report/actions/generateTechnicalReportCertificateX: post: description: Gera o atestado para o sistema X tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reportData properties: reportData: type: object allOf: – #/definitions/reportDataDTO description: Informações do Atestadoa responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: id da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /report/actions/generateTechnicalReportCertificateXT: post: description: Gera o atestado para os sistemas XT tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token – clientId – userGeneration – reportData properties: token: type: string description: token JWT clientId: type: string description: Cliente codcli userGeneration: type: string description: Usuário que está gravando a pendência reportData: type: object allOf: – #/definitions/reportDataDTO description: Informações do Atestado responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: id da requisição default: description: Error response schema: #/definitions/genericError /report/actions/clockingEventSignProof: post: description: Gera o comprovantes assinado da marcação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clockingEventProofData properties: clockingEventProofData: type: object allOf: – #/definitions/clockingEventProofDataDto description: Id da marcação no ARP responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: id da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN repType: description: Tipo de REP type: string enum: – REP_A – REP_C – REP_P – PTRP 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/heathcheckDTO description: Status reportDataDTO: description: Informações do Atestado type: object required: – companyName – cnpj – repType – programIdentifier – programVersion properties: companyName: type: string description: Nome da Empresa cnpj: type: string description: CNPJ da Empresa repType: type: string allOf: – #/definitions/repType description: Tipo do REP arpIntegrationDate: type: string format: date description: Data da Integração com o ARP programIdentifier: type: string description: identificador do programa programVersion: type: string description: versão do programa clockingEventProofDataDto: description: Informações do Comprovante de Marcação type: object required: – nsr – companyName – cnpj – address – employeeName – cpf – eventDate – eventTime – timeZone – code properties: nsr: type: string description: NSR da Marcação companyName: type: string description: Filial cnpj: type: string description: CNPJ da Filial cno: type: string description: CNO da Filial caepf: type: string description: CAEPF da Filial address: type: string description: Endereço Filial employeeName: type: string description: Nome do Colabrador cpf: type: string description: CPF do Colaborador eventDate: type: string format: date description: Data da Marcação eventTime: type: string description: Hora da Marcação timeZone: type: string description: Fuzo da Marcação code: type: string description: Código da Marcação 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