2.0info: 2.12.0 Processador de Pendência description: Processamento de pendências de atualizações x-senior-domain: Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: pendency_generator_async_process 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/samsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pendency_generator_async_process/queries/healthcheck: post: description: Healthcheck tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Healthcheck tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pendency_generator_async_process/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 /pendency_generator_async_process/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 /pendency_generator_async_process/signals/processPendency: post: description: Processamento de pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pendencyId properties: pendencyId: type: integer format: int64 description: Id da pendência responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pendency_generator_async_process/events/pendencyBatchProcessed: post: description: Evento disparado com as pendências geradas do processamento de um item do Controle de Processamento de Pendência x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processedPendencies properties: processedPendencies: type: array items: type: object allOf: – #/definitions/processedPendencyRecord minimum: 1 description: Lista de pendências processadas responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: pendencyType: type: string enum: – UNKNOWN – DEVICE_STATUS – DEVICE_DATE_TIME – BLOCK_DEVICE – UNBLOCK_DEVICE – SET_DEVICE_EMERGENCY – UNSET_DEVICE_EMERGENCY – APOLLO_INCLUDE_CARD – APOLLO_EXCLUDE_CARD – INCLUDE_BIOMETRY – EXCLUDE_BIOMETRY – RESET_DEVICE – DEVICE_CONFIG – LOAD_HOLIDAY_LIST – REMOVE_HOLIDAY_LIST – ACTIVATE_DEVICE_OUTPUT – DEACTIVATE_DEVICE_OUTPUT – PERSON_AREA_UPDATED – DATAMART_UPDATED – COLLECT_EVENTS – DEVICE_INPUT_STATUS – REP_MANUFACTURER_UPDATED – UPDATE_PERSON_REP – ALLOW_CARD_LIST – BIOMETRY_LIST – REMOVE_ALLOW_CARD_LIST – REMOVE_BIOMETRY_LIST – INCLUDE_CARD – EXCLUDE_CARD – DEVICE_DISPLAY_MESSAGE – UPDATE_FIRMWARE – INCLUDE_PHOTO – EXCLUDE_PHOTO – CREDENTIAL_FACIAL_LIST – REP_FACIAL_CREDENTIAL_LIST description: Tipo de pendência: * `UNKNOWN` – Pendência desconhecida * `DEVICE_STATUS` – Status dispositivo * `DEVICE_DATE_TIME` – Data/hora * `BLOCK_DEVICE` – Bloqueio de dispositivo * `UNBLOCK_DEVICE` – Desbloqueio de dispositivo * `SET_DEVICE_EMERGENCY` – Acionar modo de emergência do dispositivo * `UNSET_DEVICE_EMERGENCY` – Desativar modo de emergência do dispositivo * `APOLLO_INCLUDE_CARD` – Inclusão de cartão para apollo * `APOLLO_EXCLUDE_CARD` – Exclusão de cartão para apollo * `INCLUDE_BIOMETRY` – Inclusão de biometria * `EXCLUDE_BIOMETRY` – Exclusão de biometria * `RESET_DEVICE` – Reiniciar dispositivo * `DEVICE_CONFIG` – Configurar dispositivo * `LOAD_HOLIDAY_LIST` – Carregamento de lista de feriados * `REMOVE_HOLIDAY_LIST` – Remoção de lista de feriados * `ACTIVATE_DEVICE_OUTPUT` – Ativação de saída digital * `DEACTIVATE_DEVICE_OUTPUT` – Desativação de saída digital * `PERSON_AREA_UPDATED` – Atualização de local físico da pessoa (para apollo) * `DATAMART_UPDATED` – Atualização de datamart * `COLLECT_EVENTS` – Coleta de eventos * `DEVICE_INPUT_STATUS` – Status da entrada * `REP_MANUFACTURER_UPDATED` – Atualização de fabricante REP * `UPDATE_PERSON_REP` – Atualização de cartão/biometria da pessoa no REP * `ALLOW_CARD_LIST` – Carga da lista de liberação de cartão * `BIOMETRY_LIST` – Carga da lista de biometria * `REMOVE_ALLOW_CARD_LIST` – Remoção da lista de liberação de cartão * `REMOVE_BIOMETRY_LIST` – Remoção da lista de biometria * `INCLUDE_CARD` – Inclusão de cartão para SDK * `EXCLUDE_CARD` – Exclusão de cartão para SDK * `DEVICE_DISPLAY_MESSAGE` – Atualizar mensagem no display do dispositivo * `UPDATE_FIRMWARE` – Atualização do firmware * `INCLUDE_PHOTO` – Pendência para incluir uma foto no dispositivo * `EXCLUDE_PHOTO` – Pendência para excluir uma foto no dispositivo * `CREDENTIAL_FACIAL_LIST` – Carga da lista de credencial facial * `REP_FACIAL_CREDENTIAL_LIST` – Carga da lista de credencial facial para REP 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 processedPendencyRecord: description: Registro de pendência processada type: object required: – pendencyType properties: pendencyType: type: string allOf: – #/definitions/pendencyType description: Tipo de pendência parentDeviceId: type: integer format: int64 description: ID do dispositivo gerenciador driverId: type: integer format: int64 description: ID do driver param: type: string description: Parâmetros da pendência default: {} 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