POST api/Administration.Users/Filter

POST api/Administration/Users/Filter Administration All Services

Gets all users that match the paramters in the filter body

Request Information

Headers

Fields	Type	M/O/C	Definition
AccountLoginName	String(50)	Mandatory	Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword	String(50)	Mandatory	Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID	String(50)	Mandatory	Name or ID of application or system that initiated the call.
DomainID	String(50)	Mandatory	Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept	String	Optional	Format in which client expects the response: [application/json] (default), [application/xml]
ContentType	String	Optional	Format in which client is sending the request: [application/json] (default), [application/xml]

Parameters

Name

Description

Additional information

Type

userFilter

Filter body

Define this parameter in the request body.

UserFilterModel

UserFilterModel:

PropertyName	Type	Required
Name	String	Optional
LoginName	String	Optional
EmployeeID	String	Optional
Email	String	Optional
IsActive	Nullable<Boolean>	Optional
OrganizationIDs	IEnumerable<Int32>	Optional
LocationIDs	IEnumerable<Int32>	Optional
JobRoleIDs	IEnumerable<Int32>	Optional
EquipmentIDs	IEnumerable<Int32>	Optional
ContractIDs	IEnumerable<Int32>	Optional
UserRoleID	Int32	Optional
UserGroupID	Int32	Optional
IncludeSubGroups	Boolean	Optional
ExcludeUserIDs	IEnumerable<Int32>	Optional
UserIDs	IEnumerable<Int32>	Optional
IsForManager	Boolean	Optional
OrganizationLocationID	Int32	Optional
ExcludeUserGroupID	Int32	Optional
ExpiryDateFrom	Nullable<DateTime>	Optional
ExpiryDateTo	Nullable<DateTime>	Optional

Request body formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "LoginName": "sample string 2",
  "EmployeeID": "sample string 3",
  "Email": "sample string 4",
  "IsActive": true,
  "OrganizationIDs": [
    1,
    2,
    3
  ],
  "LocationIDs": [
    1,
    2,
    3
  ],
  "JobRoleIDs": [
    1,
    2,
    3
  ],
  "EquipmentIDs": [
    1,
    2,
    3
  ],
  "ContractIDs": [
    1,
    2,
    3
  ],
  "UserRoleID": 5,
  "UserGroupID": 6,
  "IncludeSubGroups": true,
  "ExcludeUserIDs": [
    1,
    2,
    3
  ],
  "UserIDs": [
    1,
    2,
    3
  ],
  "IsForManager": true,
  "OrganizationLocationID": 9,
  "ExcludeUserGroupID": 10,
  "ExpiryDateFrom": "2025-07-01T12:30:24.3852422+00:00",
  "ExpiryDateTo": "2025-07-01T12:30:24.3852422+00:00"
}

application/xml, text/xml

Sample:

<UserFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.Administration">
  <ContractIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ContractIDs>
  <Email>sample string 4</Email>
  <EmployeeID>sample string 3</EmployeeID>
  <EquipmentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </EquipmentIDs>
  <ExcludeUserGroupID>10</ExcludeUserGroupID>
  <ExcludeUserIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ExcludeUserIDs>
  <ExpiryDateFrom>2025-07-01T12:30:24.3852422+00:00</ExpiryDateFrom>
  <ExpiryDateTo>2025-07-01T12:30:24.3852422+00:00</ExpiryDateTo>
  <IncludeSubGroups>true</IncludeSubGroups>
  <IsActive>true</IsActive>
  <IsForManager>true</IsForManager>
  <JobRoleIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </JobRoleIDs>
  <LocationIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </LocationIDs>
  <LoginName>sample string 2</LoginName>
  <Name>sample string 1</Name>
  <OrganizationIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </OrganizationIDs>
  <OrganizationLocationID>9</OrganizationLocationID>
  <UserGroupID>6</UserGroupID>
  <UserIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </UserIDs>
  <UserRoleID>5</UserRoleID>
</UserFilterModel>

Return Type

Return type

UserDTO[]

UserDTO:

