PUT v1/Users/{id}

Update User

Request Information

URI Parameters

Name	Description	Type	Additional information
id	User Id	integer	Required

Body Parameters

Updated user info

UserDTO

Name	Description	Type	Additional information
Username	User's username	string	String length: inclusive between 0 and 100
Password	User's password	string	String length: inclusive between 0 and 512
AgentId	Agent Id if user is an agent	integer	None.
FirstName		string	String length: inclusive between 0 and 30
LastName		string	String length: inclusive between 0 and 30
CommercialName		string	String length: inclusive between 0 and 500
Email		string	String length: inclusive between 0 and 60
HomePhone		string	String length: inclusive between 0 and 25
MobilePhone		string	String length: inclusive between 0 and 25
WorkPhone		string	String length: inclusive between 0 and 25
GroupMemberships		Collection of string	None.
Id	Primary Id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "CommercialName": "sample string 5",
  "Email": "sample string 6",
  "HomePhone": "sample string 7",
  "MobilePhone": "sample string 8",
  "WorkPhone": "sample string 9",
  "GroupMemberships": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": 10
}

application/xml, text/xml

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>10</Id>
  <AgentId>1</AgentId>
  <CommercialName>sample string 5</CommercialName>
  <Email>sample string 6</Email>
  <FirstName>sample string 3</FirstName>
  <GroupMemberships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GroupMemberships>
  <HomePhone>sample string 7</HomePhone>
  <LastName>sample string 4</LastName>
  <MobilePhone>sample string 8</MobilePhone>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
  <WorkPhone>sample string 9</WorkPhone>
</UserDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserDTO

Name	Description	Type	Additional information
Username	User's username	string	String length: inclusive between 0 and 100
Password	User's password	string	String length: inclusive between 0 and 512
AgentId	Agent Id if user is an agent	integer	None.
FirstName		string	String length: inclusive between 0 and 30
LastName		string	String length: inclusive between 0 and 30
CommercialName		string	String length: inclusive between 0 and 500
Email		string	String length: inclusive between 0 and 60
HomePhone		string	String length: inclusive between 0 and 25
MobilePhone		string	String length: inclusive between 0 and 25
WorkPhone		string	String length: inclusive between 0 and 25
GroupMemberships		Collection of string	None.
Id	Primary Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AgentId": 1,
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "CommercialName": "sample string 5",
  "Email": "sample string 6",
  "HomePhone": "sample string 7",
  "MobilePhone": "sample string 8",
  "WorkPhone": "sample string 9",
  "GroupMemberships": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": 10
}

application/xml, text/xml

Sample:

<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>10</Id>
  <AgentId>1</AgentId>
  <CommercialName>sample string 5</CommercialName>
  <Email>sample string 6</Email>
  <FirstName>sample string 3</FirstName>
  <GroupMemberships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GroupMemberships>
  <HomePhone>sample string 7</HomePhone>
  <LastName>sample string 4</LastName>
  <MobilePhone>sample string 8</MobilePhone>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
  <WorkPhone>sample string 9</WorkPhone>
</UserDTO>