POST api/policies/getpolicybeneficiaries

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PolicyID		integer	None.
Header		RequestHeader	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<GetPolicyBeneficiariesRequest 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>
  <PolicyID>1</PolicyID>
</GetPolicyBeneficiariesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyBeneficiariesResponse

Name	Type	Additional information
Employees	Collection of PolicyBeneficiaryEmployee	None.
Dependents	Collection of PolicyBeneficiaryDependent	None.
Result	Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Employees": [
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeID": 2,
      "FirmEmployeeID": 3,
      "IsActive": true,
      "StatusID": 5,
      "StatusName": "sample string 6",
      "Name": "sample string 7",
      "EmpID": "sample string 8",
      "GenderName": "sample string 9",
      "EmailAddress": "sample string 10",
      "MobileNumber": "sample string 11",
      "DOB": "2026-10-17T05:35:25.4944768+00:00",
      "DOR": "2026-10-17T05:35:25.4944768+00:00",
      "Premium": 12.0,
      "SumInsured": 13.0,
      "RelationshipName": "sample string 14",
      "EndorsementAction": "sample string 15"
    },
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeID": 2,
      "FirmEmployeeID": 3,
      "IsActive": true,
      "StatusID": 5,
      "StatusName": "sample string 6",
      "Name": "sample string 7",
      "EmpID": "sample string 8",
      "GenderName": "sample string 9",
      "EmailAddress": "sample string 10",
      "MobileNumber": "sample string 11",
      "DOB": "2026-10-17T05:35:25.4944768+00:00",
      "DOR": "2026-10-17T05:35:25.4944768+00:00",
      "Premium": 12.0,
      "SumInsured": 13.0,
      "RelationshipName": "sample string 14",
      "EndorsementAction": "sample string 15"
    }
  ],
  "Dependents": [
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeDependentID": 2,
      "FirmEmployeeDependentID": 3,
      "FirmEmployeeID": 4,
      "IsActive": true,
      "StatusID": 6,
      "StatusName": "sample string 7",
      "Name": "sample string 8",
      "GenderName": "sample string 9",
      "RelationshipID": 10,
      "RelationshipName": "sample string 11",
      "DOB": "2026-10-17T05:35:25.4944768+00:00",
      "DOM": "2026-10-17T05:35:25.4944768+00:00",
      "Premium": 12.0,
      "ParentEmployeeName": "sample string 13",
      "ParentEmpID": "sample string 14",
      "EndorsementAction": "sample string 15"
    },
    {
      "PolicyID": 1,
      "PolicyFirmEmployeeDependentID": 2,
      "FirmEmployeeDependentID": 3,
      "FirmEmployeeID": 4,
      "IsActive": true,
      "StatusID": 6,
      "StatusName": "sample string 7",
      "Name": "sample string 8",
      "GenderName": "sample string 9",
      "RelationshipID": 10,
      "RelationshipName": "sample string 11",
      "DOB": "2026-10-17T05:35:25.4944768+00:00",
      "DOM": "2026-10-17T05:35:25.4944768+00:00",
      "Premium": 12.0,
      "ParentEmployeeName": "sample string 13",
      "ParentEmpID": "sample string 14",
      "EndorsementAction": "sample string 15"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyBeneficiariesResponse 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>
    <PolicyBeneficiaryDependent>
      <DOB>2026-10-17T05:35:25.4944768+00:00</DOB>
      <DOM>2026-10-17T05:35:25.4944768+00:00</DOM>
      <EndorsementAction>sample string 15</EndorsementAction>
      <FirmEmployeeDependentID>3</FirmEmployeeDependentID>
      <FirmEmployeeID>4</FirmEmployeeID>
      <GenderName>sample string 9</GenderName>
      <IsActive>true</IsActive>
      <Name>sample string 8</Name>
      <ParentEmpID>sample string 14</ParentEmpID>
      <ParentEmployeeName>sample string 13</ParentEmployeeName>
      <PolicyFirmEmployeeDependentID>2</PolicyFirmEmployeeDependentID>
      <PolicyID>1</PolicyID>
      <Premium>12</Premium>
      <RelationshipID>10</RelationshipID>
      <RelationshipName>sample string 11</RelationshipName>
      <StatusID>6</StatusID>
      <StatusName>sample string 7</StatusName>
    </PolicyBeneficiaryDependent>
    <PolicyBeneficiaryDependent>
      <DOB>2026-10-17T05:35:25.4944768+00:00</DOB>
      <DOM>2026-10-17T05:35:25.4944768+00:00</DOM>
      <EndorsementAction>sample string 15</EndorsementAction>
      <FirmEmployeeDependentID>3</FirmEmployeeDependentID>
      <FirmEmployeeID>4</FirmEmployeeID>
      <GenderName>sample string 9</GenderName>
      <IsActive>true</IsActive>
      <Name>sample string 8</Name>
      <ParentEmpID>sample string 14</ParentEmpID>
      <ParentEmployeeName>sample string 13</ParentEmployeeName>
      <PolicyFirmEmployeeDependentID>2</PolicyFirmEmployeeDependentID>
      <PolicyID>1</PolicyID>
      <Premium>12</Premium>
      <RelationshipID>10</RelationshipID>
      <RelationshipName>sample string 11</RelationshipName>
      <StatusID>6</StatusID>
      <StatusName>sample string 7</StatusName>
    </PolicyBeneficiaryDependent>
  </Dependents>
  <Employees>
    <PolicyBeneficiaryEmployee>
      <DOB>2026-10-17T05:35:25.4944768+00:00</DOB>
      <DOR>2026-10-17T05:35:25.4944768+00:00</DOR>
      <EmailAddress>sample string 10</EmailAddress>
      <EmpID>sample string 8</EmpID>
      <EndorsementAction>sample string 15</EndorsementAction>
      <FirmEmployeeID>3</FirmEmployeeID>
      <GenderName>sample string 9</GenderName>
      <IsActive>true</IsActive>
      <MobileNumber>sample string 11</MobileNumber>
      <Name>sample string 7</Name>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
      <PolicyID>1</PolicyID>
      <Premium>12</Premium>
      <RelationshipName>sample string 14</RelationshipName>
      <StatusID>5</StatusID>
      <StatusName>sample string 6</StatusName>
      <SumInsured>13</SumInsured>
    </PolicyBeneficiaryEmployee>
    <PolicyBeneficiaryEmployee>
      <DOB>2026-10-17T05:35:25.4944768+00:00</DOB>
      <DOR>2026-10-17T05:35:25.4944768+00:00</DOR>
      <EmailAddress>sample string 10</EmailAddress>
      <EmpID>sample string 8</EmpID>
      <EndorsementAction>sample string 15</EndorsementAction>
      <FirmEmployeeID>3</FirmEmployeeID>
      <GenderName>sample string 9</GenderName>
      <IsActive>true</IsActive>
      <MobileNumber>sample string 11</MobileNumber>
      <Name>sample string 7</Name>
      <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
      <PolicyID>1</PolicyID>
      <Premium>12</Premium>
      <RelationshipName>sample string 14</RelationshipName>
      <StatusID>5</StatusID>
      <StatusName>sample string 6</StatusName>
      <SumInsured>13</SumInsured>
    </PolicyBeneficiaryEmployee>
  </Employees>
</GetPolicyBeneficiariesResponse>