PropertyName	Type	Required	Description
LoginName	String	Mandatory	Maximum length: 50 chars
Password	String	Conditional	Maximum length: 50 chars
FirstName	String	Conditional	Maximum length: 50 chars
MiddleName	String	Optional	Maximum length: 50 chars
LastName	String	Conditional	Maximum length: 50 chars
Email	String	Conditional	Maximum length: 50 chars
ExpiryDate	String	Optional	For modification, passing empty string will remove previous value of user's ExpiryDateIf null, previous value will not be overwritten.Input value should follow ISO 8601 standard.
EmployeeID	String	Optional	Maximum length: 50 chars
Citizenship	String	Optional	Maximum length: 50 chars
DateOfBirth	Nullable<DateTime>	Optional
EmploymentDate	Nullable<DateTime>	Optional
Company	String	Optional	Maximum length: 100 chars
Department	String	Optional	Maximum length: 100 chars
Title	String	Optional	Maximum length: 50 chars
Notes	String	Optional
PhoneNumber	String	Optional	Maximum length: 50 chars
WorkPhoneNumber	String	Optional	Maximum length: 50 chars
FaxNumber	String	Optional	Maximum length: 50 chars
Address	String	Optional	Maximum length: 256 chars
Address2	String	Optional	Maximum length: 256 chars
City	String	Optional	Maximum length: 50 chars
ProvinceOrState	String	Optional	Maximum length: 50 chars
PostalCode	String	Optional	Maximum length: 50 chars
Country	String	Optional	Maximum length: 2 chars
PlaceOfBirth	String	Optional	Maximum length: 100 chars
Gender	Nullable<Byte>	Optional
DomainID	Int32	Optional
NewLoginName	String	Optional	Maximum length: 50 chars
IsFMS	Nullable<Boolean>	Optional
IsSSO	Boolean	Optional
CostCenter	String	Optional	Maximum length: 50 chars
UserID	Int32	Optional
SetAzureB2cId	Boolean	Conditional	Default=false. If true, will update value passed into AzureB2cId.
AzureB2cId	Nullable<Guid>	Conditional	When modifying this field, SetAzureB2cId needs to be true.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "LoginName": "sample string 1",
    "Password": "sample string 2",
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "ExpiryDate": "sample string 7",
    "EmployeeID": "sample string 8",
    "Citizenship": "sample string 9",
    "DateOfBirth": "2025-07-01T12:30:25.1555086+00:00",
    "EmploymentDate": "2025-07-01T12:30:25.1555086+00:00",
    "Company": "sample string 10",
    "Department": "sample string 11",
    "Title": "sample string 12",
    "Notes": "sample string 13",
    "PhoneNumber": "sample string 14",
    "WorkPhoneNumber": "sample string 15",
    "FaxNumber": "sample string 16",
    "Address": "sample string 17",
    "Address2": "sample string 18",
    "City": "sample string 19",
    "ProvinceOrState": "sample string 20",
    "PostalCode": "sample string 21",
    "Country": "sample string 22",
    "PlaceOfBirth": "sample string 23",
    "Gender": 64,
    "DomainID": 24,
    "NewLoginName": "sample string 25",
    "IsFMS": true,
    "IsSSO": true,
    "CostCenter": "sample string 27",
    "UserID": 28,
    "SetAzureB2cId": true,
    "AzureB2cId": "82503051-75da-44a1-af27-b3df534a3851"
  },
  {
    "LoginName": "sample string 1",
    "Password": "sample string 2",
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "ExpiryDate": "sample string 7",
    "EmployeeID": "sample string 8",
    "Citizenship": "sample string 9",
    "DateOfBirth": "2025-07-01T12:30:25.1555086+00:00",
    "EmploymentDate": "2025-07-01T12:30:25.1555086+00:00",
    "Company": "sample string 10",
    "Department": "sample string 11",
    "Title": "sample string 12",
    "Notes": "sample string 13",
    "PhoneNumber": "sample string 14",
    "WorkPhoneNumber": "sample string 15",
    "FaxNumber": "sample string 16",
    "Address": "sample string 17",
    "Address2": "sample string 18",
    "City": "sample string 19",
    "ProvinceOrState": "sample string 20",
    "PostalCode": "sample string 21",
    "Country": "sample string 22",
    "PlaceOfBirth": "sample string 23",
    "Gender": 64,
    "DomainID": 24,
    "NewLoginName": "sample string 25",
    "IsFMS": true,
    "IsSSO": true,
    "CostCenter": "sample string 27",
    "UserID": 28,
    "SetAzureB2cId": true,
    "AzureB2cId": "82503051-75da-44a1-af27-b3df534a3851"
  },
  {
    "LoginName": "sample string 1",
    "Password": "sample string 2",
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "ExpiryDate": "sample string 7",
    "EmployeeID": "sample string 8",
    "Citizenship": "sample string 9",
    "DateOfBirth": "2025-07-01T12:30:25.1555086+00:00",
    "EmploymentDate": "2025-07-01T12:30:25.1555086+00:00",
    "Company": "sample string 10",
    "Department": "sample string 11",
    "Title": "sample string 12",
    "Notes": "sample string 13",
    "PhoneNumber": "sample string 14",
    "WorkPhoneNumber": "sample string 15",
    "FaxNumber": "sample string 16",
    "Address": "sample string 17",
    "Address2": "sample string 18",
    "City": "sample string 19",
    "ProvinceOrState": "sample string 20",
    "PostalCode": "sample string 21",
    "Country": "sample string 22",
    "PlaceOfBirth": "sample string 23",
    "Gender": 64,
    "DomainID": 24,
    "NewLoginName": "sample string 25",
    "IsFMS": true,
    "IsSSO": true,
    "CostCenter": "sample string 27",
    "UserID": 28,
    "SetAzureB2cId": true,
    "AzureB2cId": "82503051-75da-44a1-af27-b3df534a3851"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.Administration">
  <UserDTO>
    <Address>sample string 17</Address>
    <Address2>sample string 18</Address2>
    <AzureB2cId>82503051-75da-44a1-af27-b3df534a3851</AzureB2cId>
    <Citizenship>sample string 9</Citizenship>
    <City>sample string 19</City>
    <Company>sample string 10</Company>
    <CostCenter>sample string 27</CostCenter>
    <Country>sample string 22</Country>
    <DateOfBirth>2025-07-01T12:30:25.1555086+00:00</DateOfBirth>
    <Department>sample string 11</Department>
    <DomainID>24</DomainID>
    <Email>sample string 6</Email>
    <EmployeeID>sample string 8</EmployeeID>
    <EmploymentDate>2025-07-01T12:30:25.1555086+00:00</EmploymentDate>
    <ExpiryDate>sample string 7</ExpiryDate>
    <FaxNumber>sample string 16</FaxNumber>
    <FirstName>sample string 3</FirstName>
    <Gender>64</Gender>
    <IsFMS>true</IsFMS>
    <IsSSO>true</IsSSO>
    <LastName>sample string 5</LastName>
    <LoginName>sample string 1</LoginName>
    <MiddleName>sample string 4</MiddleName>
    <NewLoginName>sample string 25</NewLoginName>
    <Notes>sample string 13</Notes>
    <Password>sample string 2</Password>
    <PhoneNumber>sample string 14</PhoneNumber>
    <PlaceOfBirth>sample string 23</PlaceOfBirth>
    <PostalCode>sample string 21</PostalCode>
    <ProvinceOrState>sample string 20</ProvinceOrState>
    <SetAzureB2cId>true</SetAzureB2cId>
    <Title>sample string 12</Title>
    <WorkPhoneNumber>sample string 15</WorkPhoneNumber>
  </UserDTO>
  <UserDTO>
    <Address>sample string 17</Address>
    <Address2>sample string 18</Address2>
    <AzureB2cId>82503051-75da-44a1-af27-b3df534a3851</AzureB2cId>
    <Citizenship>sample string 9</Citizenship>
    <City>sample string 19</City>
    <Company>sample string 10</Company>
    <CostCenter>sample string 27</CostCenter>
    <Country>sample string 22</Country>
    <DateOfBirth>2025-07-01T12:30:25.1555086+00:00</DateOfBirth>
    <Department>sample string 11</Department>
    <DomainID>24</DomainID>
    <Email>sample string 6</Email>
    <EmployeeID>sample string 8</EmployeeID>
    <EmploymentDate>2025-07-01T12:30:25.1555086+00:00</EmploymentDate>
    <ExpiryDate>sample string 7</ExpiryDate>
    <FaxNumber>sample string 16</FaxNumber>
    <FirstName>sample string 3</FirstName>
    <Gender>64</Gender>
    <IsFMS>true</IsFMS>
    <IsSSO>true</IsSSO>
    <LastName>sample string 5</LastName>
    <LoginName>sample string 1</LoginName>
    <MiddleName>sample string 4</MiddleName>
    <NewLoginName>sample string 25</NewLoginName>
    <Notes>sample string 13</Notes>
    <Password>sample string 2</Password>
    <PhoneNumber>sample string 14</PhoneNumber>
    <PlaceOfBirth>sample string 23</PlaceOfBirth>
    <PostalCode>sample string 21</PostalCode>
    <ProvinceOrState>sample string 20</ProvinceOrState>
    <SetAzureB2cId>true</SetAzureB2cId>
    <Title>sample string 12</Title>
    <WorkPhoneNumber>sample string 15</WorkPhoneNumber>
  </UserDTO>
  <UserDTO>
    <Address>sample string 17</Address>
    <Address2>sample string 18</Address2>
    <AzureB2cId>82503051-75da-44a1-af27-b3df534a3851</AzureB2cId>
    <Citizenship>sample string 9</Citizenship>
    <City>sample string 19</City>
    <Company>sample string 10</Company>
    <CostCenter>sample string 27</CostCenter>
    <Country>sample string 22</Country>
    <DateOfBirth>2025-07-01T12:30:25.1555086+00:00</DateOfBirth>
    <Department>sample string 11</Department>
    <DomainID>24</DomainID>
    <Email>sample string 6</Email>
    <EmployeeID>sample string 8</EmployeeID>
    <EmploymentDate>2025-07-01T12:30:25.1555086+00:00</EmploymentDate>
    <ExpiryDate>sample string 7</ExpiryDate>
    <FaxNumber>sample string 16</FaxNumber>
    <FirstName>sample string 3</FirstName>
    <Gender>64</Gender>
    <IsFMS>true</IsFMS>
    <IsSSO>true</IsSSO>
    <LastName>sample string 5</LastName>
    <LoginName>sample string 1</LoginName>
    <MiddleName>sample string 4</MiddleName>
    <NewLoginName>sample string 25</NewLoginName>
    <Notes>sample string 13</Notes>
    <Password>sample string 2</Password>
    <PhoneNumber>sample string 14</PhoneNumber>
    <PlaceOfBirth>sample string 23</PlaceOfBirth>
    <PostalCode>sample string 21</PostalCode>
    <ProvinceOrState>sample string 20</ProvinceOrState>
    <SetAzureB2cId>true</SetAzureB2cId>
    <Title>sample string 12</Title>
    <WorkPhoneNumber>sample string 15</WorkPhoneNumber>
  </UserDTO>
</ArrayOfUserDTO>