POST api/users/getusers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IsActive	boolean	None.
UserRoleID	integer	None.
FirmID	integer	None.
Header	RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "IsActive": true,
  "UserRoleID": 1,
  "FirmID": 2,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GetUsersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Users.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <FirmID>2</FirmID>
  <IsActive>true</IsActive>
  <UserRoleID>1</UserRoleID>
</GetUsersRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetUsersResponse

Name	Description	Type	Additional information
Users		Collection of User	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Users": [
    {
      "UserID": 1,
      "EmailID": "sample string 2",
      "IsActive": true,
      "UserRoles": [
        {
          "UserRoleID": 1,
          "UserRoleName": "sample string 2",
          "IsActive": true
        },
        {
          "UserRoleID": 1,
          "UserRoleName": "sample string 2",
          "IsActive": true
        }
      ],
      "MobileNumber": "sample string 4",
      "Name": "sample string 5",
      "CreatedOn": "2025-12-05T20:22:36.1210624-08:00",
      "ModifiedOn": "2025-12-05T20:22:36.1210624-08:00",
      "CreatedByName": "sample string 8",
      "ModifiedByName": "sample string 9"
    },
    {
      "UserID": 1,
      "EmailID": "sample string 2",
      "IsActive": true,
      "UserRoles": [
        {
          "UserRoleID": 1,
          "UserRoleName": "sample string 2",
          "IsActive": true
        },
        {
          "UserRoleID": 1,
          "UserRoleName": "sample string 2",
          "IsActive": true
        }
      ],
      "MobileNumber": "sample string 4",
      "Name": "sample string 5",
      "CreatedOn": "2025-12-05T20:22:36.1210624-08:00",
      "ModifiedOn": "2025-12-05T20:22:36.1210624-08:00",
      "CreatedByName": "sample string 8",
      "ModifiedByName": "sample string 9"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Users.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Users">
    <d2p1:User>
      <d2p1:CreatedByName>sample string 8</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:22:36.1210624-08:00</d2p1:CreatedOn>
      <d2p1:EmailID>sample string 2</d2p1:EmailID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MobileNumber>sample string 4</d2p1:MobileNumber>
      <d2p1:ModifiedByName>sample string 9</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:22:36.1210624-08:00</d2p1:ModifiedOn>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:UserID>1</d2p1:UserID>
      <d2p1:UserRoles>
        <d2p1:UserRole>
          <d2p1:IsActive>true</d2p1:IsActive>
          <d2p1:UserRoleID>1</d2p1:UserRoleID>
          <d2p1:UserRoleName>sample string 2</d2p1:UserRoleName>
        </d2p1:UserRole>
        <d2p1:UserRole>
          <d2p1:IsActive>true</d2p1:IsActive>
          <d2p1:UserRoleID>1</d2p1:UserRoleID>
          <d2p1:UserRoleName>sample string 2</d2p1:UserRoleName>
        </d2p1:UserRole>
      </d2p1:UserRoles>
    </d2p1:User>
    <d2p1:User>
      <d2p1:CreatedByName>sample string 8</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:22:36.1210624-08:00</d2p1:CreatedOn>
      <d2p1:EmailID>sample string 2</d2p1:EmailID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MobileNumber>sample string 4</d2p1:MobileNumber>
      <d2p1:ModifiedByName>sample string 9</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:22:36.1210624-08:00</d2p1:ModifiedOn>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:UserID>1</d2p1:UserID>
      <d2p1:UserRoles>
        <d2p1:UserRole>
          <d2p1:IsActive>true</d2p1:IsActive>
          <d2p1:UserRoleID>1</d2p1:UserRoleID>
          <d2p1:UserRoleName>sample string 2</d2p1:UserRoleName>
        </d2p1:UserRole>
        <d2p1:UserRole>
          <d2p1:IsActive>true</d2p1:IsActive>
          <d2p1:UserRoleID>1</d2p1:UserRoleID>
          <d2p1:UserRoleName>sample string 2</d2p1:UserRoleName>
        </d2p1:UserRole>
      </d2p1:UserRoles>
    </d2p1:User>
  </Users>
</GetUsersResponse>