PUT v1/Clients/{clientId}/Security/UserAccounts

Updates the specified user account.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier.	globally unique identifier	Required

Body Parameters

The user account.

UserAccountV1

Name	Description	Type	Additional information
UserId	Gets or sets User Id.	integer	None.
RoleId	Gets or sets Role Id.	integer	None.
UserName	Gets or sets User Name.	string	None.
Password	Gets or sets Password.	string	None.
FullName	Gets or sets Full Name.	string	None.
Company	Gets or sets Company.	string	None.
Department	Gets or sets Company.	string	None.
TimeZoneId	Gets or sets TimeZoneId.	integer	None.
LanguageId	Gets or sets the language setting for the user.	integer	None.
Notes	Gets or sets Notes.	string	None.
Address	Gets or sets Address.	string	None.
City	Gets or sets City.	string	None.
StateProvince	Gets or sets StateProvince.	string	None.
CountyId	Gets or sets County id.	integer	None.
PostalCode	Gets or sets PostalCode.	string	None.
PhoneNumber	Gets or sets PhoneNumber.	string	None.
Mobile	Gets or sets Mobile.	string	None.
Email	Gets or sets Email.	string	None.
RestrictFacilities	Gets or sets a value indicating whether RestrictFacilities.	boolean	None.
RestrictAllowFacilities	Gets or sets RestrictedFacilities.	Collection of integer	None.
AllowedFacilityGroups	Gets or sets Allowed Facility Groups.	Collection of integer	None.
DeniedFacilityGroups	Gets or sets Denied Facility Groups.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "RoleId": 2,
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "FullName": "sample string 5",
  "Company": "sample string 6",
  "Department": "sample string 7",
  "TimeZoneId": 8,
  "LanguageId": 9,
  "Notes": "sample string 10",
  "Address": "sample string 11",
  "City": "sample string 12",
  "StateProvince": "sample string 13",
  "CountyId": 1,
  "PostalCode": "sample string 14",
  "PhoneNumber": "sample string 15",
  "Mobile": "sample string 16",
  "Email": "sample string 17",
  "RestrictFacilities": true,
  "RestrictAllowFacilities": [
    1,
    2
  ],
  "AllowedFacilityGroups": [
    1,
    2
  ],
  "DeniedFacilityGroups": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<UserAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.Security">
  <Address>sample string 11</Address>
  <AllowedFacilityGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AllowedFacilityGroups>
  <City>sample string 12</City>
  <Company>sample string 6</Company>
  <CountyId>1</CountyId>
  <DeniedFacilityGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DeniedFacilityGroups>
  <Department>sample string 7</Department>
  <Email>sample string 17</Email>
  <FullName>sample string 5</FullName>
  <LanguageId>9</LanguageId>
  <Mobile>sample string 16</Mobile>
  <Notes>sample string 10</Notes>
  <Password>sample string 4</Password>
  <PhoneNumber>sample string 15</PhoneNumber>
  <PostalCode>sample string 14</PostalCode>
  <RestrictAllowFacilities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RestrictAllowFacilities>
  <RestrictFacilities>true</RestrictFacilities>
  <RoleId>2</RoleId>
  <StateProvince>sample string 13</StateProvince>
  <TimeZoneId>8</TimeZoneId>
  <UserId>1</UserId>
  <UserName>sample string 3</UserName>
</UserAccount>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A .

OperationStatusV1

Name	Description	Type	Additional information
Success	A value indicating whether the operation was successful.	boolean	None.
Error	The error message associated with the operation when Success is false.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Error": ""
}

application/xml, text/xml

Sample:

<OperationStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
  <Error></Error>
  <Success>true</Success>
</OperationStatus>