POST usergroup/add

Adds a new user group

Request Information

URI Parameters

None.

Body Parameters

UserGroupAddRequestobject containing the details of the user group

Name	Type	Additional information
Name	string	None.
Description	string	None.
Email	string	None.
Users	Collection of Dictionary of string [key] and Collection of integer [value]	None.
RemovedUsers	Collection of Dictionary of string [key] and Collection of integer [value]	None.
Permissions	Collection of string	None.
Notifications	Collection of NotificationInfo	None.
IsActive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Email": "sample string 3",
  "Users": [
    {
      "sample string 1": [
        1,
        2
      ],
      "sample string 2": [
        1,
        2
      ]
    },
    {
      "sample string 1": [
        1,
        2
      ],
      "sample string 2": [
        1,
        2
      ]
    }
  ],
  "RemovedUsers": [
    {
      "sample string 1": [
        1,
        2
      ],
      "sample string 2": [
        1,
        2
      ]
    },
    {
      "sample string 1": [
        1,
        2
      ],
      "sample string 2": [
        1,
        2
      ]
    }
  ],
  "Permissions": [
    "sample string 1",
    "sample string 2"
  ],
  "Notifications": [
    {
      "Type": "sample string 1",
      "IsInherited": true,
      "IsGroupInherited": true,
      "UserId": 1,
      "UserGroupId": 1,
      "SecurityLevelId": 1,
      "Operation": "sample string 4",
      "SendPush": true,
      "SendEmail": true,
      "NotificationTemplateId": 7,
      "Action": "sample string 8",
      "Scope": 9
    },
    {
      "Type": "sample string 1",
      "IsInherited": true,
      "IsGroupInherited": true,
      "UserId": 1,
      "UserGroupId": 1,
      "SecurityLevelId": 1,
      "Operation": "sample string 4",
      "SendPush": true,
      "SendEmail": true,
      "NotificationTemplateId": 7,
      "Action": "sample string 8",
      "Scope": 9
    }
  ],
  "IsActive": true
}

application/xml, text/xml

Sample:

<UserGroupAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SALT2.Objects.UserObjects">
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/SALT2.Objects">true</IsActive>
  <Description>sample string 2</Description>
  <Email>sample string 3</Email>
  <Name>sample string 1</Name>
  <Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/SALT2.Objects.CommunicationObjects">
    <d2p1:NotificationInfo>
      <d2p1:Action>sample string 8</d2p1:Action>
      <d2p1:IsGroupInherited>true</d2p1:IsGroupInherited>
      <d2p1:IsInherited>true</d2p1:IsInherited>
      <d2p1:NotificationTemplateId>7</d2p1:NotificationTemplateId>
      <d2p1:Operation>sample string 4</d2p1:Operation>
      <d2p1:Scope>9</d2p1:Scope>
      <d2p1:SecurityLevelId>1</d2p1:SecurityLevelId>
      <d2p1:SendEmail>true</d2p1:SendEmail>
      <d2p1:SendPush>true</d2p1:SendPush>
      <d2p1:Type>sample string 1</d2p1:Type>
      <d2p1:UserGroupId>1</d2p1:UserGroupId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:NotificationInfo>
    <d2p1:NotificationInfo>
      <d2p1:Action>sample string 8</d2p1:Action>
      <d2p1:IsGroupInherited>true</d2p1:IsGroupInherited>
      <d2p1:IsInherited>true</d2p1:IsInherited>
      <d2p1:NotificationTemplateId>7</d2p1:NotificationTemplateId>
      <d2p1:Operation>sample string 4</d2p1:Operation>
      <d2p1:Scope>9</d2p1:Scope>
      <d2p1:SecurityLevelId>1</d2p1:SecurityLevelId>
      <d2p1:SendEmail>true</d2p1:SendEmail>
      <d2p1:SendPush>true</d2p1:SendPush>
      <d2p1:Type>sample string 1</d2p1:Type>
      <d2p1:UserGroupId>1</d2p1:UserGroupId>
      <d2p1:UserId>1</d2p1:UserId>
    </d2p1:NotificationInfo>
  </Notifications>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Permissions>
  <RemovedUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    </d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
    <d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    </d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
  </RemovedUsers>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    </d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
    <d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
      <d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
        <d2p1:Key>sample string 2</d2p1:Key>
        <d2p1:Value>
          <d2p1:int>1</d2p1:int>
          <d2p1:int>2</d2p1:int>
        </d2p1:Value>
      </d2p1:KeyValueOfstringArrayOfintty7Ep6D1>
    </d2p1:ArrayOfKeyValueOfstringArrayOfintty7Ep6D1>
  </Users>
</UserGroupAddRequest>

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 'UserGroupAddRequest'.

Response Information

Resource Description

UserGroupAddResponse

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.