PUT api/v1/measurement/updateStationGroup/{groupName}?siteService={siteService}

Updates an existing station group in the connected FMS service.

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
groupName	The name of the station group to update	string	Required
siteService	CygNet site and service (Site.Service) of the FMS Service	string	Required

Body Parameters

The request containing the properties of the station group to update.

Name	Description	Type	Additional information
beginActiveDate	[optional] Begin Active Date	date	None
endActiveDate	[optional] End Active Date	date	None
name	[optional] Name of group	string	None
description	[Optional] Group Description	string	None
siteService	[Optional] Group site service	string	None
facilityId	[Optional] Associated Facility ID of the group	string	None
sortPriority	[optional] Sort priority of the group	integer	None
securityApp	[Optional] Security application of the group	string	None
categoryName	[Optional] Category name for the group.	string	None
stationType	[optional] Station type of the group.	StationType	None
stationContribution	[optional] The contribution of the group	StationContribution	None
stationTimezoneKey	[optional] Time zone key	integer	None
stationTimezoneDst	[Optional] Time zone DST	boolean	None
stationContractHour	[optional] Contract hour of the group	byte	None
stationValidationNodeId	[optional] The Node ID of the linked station of the group.	integer	None
stationValidationNodeName	[Optional] The node name of the linked station of the group	string	None
stationBaseSync	[optional] The station base sync bit of the group.	boolean	None
stationBaseTemp	[optional] The station base temperature of the group.	decimal number	None
stationBasePressure	[optional] The station base pressure of the group.	decimal number	None
stationBaseFpvMethod	[optional] The station base FPV method of the group.	FmsCfgCalcMethodFpv	None

Request Formats

application/json, text/json

Sample:

{
  "beginActiveDate": "2000-01-01T00:00:00",
  "endActiveDate": "3000-12-31T00:00:00",
  "name": "StationGroupNode",
  "description": "Test Group",
  "siteService": "CYGNET.UIS",
  "facilityId": "ANTIER_GM",
  "sortPriority": 0,
  "securityApp": "",
  "categoryName": "Job",
  "stationType": "Check",
  "stationContribution": "Receipt",
  "stationTimezoneKey": 29,
  "stationTimezoneDst": false,
  "stationContractHour": 0,
  "stationValidationNodeId": 11,
  "stationValidationNodeName": "node11",
  "stationBaseSync": true,
  "stationBaseTemp": 0.0,
  "stationBasePressure": 0.0,
  "stationBaseFpvMethod": "FpvAGA8Gross1"
}

Response Information

Resource Description

Name	Description	Type	Additional information
nodeId	Node ID of the group	integer	None
fmsSationGroup	Station Group Details	FmsStationGroupDTO	None

Response Formats

application/json, text/json

Sample:

{
  "nodeId": 1,
  "fmsSationGroup": {
    "beginActiveDate": "2000-01-01T00:00:00",
    "endActiveDate": "3000-12-31T00:00:00",
    "name": "StationGroupNode",
    "description": "Test Group",
    "siteService": "CYGNET.UIS",
    "facilityId": "ANTIER_GM",
    "sortPriority": 0,
    "securityApp": "",
    "categoryName": "Job",
    "stationType": "Check",
    "stationContribution": "Receipt",
    "stationTimezoneKey": 29,
    "stationTimezoneDst": false,
    "stationContractHour": 0,
    "stationValidationNodeId": 11,
    "stationValidationNodeName": "node11",
    "stationBaseSync": true,
    "stationBaseTemp": 0.0,
    "stationBasePressure": 0.0,
    "stationBaseFpvMethod": "FpvAGA8Gross1"
  }
}