POST api/v1/devices/datagroups/poll

Initiates polling of a device data group, optionally returning transaction data

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Control

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Universal Interface Service (UIS)	string	Required
deviceId	Device ID	string	Required
dataGroupType	The data group type	string	Required
ordinal	The data group ordinal	integer	Required
fromDeviceParameters	Optional string of parameters that may be required when getting from the device; usually an empty string is passed	string	None
returnTransactionData	Optional flag to return transaction data in the response; default value = false	boolean	None
maxWaitInMs	When returnTransactionData = true, the maximum time for the call to wait, in ms; default value = 60000	integer	None

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.UIS",
  "deviceId": "EM107",
  "dataGroupType": "BasicPoll",
  "ordinal": 0,
  "fromDeviceParameters": "",
  "returnTransactionData": true,
  "maxWaitInMs": 120000
}

Response Information

Resource Description

Name	Description	Type	Additional information
error	Any error messages that may have occurred	string	None
transaction	Transaction DTO, only used if transaction is requested	DataGroupTransactionDTO	None

Response Formats

application/json, text/json

Sample:

{
  "error": "",
  "transaction": {
    "header": {
      "deviceId": "EM107",
      "facilityId": "EM107",
      "dataGroupType": "BasicPoll",
      "dataGroupOrdinal": 0,
      "dataBaseKey": "0000000123B0000001C0000029",
      "timestamp": "2019-04-25T09:17:07",
      "type": "Get",
      "userId": "domain\\john.user",
      "statusCode": "Succeeded",
      "statusMessage": "Succeeded",
      "majorVersion": 2,
      "minorVersion": 2,
      "dataSize": 0,
      "headerSize": 300,
      "indexItem": "",
      "appDefined1": 0,
      "appDefined2": 0,
      "appDefined3": 0,
      "appDefined4": 0,
      "hasPartialData": false,
      "compressSize": 753,
      "blobCount": 1
    },
    "transactionDataXml": "<dgData xmlns:dt=\"urn:schemas-microsoft-com:datatypes\">\r\n<ItemCnt dt:dt=\"i4\" desc=\"Number of items\">41</ItemCnt>\r\n<RespLen dt:dt=\"i4\" desc=\"Response length\">139</RespLen>\r\n<InDIs dt:dt=\"i4\" desc=\"DIs installed\">0</InDIs>\r\n<InTDIs dt:dt=\"i4\" desc=\"TDIs installed\">0</InTDIs>\r\n<InAIs dt:dt=\"i4\" desc=\"AIs installed\">8</InAIs>\r\n<InMtrRns dt:dt=\"i4\" desc=\"Meter runs installed\">4</InMtrRns>\r\n<InPIs dt:dt=\"i4\" desc=\"PIs installed\">1</InPIs>\r\n<InPIDs dt:dt=\"i4\" desc=\"PIDs installed\">0</InPIDs>\r\n<InTanks dt:dt=\"i4\" desc=\"Tanks installed\">0</InTanks>\r\n<InAOs dt:dt=\"i4\" desc=\"AOs installed\">1</InAOs>\r\n<InTDOs dt:dt=\"i4\" desc=\"TDOs installed\">1</InTDOs>\r\n<InDOs dt:dt=\"i4\" desc=\"DOs installed\">0</InDOs>\r\n<DiagPnt65 dt:dt=\"r4\" desc=\"Diagnostic65 point\">3.260691</DiagPnt65>\r\n<DiagPnt66 dt:dt=\"r4\" desc=\"Diagnostic66 point\">25.09796</DiagPnt66>\r\n<DiagPnt67 dt:dt=\"r4\" desc=\"Diagnostic67 point\">23.54124</DiagPnt67>\r\n<DiagPnt68 dt:dt=\"r4\" desc=\"Diagnostic68 point\">0.5418656</DiagPnt68>\r\n<DiagPnt69 dt:dt=\"r4\" desc=\"Diagnostic69 point\">79.55807</DiagPnt69>\r\n<AI03 dt:dt=\"r4\" desc=\"AI03 value\">586318.6</AI03>\r\n<AI33 dt:dt=\"r4\" desc=\"AI33 value\">586318.6</AI33>\r\n<AI34 dt:dt=\"r4\" desc=\"AI34 value\">586318.6</AI34>\r\n<MRGas00 dt:dt=\"r4\" desc=\"Meter00 gas flow\">717.4448</MRGas00>\r\n<MREnergy00 dt:dt=\"r4\" desc=\"Meter00 cur energy\">627.6673</MREnergy00>\r\n<MRMcf00 dt:dt=\"r4\" desc=\"Meter00 MCF\">119.1879</MRMcf00>\r\n<MRMmbtu00 dt:dt=\"r4\" desc=\"Meter00 MMBTU\">104.2737</MRMmbtu00>\r\n<MRGas01 dt:dt=\"r4\" desc=\"Meter01 gas flow\">0</MRGas01>\r\n<MREnergy01 dt:dt=\"r4\" desc=\"Meter01 cur energy\">0</MREnergy01>\r\n<MRMcf01 dt:dt=\"r4\" desc=\"Meter01 MCF\">0</MRMcf01>\r\n<MRMmbtu01 dt:dt=\"r4\" desc=\"Meter01 MMBTU\">0</MRMmbtu01>\r\n<MRGas02 dt:dt=\"r4\" desc=\"Meter02 gas flow\">0</MRGas02>\r\n<MREnergy02 dt:dt=\"r4\" desc=\"Meter02 cur energy\">0</MREnergy02>\r\n<MRMcf02 dt:dt=\"r4\" desc=\"Meter02 MCF\">0</MRMcf02>\r\n<MRMmbtu02 dt:dt=\"r4\" desc=\"Meter02 MMBTU\">0</MRMmbtu02>\r\n<MRGas03 dt:dt=\"r4\" desc=\"Meter03 gas flow\">717.4448</MRGas03>\r\n<MREnergy03 dt:dt=\"r4\" desc=\"Meter03 cur energy\">627.6673</MREnergy03>\r\n<MRMcf03 dt:dt=\"r4\" desc=\"Meter03 MCF\">119.1879</MRMcf03>\r\n<MRMmbtu03 dt:dt=\"r4\" desc=\"Meter03 MMBTU\">104.2737</MRMmbtu03>\r\n<PIRawAcc01 dt:dt=\"i4\" desc=\"PI01 raw acc\">352584450</PIRawAcc01>\r\n<PIRate01 dt:dt=\"r4\" desc=\"PI01 rate\">0</PIRate01>\r\n<PItotal01 dt:dt=\"r4\" desc=\"PI01 total\">3.082857E-44</PItotal01>\r\n<AO00 dt:dt=\"r4\" desc=\"AO00 value\">3.222986E-44</AO00>\r\n<TDO00 dt:dt=\"r4\" desc=\"TDO00 EU\">3.363116E-44</TDO00>\r\n<UISCMDPRMS>DGORD=0;DGTYPE=BasicPoll;</UISCMDPRMS>\r\n<UISCMDTYPE>DG_F_DEV</UISCMDTYPE>\r\n</dgData>\r\n"
  }
}