2.0info: 1.0.12 tracking description: Serviço do pacote fis-tracking x-senior-domain: fis x-senior-domain-path: fis x-senior-service-path: tracking 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/fissecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tracking/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tracking/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 /tracking/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 /tracking/actions/cadastrarEmpresaTracking: post: description: Serviço de cadastro de empresa filial no tracking tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – value properties: value: type: object allOf: – #/definitions/empresaRecord description: Recebe o objeto empresa responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/resultadoRecord description: Retorna um objeto do tipo resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tracking/actions/cadastrarFaseTracking: post: description: Serviço de cadastro de fase através do motivo de retorno tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – value properties: value: type: object allOf: – #/definitions/motivoRetornoRecord description: Recebe o objeto motivo retorno responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/resultadoRecord description: Retorna um objeto do tipo resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tracking/signals/jobTracking: post: description: Serviço de execução automática e periódica que irá comunicar os dados do FIS com o Tracking tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: aplicacao: description: Enum tipo aplicacao type: string enum: – FisTracking – T upDown: description: Up or down type: string enum: – UP – DOWN 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 empresaRecord: description: Objeto para trafegar as informações da empresa type: object required: – id – idEmpresaMatriz – nome – cnpj – ativo properties: id: type: integer format: int64 description: Id da empresa idEmpresaMatriz: type: integer format: int64 description: Id empresa matriz nome: type: string description: Nome da empresa cnpj: type: string description: CNPJ da empresa ativo: type: boolean description: Status do cadastro idEmpresaTracking: type: string description: Id da empresa no tracking motivoRetornoRecord: description: Objeto para trafegar as informações do motivo de retorno type: object required: – id – idEmpresa – dsMotivoRetorno – ativaIntegracaoTracking – cdFaseTracking – ativaNotificacaoTracking properties: id: type: integer format: int64 description: Id do motivo de retorno idEmpresa: type: integer format: int64 description: Id da empresa filil vinculada dsMotivoRetorno: type: string description: Descrição do motivo de retorno ativaIntegracaoTracking: type: boolean description: Flag integração tracking cdFaseTracking: type: integer format: int64 description: Código fase tracking ativaNotificacaoTracking: type: boolean description: Flag de notificação via tracking cdPlanoTracking: type: integer format: int64 description: Código do plano do tracking resultadoRecord: description: Objeto utilizado para retorno das respostas dos serviços type: object required: – sucesso – mensagem properties: sucesso: type: boolean description: Status do retorno mensagem: type: string description: Mensagem do retorno checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck 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