POST api/firms/getfirmemployeedependent
Request Information
URI Parameters
None.
Body Parameters
GetFirmEmployeeDependentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DependentID | integer |
None. |
|
| Header | RequestHeader |
None. |
Request Formats
application/json, text/json
Sample:
{
"DependentID": 1,
"Header": {
"Token": "sample string 1",
"IPAddress": "sample string 2"
}
}
application/xml, text/xml
Sample:
<GetFirmEmployeeDependentRequest 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>
<DependentID>1</DependentID>
</GetFirmEmployeeDependentRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetFirmEmployeeDependentResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| FirmEmployeeDependent | FirmEmployeeDependent |
None. |
|
| Result | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"FirmEmployeeDependent": {
"DependentID": 1,
"FirmEmployeeID": 2,
"IsActive": true,
"RelationshipID": 4,
"CreatedBy": 5,
"CreatedOn": "2025-12-05T20:28:25.0592208-08:00",
"ModifiedBy": 7,
"ModifiedOn": "2025-12-05T20:28:25.0592208-08:00",
"CreatedByName": "sample string 9",
"ModifiedByName": "sample string 10",
"RelationshipName": "sample string 11",
"GenderID": 12,
"GenderName": "sample string 13",
"Name": "sample string 14",
"DOB": "2025-12-05T20:28:25.0592208-08:00",
"DOM": "2025-12-05T20:28:25.0592208-08:00",
"SumInsured": 16.0,
"Premium": 17.0
},
"Result": {
"Result": 1,
"Messages": [
"sample string 1",
"sample string 2"
],
"TechnicalMessages": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<GetFirmEmployeeDependentResponse 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>
<FirmEmployeeDependent xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms">
<d2p1:CreatedBy>5</d2p1:CreatedBy>
<d2p1:CreatedByName>sample string 9</d2p1:CreatedByName>
<d2p1:CreatedOn>2025-12-05T20:28:25.0592208-08:00</d2p1:CreatedOn>
<d2p1:DOB>2025-12-05T20:28:25.0592208-08:00</d2p1:DOB>
<d2p1:DOM>2025-12-05T20:28:25.0592208-08:00</d2p1:DOM>
<d2p1:DependentID>1</d2p1:DependentID>
<d2p1:FirmEmployeeID>2</d2p1:FirmEmployeeID>
<d2p1:GenderID>12</d2p1:GenderID>
<d2p1:GenderName>sample string 13</d2p1:GenderName>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:ModifiedBy>7</d2p1:ModifiedBy>
<d2p1:ModifiedByName>sample string 10</d2p1:ModifiedByName>
<d2p1:ModifiedOn>2025-12-05T20:28:25.0592208-08:00</d2p1:ModifiedOn>
<d2p1:Name>sample string 14</d2p1:Name>
<d2p1:Premium>17</d2p1:Premium>
<d2p1:RelationshipID>4</d2p1:RelationshipID>
<d2p1:RelationshipName>sample string 11</d2p1:RelationshipName>
<d2p1:SumInsured>16</d2p1:SumInsured>
</FirmEmployeeDependent>
</GetFirmEmployeeDependentResponse>