PUT OneStop/Groups/{GroupID}

Update the specified group

Request Information

URI Parameters

Name	Description	Type	Additional information
GroupID	Group ID to update	integer	Required

Body Parameters

Group information to update

GroupDetailDTO

Name	Description	Type	Additional information
GroupID	Auto generated	integer	None.
GroupName	Name of group	string	Required
GroupPath	Dot seperated path, starting from system group. example 0.5.19	string	Read Only
Description	Description of group	string	None.
IgnoreSystemAvailability	Whether system availability settings are taken into consideration when calculating device availability	boolean	None.
CustomField_1	A custom field that can be used to hold any string value	string	None.
CustomField_2	A custom field that can be used to hold any string value	string	None.
IsSystemGroup		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "GroupID": 1,
  "GroupName": "sample string 2",
  "GroupPath": null,
  "Description": "sample string 3",
  "IgnoreSystemAvailability": true,
  "CustomField_1": "sample string 4",
  "CustomField_2": "sample string 5",
  "IsSystemGroup": true
}

application/xml, text/xml

Sample:

<GroupDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <CustomField_1>sample string 4</CustomField_1>
  <CustomField_2>sample string 5</CustomField_2>
  <Description>sample string 3</Description>
  <GroupID>1</GroupID>
  <GroupName>sample string 2</GroupName>
  <IgnoreSystemAvailability>true</IgnoreSystemAvailability>
  <IsSystemGroup>true</IsSystemGroup>
</GroupDetailDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GroupDetailDTO

Name	Description	Type	Additional information
GroupID	Auto generated	integer	None.
GroupName	Name of group	string	Required
GroupPath	Dot seperated path, starting from system group. example 0.5.19	string	Read Only
Description	Description of group	string	None.
IgnoreSystemAvailability	Whether system availability settings are taken into consideration when calculating device availability	boolean	None.
CustomField_1	A custom field that can be used to hold any string value	string	None.
CustomField_2	A custom field that can be used to hold any string value	string	None.
IsSystemGroup		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "GroupID": 1,
  "GroupName": "sample string 2",
  "GroupPath": null,
  "Description": "sample string 3",
  "IgnoreSystemAvailability": true,
  "CustomField_1": "sample string 4",
  "CustomField_2": "sample string 5",
  "IsSystemGroup": true
}

application/xml, text/xml

Sample:

<GroupDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <CustomField_1>sample string 4</CustomField_1>
  <CustomField_2>sample string 5</CustomField_2>
  <Description>sample string 3</Description>
  <GroupID>1</GroupID>
  <GroupName>sample string 2</GroupName>
  <IgnoreSystemAvailability>true</IgnoreSystemAvailability>
  <IsSystemGroup>true</IsSystemGroup>
</GroupDetailDTO>