×
Menu
Index

API e Objetos

 
 
API

API é um conjunto de rotinas e padrões previamente programado que permite o acesso a uma determinada plataforma.
 
A API SoftSensor é composta por 3 padrões para acesso. Uma biblioteca Java, C# e uma interface de acesso web via Rest com transporte de objetos Representacional em formato JSON:
 
cpSoftSensorAPI.Helper.jar
cpSoftSensorAPI.Helper.dll
http://XXX.XXX.XXX.XXX/cpSoftSensorAPI.Service
 
 
Objetos

O transporte e a persistência dos dados são feitos através dos objetos descritos abaixo.
 

EventTrackingHeader

 
O objeto é responsável por armazenar os dados correspondente ao cabeçalho do registro.
Seus parametros são:
 
IdtEventTrackingHeader
Registro único que corresponde ao cabeçalho. Ele pode ser uma composição de varios itens que determina a unicidade do registro.
 
DttRecord
Data do registro.
 
HashKey
Chave de acesso a API. Essa chave é adquirida no cadastro de aplicação feito no portal de gerenciamento. Ver Item Particularidades da API.
 
 

EventTrackingHeaderData

 
O objeto é responsável por armazenar os dados do cabeçalho correspondente a sessão ou contexo do registro a ser armazenado. Ele tem o conceito de Key x Value, podendo armazenar ‘n’ registros a uma mesmo Sessão /Contexto. Ver Item Particularidades da API.
Seus parametros são:
 
IdtEventTrackingHeader
Registro único que corresponde ao cabeçalho. É o campor que vinculca este objeto ao seu cabeçalho.
 
EventTrackingHeader
Propriedade que armazena o objeto Header. Ver Item Particularidades da API.
 
IdtEventTrackingHeader
Registro único que corresponde ao cabeçalho. É o campo que vincula este objeto ao seu cabeçalho.
 
EventTrackingHeader
Propriedade que armazena o objeto Header. Ver Item Particularidades da API.
 
DesEventTrackingHeaderTag
Descrição do registro definido como valor.
 
VlrEventTrackingHeaderTag
Identificador do registro definido como chave.
 
DttRecord
Data do registro.
 
HashKey
Chave de acesso a API. Essa chave é adquirida no cadastro de aplicação feito no portal de gerenciamento. Ver Item Particularidades da API.
 
 

TrackingData

 
O objeto é responsável por armazenar os dados do rastreamento. Ele também tem o conceito de Key x Value, podendo armazenar ‘n’ registros. Sua utilização é para armazenar caminhos percorridos seus valores atribuidos ou recebidos. Ver Item de Parcularidades da API.
Seus parametros são:
 
IdtEventTrackingHeader
Registro único que corresponde ao cabeçalho. É o campo que vinculca este objeto ao seu cabeçalho.
 
EventTrackingHeader
Propriedade que armazena o objeto Header. Ver Item Particularidades da API
 
IdtEventTrackingObject
Identificador do rastremento. Corresponde a uma identificação do ponto de rastreamento.
 
DesEventTrackingVariable
Descrição da item rastreado.
 
VlrEventTrackingVariable
Valor do item rastreado.
 
DttRecord
Data do registro.
 
HashKey
Chave de acesso a API. Essa chave é adquirida no cadastro de aplicação feito no portal de gerenciamento. Ver Item Particularidades da API.
 
 

TrackingTransaction

 
O objeto é responsável por armazenar os dados do rastreamento de transações. Ver Item Particularidades da API.
Seus parametros são:
 
IdtEventTrackingHeader
Registro único que corresponde ao cabeçalho. É o campo que vinculca este objeto ao seu cabeçalho.
 
EventTrackingHeader
Propriedade que armazena o objeto Header. Ver Item Particularidades da API
 
TypEventTrackingTransaction
Corresponde a uma tipo de transção que se esta armazendando.
 
DesEventTrackingTransaction
Descrição da transação.
 
TimEventTrackingTransaction
Tempo de execução da transação.
 
StsEventTrackingTransaction
Status de execução da transação.
 
DesEventTrackingMessage
Descrição do status da transação.
 
DttRecord
Data do registro.
 
HashKey
Chave de acesso a API. Essa chave é adquirida no cadastro de aplicação feito no portal de gerenciamento. Ver Item Particularidades da API.