POST api/policies/getpolicyemployeenominees

Request Information

URI Parameters

None.

Body Parameters

GetPolicyEmployeeNomineesRequest
NameDescriptionTypeAdditional information
PolicyID

integer

None.

PolicyFirmEmployeeID

integer

None.

FirmID

integer

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<GetPolicyEmployeeNomineesRequest 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>
  <FirmID>3</FirmID>
  <PolicyFirmEmployeeID>2</PolicyFirmEmployeeID>
  <PolicyID>1</PolicyID>
</GetPolicyEmployeeNomineesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyEmployeeNomineesResponse
NameDescriptionTypeAdditional information
Nominees

Collection of PolicyFirmEmployeeNominee

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "Nominees": [
    {
      "PolicyFirmEmployeeID": 1,
      "FirmEmployeeID": 2,
      "DOB": "2026-02-23T09:27:10.7973582-08:00",
      "GenderID": 3,
      "GenderName": "sample string 4",
      "IsActive": true,
      "RelationshipID": 6,
      "RelationshipName": "sample string 7",
      "NomineeName": "sample string 8",
      "PercentageShare": 9.0
    },
    {
      "PolicyFirmEmployeeID": 1,
      "FirmEmployeeID": 2,
      "DOB": "2026-02-23T09:27:10.7973582-08:00",
      "GenderID": 3,
      "GenderName": "sample string 4",
      "IsActive": true,
      "RelationshipID": 6,
      "RelationshipName": "sample string 7",
      "NomineeName": "sample string 8",
      "PercentageShare": 9.0
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyEmployeeNomineesResponse 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>
  <Nominees xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:PolicyFirmEmployeeNominee>
      <d2p1:DOB>2026-02-23T09:27:10.7973582-08:00</d2p1:DOB>
      <d2p1:FirmEmployeeID>2</d2p1:FirmEmployeeID>
      <d2p1:GenderID>3</d2p1:GenderID>
      <d2p1:GenderName>sample string 4</d2p1:GenderName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:NomineeName>sample string 8</d2p1:NomineeName>
      <d2p1:PercentageShare>9</d2p1:PercentageShare>
      <d2p1:PolicyFirmEmployeeID>1</d2p1:PolicyFirmEmployeeID>
      <d2p1:RelationshipID>6</d2p1:RelationshipID>
      <d2p1:RelationshipName>sample string 7</d2p1:RelationshipName>
    </d2p1:PolicyFirmEmployeeNominee>
    <d2p1:PolicyFirmEmployeeNominee>
      <d2p1:DOB>2026-02-23T09:27:10.7973582-08:00</d2p1:DOB>
      <d2p1:FirmEmployeeID>2</d2p1:FirmEmployeeID>
      <d2p1:GenderID>3</d2p1:GenderID>
      <d2p1:GenderName>sample string 4</d2p1:GenderName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:NomineeName>sample string 8</d2p1:NomineeName>
      <d2p1:PercentageShare>9</d2p1:PercentageShare>
      <d2p1:PolicyFirmEmployeeID>1</d2p1:PolicyFirmEmployeeID>
      <d2p1:RelationshipID>6</d2p1:RelationshipID>
      <d2p1:RelationshipName>sample string 7</d2p1:RelationshipName>
    </d2p1:PolicyFirmEmployeeNominee>
  </Nominees>
</GetPolicyEmployeeNomineesResponse>