GET api/secUserSettings?activeOnly={activeOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
activeOnly		boolean	Required

Body Parameters

None.

Response Information

Resource Description

Collection of UserSettings

Name	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.

Response 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:41:26.3136052+00:00",
    "CreatedBy": 17,
    "UpdatedDate": "2025-12-06T23:41:26.3136052+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"
  },
  {
    "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:41:26.3136052+00:00",
    "CreatedBy": 17,
    "UpdatedDate": "2025-12-06T23:41:26.3136052+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:

<ArrayOfUserSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models">
  <UserSettings>
    <results xmlns:d3p1="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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:26.3136052Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:26.3136052Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <UserID>1</UserID>
  </UserSettings>
  <UserSettings>
    <results xmlns:d3p1="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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:26.3136052Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:26.3136052Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <UserID>1</UserID>
  </UserSettings>
</ArrayOfUserSettings>