POST api/firms/getfirmemployees

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetFirmEmployeesResponse

Name	Description	Type	Additional information
FirmEmployees		Collection of FirmEmployee	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "FirmEmployees": [
    {
      "FirmEmployeeID": 1,
      "IsActive": true,
      "ModifiedOn": "2025-12-05T20:28:24.0592643-08:00",
      "ModifiedBy": 4,
      "CreatedBy": 5,
      "CreatedOn": "2025-12-05T20:28:24.0592643-08:00",
      "FirmID": 7,
      "EmailAddress": "sample string 8",
      "MobileNumber": "sample string 9",
      "ModifiedByName": "sample string 10",
      "CreatedByName": "sample string 11",
      "GenderID": 12,
      "GenderName": "sample string 13",
      "Name": "sample string 14",
      "EmpID": "sample string 15",
      "DOB": "2025-12-05T20:28:24.0592643-08:00",
      "DOJ": "2025-12-05T20:28:24.0592643-08:00",
      "DOR": "2025-12-05T20:28:24.0592643-08:00",
      "LoginID": "sample string 17",
      "Premium": 18.0,
      "SumInsured": 19.0,
      "CTC": 20.0
    },
    {
      "FirmEmployeeID": 1,
      "IsActive": true,
      "ModifiedOn": "2025-12-05T20:28:24.0592643-08:00",
      "ModifiedBy": 4,
      "CreatedBy": 5,
      "CreatedOn": "2025-12-05T20:28:24.0592643-08:00",
      "FirmID": 7,
      "EmailAddress": "sample string 8",
      "MobileNumber": "sample string 9",
      "ModifiedByName": "sample string 10",
      "CreatedByName": "sample string 11",
      "GenderID": 12,
      "GenderName": "sample string 13",
      "Name": "sample string 14",
      "EmpID": "sample string 15",
      "DOB": "2025-12-05T20:28:24.0592643-08:00",
      "DOJ": "2025-12-05T20:28:24.0592643-08:00",
      "DOR": "2025-12-05T20:28:24.0592643-08:00",
      "LoginID": "sample string 17",
      "Premium": 18.0,
      "SumInsured": 19.0,
      "CTC": 20.0
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetFirmEmployeesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms.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>
  <FirmEmployees xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms">
    <d2p1:FirmEmployee>
      <d2p1:CTC>20</d2p1:CTC>
      <d2p1:CreatedBy>5</d2p1:CreatedBy>
      <d2p1:CreatedByName>sample string 11</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:28:24.0592643-08:00</d2p1:CreatedOn>
      <d2p1:DOB>2025-12-05T20:28:24.0592643-08:00</d2p1:DOB>
      <d2p1:DOJ>2025-12-05T20:28:24.0592643-08:00</d2p1:DOJ>
      <d2p1:DOR>2025-12-05T20:28:24.0592643-08:00</d2p1:DOR>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:EmpID>sample string 15</d2p1:EmpID>
      <d2p1:FirmEmployeeID>1</d2p1:FirmEmployeeID>
      <d2p1:FirmID>7</d2p1:FirmID>
      <d2p1:GenderID>12</d2p1:GenderID>
      <d2p1:GenderName>sample string 13</d2p1:GenderName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LoginID>sample string 17</d2p1:LoginID>
      <d2p1:MobileNumber>sample string 9</d2p1:MobileNumber>
      <d2p1:ModifiedBy>4</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 10</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:28:24.0592643-08:00</d2p1:ModifiedOn>
      <d2p1:Name>sample string 14</d2p1:Name>
      <d2p1:Premium>18</d2p1:Premium>
      <d2p1:SumInsured>19</d2p1:SumInsured>
    </d2p1:FirmEmployee>
    <d2p1:FirmEmployee>
      <d2p1:CTC>20</d2p1:CTC>
      <d2p1:CreatedBy>5</d2p1:CreatedBy>
      <d2p1:CreatedByName>sample string 11</d2p1:CreatedByName>
      <d2p1:CreatedOn>2025-12-05T20:28:24.0592643-08:00</d2p1:CreatedOn>
      <d2p1:DOB>2025-12-05T20:28:24.0592643-08:00</d2p1:DOB>
      <d2p1:DOJ>2025-12-05T20:28:24.0592643-08:00</d2p1:DOJ>
      <d2p1:DOR>2025-12-05T20:28:24.0592643-08:00</d2p1:DOR>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:EmpID>sample string 15</d2p1:EmpID>
      <d2p1:FirmEmployeeID>1</d2p1:FirmEmployeeID>
      <d2p1:FirmID>7</d2p1:FirmID>
      <d2p1:GenderID>12</d2p1:GenderID>
      <d2p1:GenderName>sample string 13</d2p1:GenderName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LoginID>sample string 17</d2p1:LoginID>
      <d2p1:MobileNumber>sample string 9</d2p1:MobileNumber>
      <d2p1:ModifiedBy>4</d2p1:ModifiedBy>
      <d2p1:ModifiedByName>sample string 10</d2p1:ModifiedByName>
      <d2p1:ModifiedOn>2025-12-05T20:28:24.0592643-08:00</d2p1:ModifiedOn>
      <d2p1:Name>sample string 14</d2p1:Name>
      <d2p1:Premium>18</d2p1:Premium>
      <d2p1:SumInsured>19</d2p1:SumInsured>
    </d2p1:FirmEmployee>
  </FirmEmployees>
</GetFirmEmployeesResponse>