PUT api/UserGroups/{id}
Update User Group specified by 'id'. NOTE: Updates overwrite all properties within the given User Group, be sure to include all User Group fields even if they are not being updated for the specified record.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
User Group ID |
integer |
Required |
Body Parameters
UserGroup data object with which to update the specified record
UserGroupName | Description | Type | Additional information |
---|---|---|---|
ID |
User Group Identifier |
integer |
None. |
ParentID |
(optional) Identifier of parent group, default is 0 (no parent) |
integer |
None. |
Title |
Human-readable title of the User Group |
string |
Required |
Address1 |
Physical street address of the User Group's headquarters |
string |
None. |
Address2 |
Secondary physical address information, i.e. Suite / Office # |
string |
None. |
City |
City in which the User Group's headquarters reside |
string |
None. |
State |
State in which the User Group's headquarters reside |
string |
None. |
Zip |
Zip code in which the User Group's headquarters reside |
string |
None. |
Primary contact email for the User Group |
string |
None. |
|
Phone |
Primary contact phone number for the User Group |
string |
None. |
Request Formats
application/json, text/json
{ "ID": 1, "ParentID": 2, "Title": "sample string 3", "Address1": "sample string 4", "Address2": "sample string 5", "City": "sample string 6", "State": "sample string 7", "Zip": "sample string 8", "Email": "sample string 9", "Phone": "sample string 10" }
application/xml, text/xml
<UserGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TGTWebServices.Models.TGTAdmin"> <Address1>sample string 4</Address1> <Address2>sample string 5</Address2> <City>sample string 6</City> <Email>sample string 9</Email> <ID>1</ID> <ParentID>2</ParentID> <Phone>sample string 10</Phone> <State>sample string 7</State> <Title>sample string 3</Title> <Zip>sample string 8</Zip> </UserGroup>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
204 on success
None.