PUT OneStop/Groups/{GroupID}/Users

Updates the specified user

Request Information

URI Parameters

Name	Description	Type	Additional information
GroupID	Update user in specified group	integer	Required

Body Parameters

Details of user to update

UserDTO

Name	Description	Type	Additional information
UserID	Auto generated	integer	Required
UserName	User name	string	None.
Description	Description of user	string	None.
Password	Password. Plain text if being set. This value is never returned	string	None.
GroupID	Group ID user exists in	integer	Required
TimeOut	Session Timeout in minutes	integer	None.
EmailAddress	Email Address	string	None.
FullName	Full Name	string	None.
Address1	Address Line 1	string	None.
Address2	Address Line 2	string	None.
Address3	Address Line 3	string	None.
PostCode	Postcode	string	None.
Phone	Phone number	string	None.
Private	Whether user can be seen by users in parent groups	boolean	None.
Comments	Comments about a user	string	None.
AllowLogon	Whether a user can log in.	boolean	None.
ExportReportAccessLevel	Report access level System = 1,NSO / Dealer =2, User = 3	integer	None.
DefaultHomePage	Users default home page Dashboard = 1,Devices = 2,Reports = 3, Exports = 4, GroupSettings = 5	integer	None.
SecurityProfileID	SecurityProfileID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "UserName": "sample string 2",
  "Description": "sample string 3",
  "Password": "sample string 4",
  "GroupID": 1,
  "TimeOut": 1,
  "EmailAddress": "sample string 5",
  "FullName": "sample string 6",
  "Address1": "sample string 7",
  "Address2": "sample string 8",
  "Address3": "sample string 9",
  "PostCode": "sample string 10",
  "Phone": "sample string 11",
  "Private": true,
  "Comments": "sample string 12",
  "AllowLogon": true,
  "ExportReportAccessLevel": 1,
  "DefaultHomePage": 1,
  "SecurityProfileID": 1
}

application/xml, text/xml

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <Address1>sample string 7</Address1>
  <Address2>sample string 8</Address2>
  <Address3>sample string 9</Address3>
  <AllowLogon>true</AllowLogon>
  <Comments>sample string 12</Comments>
  <DefaultHomePage>1</DefaultHomePage>
  <Description>sample string 3</Description>
  <EmailAddress>sample string 5</EmailAddress>
  <ExportReportAccessLevel>1</ExportReportAccessLevel>
  <FullName>sample string 6</FullName>
  <GroupID>1</GroupID>
  <Password>sample string 4</Password>
  <Phone>sample string 11</Phone>
  <PostCode>sample string 10</PostCode>
  <Private>true</Private>
  <SecurityProfileID>1</SecurityProfileID>
  <TimeOut>1</TimeOut>
  <UserID>1</UserID>
  <UserName>sample string 2</UserName>
</UserDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserSummaryDTO

Name	Description	Type	Additional information
UserID	Auto generated	integer	None.
UserName	User name	string	Required
Password	Password. Plain text if being set. This value is never returned	string	None.
Description	Description of user	string	None.
EmailAddress	Description of user	string	None.
GroupID	Group ID user exists in	integer	Required
FullName	Full Name	string	None.
Address1	Address Line 1	string	None.
Address2	Address Line 2	string	None.
Address3	Address Line 3	string	None.
PostCode	Postcode	string	None.
Phone	Phone number	string	None.

Response Formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "UserName": "sample string 2",
  "Password": "sample string 3",
  "Description": "sample string 4",
  "EmailAddress": "sample string 5",
  "GroupID": 6,
  "FullName": "sample string 7",
  "Address1": "sample string 8",
  "Address2": "sample string 9",
  "Address3": "sample string 10",
  "PostCode": "sample string 11",
  "Phone": "sample string 12"
}

application/xml, text/xml

Sample:

<UserSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <Address1>sample string 8</Address1>
  <Address2>sample string 9</Address2>
  <Address3>sample string 10</Address3>
  <Description>sample string 4</Description>
  <EmailAddress>sample string 5</EmailAddress>
  <FullName>sample string 7</FullName>
  <GroupID>6</GroupID>
  <Password>sample string 3</Password>
  <Phone>sample string 12</Phone>
  <PostCode>sample string 11</PostCode>
  <UserID>1</UserID>
  <UserName>sample string 2</UserName>
</UserSummaryDTO>