PUT api/secUserSettings/{id}
Update an existing record from the Users table.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
UserSettings| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
Required |
|
| PersonID | integer |
Required |
|
| LastName | string |
Required |
|
| FirstName | string |
None. |
|
| Login | string |
Required Max length: 100 |
|
| DefaultWarehouseID | byte |
Required |
|
| HomeWarehouseID | byte |
Required |
|
| Initials | string |
Max length: 6 |
|
| Tag | string |
Max length: 20 |
|
| IsActive | boolean |
None. |
|
| OldPassword | string |
None. |
|
| Password | string |
Max length: 20 |
|
| ConfirmPassword | string |
None. |
|
| NewPassword | boolean |
None. |
|
| ByUser | boolean |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | integer |
None. |
|
| UpdatedDate | date |
None. |
|
| UpdatedBy | integer |
None. |
|
| PersonName | string |
None. |
|
| Entities | Collection of secUserEntity |
None. |
|
| ExternalReferenceID | string |
None. |
|
| results | Collection of ValidationResult |
None. |
Request Formats
application/json, text/json
Sample:
{
"results": null,
"UserID": 1,
"PersonID": 2,
"LastName": "sample string 3",
"FirstName": "sample string 4",
"Login": "sample string 5",
"DefaultWarehouseID": 64,
"HomeWarehouseID": 64,
"Initials": "sample string 8",
"Tag": "sample string 9",
"IsActive": true,
"OldPassword": "sample string 11",
"Password": "sample string 12",
"ConfirmPassword": "sample string 13",
"NewPassword": true,
"ByUser": true,
"CreatedDate": "2025-12-06T23:39:54.4933177+00:00",
"CreatedBy": 17,
"UpdatedDate": "2025-12-06T23:39:54.4933177+00:00",
"UpdatedBy": 19,
"PersonName": "sample string 20",
"Entities": [
{
"EntityUserID": 1,
"EntityID": 2,
"EntityName": "sample string 3",
"Title": "sample string 4",
"IsDefaultForUser": true,
"IsActive": true
},
{
"EntityUserID": 1,
"EntityID": 2,
"EntityName": "sample string 3",
"Title": "sample string 4",
"IsDefaultForUser": true,
"IsActive": true
}
],
"ExternalReferenceID": "sample string 21"
}
application/xml, text/xml
Sample:
<UserSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models">
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
<ByUser>true</ByUser>
<ConfirmPassword>sample string 13</ConfirmPassword>
<CreatedBy>17</CreatedBy>
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:39:54.4933177Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<DefaultWarehouseID>64</DefaultWarehouseID>
<Entities>
<secUserEntity>
<EntityID>2</EntityID>
<EntityName>sample string 3</EntityName>
<EntityUserID>1</EntityUserID>
<IsActive>true</IsActive>
<IsDefaultForUser>true</IsDefaultForUser>
<Title>sample string 4</Title>
</secUserEntity>
<secUserEntity>
<EntityID>2</EntityID>
<EntityName>sample string 3</EntityName>
<EntityUserID>1</EntityUserID>
<IsActive>true</IsActive>
<IsDefaultForUser>true</IsDefaultForUser>
<Title>sample string 4</Title>
</secUserEntity>
</Entities>
<ExternalReferenceID>sample string 21</ExternalReferenceID>
<FirstName>sample string 4</FirstName>
<HomeWarehouseID>64</HomeWarehouseID>
<Initials>sample string 8</Initials>
<IsActive>true</IsActive>
<LastName>sample string 3</LastName>
<Login>sample string 5</Login>
<NewPassword>true</NewPassword>
<OldPassword>sample string 11</OldPassword>
<Password>sample string 12</Password>
<PersonID>2</PersonID>
<PersonName>sample string 20</PersonName>
<Tag>sample string 9</Tag>
<UpdatedBy>19</UpdatedBy>
<UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:39:54.4933177Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
<UserID>1</UserID>
</UserSettings>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
UpsertRetOfUserSettings| Name | Description | Type | Additional information |
|---|---|---|---|
| returnID | integer |
None. |
|
| results | Collection of ValidationResult |
None. |
|
| returnItem | UserSettings |
None. |
|
| displayMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"returnID": 1,
"results": null,
"returnItem": {
"results": null,
"UserID": 1,
"PersonID": 2,
"LastName": "sample string 3",
"FirstName": "sample string 4",
"Login": "sample string 5",
"DefaultWarehouseID": 64,
"HomeWarehouseID": 64,
"Initials": "sample string 8",
"Tag": "sample string 9",
"IsActive": true,
"OldPassword": "sample string 11",
"Password": "sample string 12",
"ConfirmPassword": "sample string 13",
"NewPassword": true,
"ByUser": true,
"CreatedDate": "2025-12-06T23:39:54.4933177+00:00",
"CreatedBy": 17,
"UpdatedDate": "2025-12-06T23:39:54.4933177+00:00",
"UpdatedBy": 19,
"PersonName": "sample string 20",
"Entities": [
{
"EntityUserID": 1,
"EntityID": 2,
"EntityName": "sample string 3",
"Title": "sample string 4",
"IsDefaultForUser": true,
"IsActive": true
},
{
"EntityUserID": 1,
"EntityID": 2,
"EntityName": "sample string 3",
"Title": "sample string 4",
"IsDefaultForUser": true,
"IsActive": true
}
],
"ExternalReferenceID": "sample string 21"
},
"displayMessage": "sample string 1"
}
application/xml, text/xml
Sample:
<UpsertRetOfUserSettings_S0MPMsnQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
<displayMessage>sample string 1</displayMessage>
<results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
<returnID>1</returnID>
<returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models">
<results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
<d2p1:ByUser>true</d2p1:ByUser>
<d2p1:ConfirmPassword>sample string 13</d2p1:ConfirmPassword>
<d2p1:CreatedBy>17</d2p1:CreatedBy>
<d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-06T23:39:54.4933177Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</d2p1:CreatedDate>
<d2p1:DefaultWarehouseID>64</d2p1:DefaultWarehouseID>
<d2p1:Entities>
<d2p1:secUserEntity>
<d2p1:EntityID>2</d2p1:EntityID>
<d2p1:EntityName>sample string 3</d2p1:EntityName>
<d2p1:EntityUserID>1</d2p1:EntityUserID>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsDefaultForUser>true</d2p1:IsDefaultForUser>
<d2p1:Title>sample string 4</d2p1:Title>
</d2p1:secUserEntity>
<d2p1:secUserEntity>
<d2p1:EntityID>2</d2p1:EntityID>
<d2p1:EntityName>sample string 3</d2p1:EntityName>
<d2p1:EntityUserID>1</d2p1:EntityUserID>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsDefaultForUser>true</d2p1:IsDefaultForUser>
<d2p1:Title>sample string 4</d2p1:Title>
</d2p1:secUserEntity>
</d2p1:Entities>
<d2p1:ExternalReferenceID>sample string 21</d2p1:ExternalReferenceID>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:HomeWarehouseID>64</d2p1:HomeWarehouseID>
<d2p1:Initials>sample string 8</d2p1:Initials>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:LastName>sample string 3</d2p1:LastName>
<d2p1:Login>sample string 5</d2p1:Login>
<d2p1:NewPassword>true</d2p1:NewPassword>
<d2p1:OldPassword>sample string 11</d2p1:OldPassword>
<d2p1:Password>sample string 12</d2p1:Password>
<d2p1:PersonID>2</d2p1:PersonID>
<d2p1:PersonName>sample string 20</d2p1:PersonName>
<d2p1:Tag>sample string 9</d2p1:Tag>
<d2p1:UpdatedBy>19</d2p1:UpdatedBy>
<d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-06T23:39:54.4933177Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</d2p1:UpdatedDate>
<d2p1:UserID>1</d2p1:UserID>
</returnItem>
</UpsertRetOfUserSettings_S0MPMsnQ>