PUT api/group/{id}/displaysettings

Edit Display settings for the Group. Primarily shown in the GroupHub e.g. the icon and background image. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The group display settings data contract supplied with the request.

GroupDisplaySettingsDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Description	The description value.	string	None.
Notes	The notes value.	string	None.
GroupIcon	The group icon value.	EnumDataContract	None.
ImageReference	The image reference value.	string	None.
GroupType	The group type value.	EnumDataContract	None.
ExternalProviderTypes	The collection of external provider types.	Collection of EnumDataContract	None.
IsSeparated	Indicates whether this item is separated.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Notes": "sample string 3",
  "GroupIcon": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ImageReference": "sample string 4",
  "GroupType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ExternalProviderTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IsSeparated": true
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.