POST api/v1/devices/datagroups/sendTransactions

Sends data group transaction data to a device

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	The device ID to retrieve a datagroup property for	string	Required
dataGroupType	The data group type	string	Required
dataGroupOrdinal	The data group ordinal	integer	Required
dataGroupTransactionData	The data group transaction data	string	Required
fromDeviceParameters	Parameters that may be required when getting from the device; usually an empty string is passed	string	None
toDeviceParameters	Parameters that may be required when sending to the device; usually an empty string is passed	string	None
maxWaitInMs	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": "ANTIER_RD",
  "dataGroupType": "AGAParams",
  "dataGroupOrdinal": 1,
  "dataGroupTransactionData": "<dgData><nButane>12</nButane><nPentane>13</nPentane></dgData>",
  "fromDeviceParameters": "",
  "toDeviceParameters": "",
  "maxWaitInMs": 60000
}

Response Information

Resource Description

Name	Description	Type	Additional information
transactionHeader	Data group transaction header	DataGroupTransactionHeaderDTO	None

Response Formats

application/json, text/json

Sample:

{
  "transactionHeader": {
    "deviceId": "EM107",
    "facilityId": "EM107",
    "dataGroupType": "AGAParams",
    "dataGroupOrdinal": 1,
    "dataBaseKey": "0000000123B0000001C0000029",
    "timestamp": "2019-04-25T09:17:07",
    "type": "Send",
    "userId": "domain\\john.user",
    "statusCode": "Succeeded",
    "statusMessage": "Succeeded",
    "majorVersion": 2,
    "minorVersion": 2,
    "dataSize": 146,
    "headerSize": 146,
    "indexItem": "",
    "appDefined1": 0,
    "appDefined2": 0,
    "appDefined3": 0,
    "appDefined4": 0,
    "hasPartialData": false,
    "compressSize": 0,
    "blobCount": 0
  }
}