PUT api/group/{id}/displaysettings

Edit Display settings for the Group. Primarily shown in the GroupHub e.g. the icon and background image.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Group.Query.DisplaySettings.GroupDisplaySettingsDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

Notes

string

None.

GroupIcon

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ImageReference

string

None.

GroupType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ExternalProviderTypes

Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

IsSeparated

boolean

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GroupDisplaySettingsDataContract'.

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

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.