POST api/policies/getpolicyemployeedependents

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirmID	integer	None.
FirmEmployeeID	integer	None.
PolicyID	integer	None.
Header	RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "FirmID": 1,
  "FirmEmployeeID": 2,
  "PolicyID": 3,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GetPolicyEmployeeDependentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <FirmEmployeeID>2</FirmEmployeeID>
  <FirmID>1</FirmID>
  <PolicyID>3</PolicyID>
</GetPolicyEmployeeDependentsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyEmployeeDependentsResponse

Name	Description	Type	Additional information
Dependents		Collection of PolicyFirmEmployeeDependent	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Dependents": [
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeDependentID": 2,
      "FirmEmployeeDependentID": 3,
      "IsActive": true,
      "StatusID": 5,
      "Policies": [
        "sample string 1",
        "sample string 2"
      ],
      "StatusName": "sample string 6",
      "Name": "sample string 7",
      "RelationshipName": "sample string 8",
      "DOB": "2026-02-23T09:27:04.8442712-08:00"
    },
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeDependentID": 2,
      "FirmEmployeeDependentID": 3,
      "IsActive": true,
      "StatusID": 5,
      "Policies": [
        "sample string 1",
        "sample string 2"
      ],
      "StatusName": "sample string 6",
      "Name": "sample string 7",
      "RelationshipName": "sample string 8",
      "DOB": "2026-02-23T09:27:04.8442712-08:00"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyEmployeeDependentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.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>
  <Dependents xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:PolicyFirmEmployeeDependent>
      <d2p1:DOB>2026-02-23T09:27:04.8442712-08:00</d2p1:DOB>
      <d2p1:FirmEmployeeDependentID>3</d2p1:FirmEmployeeDependentID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 7</d2p1:Name>
      <d2p1:Policies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Policies>
      <d2p1:PolicyFirmEmployeeDependentID>2</d2p1:PolicyFirmEmployeeDependentID>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:RelationshipName>sample string 8</d2p1:RelationshipName>
      <d2p1:StatusID>5</d2p1:StatusID>
      <d2p1:StatusName>sample string 6</d2p1:StatusName>
    </d2p1:PolicyFirmEmployeeDependent>
    <d2p1:PolicyFirmEmployeeDependent>
      <d2p1:DOB>2026-02-23T09:27:04.8442712-08:00</d2p1:DOB>
      <d2p1:FirmEmployeeDependentID>3</d2p1:FirmEmployeeDependentID>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 7</d2p1:Name>
      <d2p1:Policies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Policies>
      <d2p1:PolicyFirmEmployeeDependentID>2</d2p1:PolicyFirmEmployeeDependentID>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:RelationshipName>sample string 8</d2p1:RelationshipName>
      <d2p1:StatusID>5</d2p1:StatusID>
      <d2p1:StatusName>sample string 6</d2p1:StatusName>
    </d2p1:PolicyFirmEmployeeDependent>
  </Dependents>
</GetPolicyEmployeeDependentsResponse>