POST api/policies/createaddemployeeendorsement
Request Information
URI Parameters
None.
Body Parameters
CreateAddEmployeeEndorsementRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyID | integer |
None. |
|
| PolicyEndorsementID | integer |
None. |
|
| EmployeesToAdd | Collection of CreateAddEmployeeEndorsementSelectedEmployee |
None. |
|
| Culture | string |
None. |
|
| TimeZoneOffsetMinutes | integer |
None. |
|
| Header | RequestHeader |
None. |
Request Formats
application/json, text/json
Sample:
{
"PolicyID": 1,
"PolicyEndorsementID": 2,
"EmployeesToAdd": [
{
"FirmEmployeeID": 1,
"EmpID": "sample string 2",
"Name": "sample string 3",
"Gender": "sample string 4",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOJ": "2026-10-17T05:35:26.4738628+00:00",
"CTC": 1.0,
"SumInsured": 1.0,
"ClaimExists": "sample string 5",
"DependentsToAdd": [
{
"Name": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOM": "2026-10-17T05:35:26.4738628+00:00",
"SumInsured": 1.0
},
{
"Name": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOM": "2026-10-17T05:35:26.4738628+00:00",
"SumInsured": 1.0
}
],
"Nominees": [
{
"NomineeName": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"PercentageShare": 1.0,
"DOB": "2026-10-17T05:35:26.4738628+00:00"
},
{
"NomineeName": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"PercentageShare": 1.0,
"DOB": "2026-10-17T05:35:26.4738628+00:00"
}
]
},
{
"FirmEmployeeID": 1,
"EmpID": "sample string 2",
"Name": "sample string 3",
"Gender": "sample string 4",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOJ": "2026-10-17T05:35:26.4738628+00:00",
"CTC": 1.0,
"SumInsured": 1.0,
"ClaimExists": "sample string 5",
"DependentsToAdd": [
{
"Name": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOM": "2026-10-17T05:35:26.4738628+00:00",
"SumInsured": 1.0
},
{
"Name": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"DOB": "2026-10-17T05:35:26.4738628+00:00",
"DOM": "2026-10-17T05:35:26.4738628+00:00",
"SumInsured": 1.0
}
],
"Nominees": [
{
"NomineeName": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"PercentageShare": 1.0,
"DOB": "2026-10-17T05:35:26.4738628+00:00"
},
{
"NomineeName": "sample string 1",
"Gender": "sample string 2",
"Relationship": "sample string 3",
"PercentageShare": 1.0,
"DOB": "2026-10-17T05:35:26.4738628+00:00"
}
]
}
],
"Culture": "sample string 3",
"TimeZoneOffsetMinutes": 4,
"Header": {
"Token": "sample string 1",
"IPAddress": "sample string 2"
}
}
application/xml, text/xml
Sample:
<CreateAddEmployeeEndorsementRequest 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>
<Culture>sample string 3</Culture>
<EmployeesToAdd>
<CreateAddEmployeeEndorsementSelectedEmployee>
<CTC>1</CTC>
<ClaimExists>sample string 5</ClaimExists>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOJ>2026-10-17T05:35:26.4738628+00:00</DOJ>
<DependentsToAdd>
<CreateAddEmployeeEndorsementSelectedDependent>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOM>2026-10-17T05:35:26.4738628+00:00</DOM>
<Gender>sample string 2</Gender>
<Name>sample string 1</Name>
<Relationship>sample string 3</Relationship>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedDependent>
<CreateAddEmployeeEndorsementSelectedDependent>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOM>2026-10-17T05:35:26.4738628+00:00</DOM>
<Gender>sample string 2</Gender>
<Name>sample string 1</Name>
<Relationship>sample string 3</Relationship>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedDependent>
</DependentsToAdd>
<EmpID>sample string 2</EmpID>
<FirmEmployeeID>1</FirmEmployeeID>
<Gender>sample string 4</Gender>
<Name>sample string 3</Name>
<Nominees>
<CreateAddEmployeeEndorsementSelectedNominee>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<Gender>sample string 2</Gender>
<NomineeName>sample string 1</NomineeName>
<PercentageShare>1</PercentageShare>
<Relationship>sample string 3</Relationship>
</CreateAddEmployeeEndorsementSelectedNominee>
<CreateAddEmployeeEndorsementSelectedNominee>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<Gender>sample string 2</Gender>
<NomineeName>sample string 1</NomineeName>
<PercentageShare>1</PercentageShare>
<Relationship>sample string 3</Relationship>
</CreateAddEmployeeEndorsementSelectedNominee>
</Nominees>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedEmployee>
<CreateAddEmployeeEndorsementSelectedEmployee>
<CTC>1</CTC>
<ClaimExists>sample string 5</ClaimExists>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOJ>2026-10-17T05:35:26.4738628+00:00</DOJ>
<DependentsToAdd>
<CreateAddEmployeeEndorsementSelectedDependent>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOM>2026-10-17T05:35:26.4738628+00:00</DOM>
<Gender>sample string 2</Gender>
<Name>sample string 1</Name>
<Relationship>sample string 3</Relationship>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedDependent>
<CreateAddEmployeeEndorsementSelectedDependent>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<DOM>2026-10-17T05:35:26.4738628+00:00</DOM>
<Gender>sample string 2</Gender>
<Name>sample string 1</Name>
<Relationship>sample string 3</Relationship>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedDependent>
</DependentsToAdd>
<EmpID>sample string 2</EmpID>
<FirmEmployeeID>1</FirmEmployeeID>
<Gender>sample string 4</Gender>
<Name>sample string 3</Name>
<Nominees>
<CreateAddEmployeeEndorsementSelectedNominee>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<Gender>sample string 2</Gender>
<NomineeName>sample string 1</NomineeName>
<PercentageShare>1</PercentageShare>
<Relationship>sample string 3</Relationship>
</CreateAddEmployeeEndorsementSelectedNominee>
<CreateAddEmployeeEndorsementSelectedNominee>
<DOB>2026-10-17T05:35:26.4738628+00:00</DOB>
<Gender>sample string 2</Gender>
<NomineeName>sample string 1</NomineeName>
<PercentageShare>1</PercentageShare>
<Relationship>sample string 3</Relationship>
</CreateAddEmployeeEndorsementSelectedNominee>
</Nominees>
<SumInsured>1</SumInsured>
</CreateAddEmployeeEndorsementSelectedEmployee>
</EmployeesToAdd>
<PolicyEndorsementID>2</PolicyEndorsementID>
<PolicyID>1</PolicyID>
<TimeZoneOffsetMinutes>4</TimeZoneOffsetMinutes>
</CreateAddEmployeeEndorsementRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateAddEmployeeEndorsementResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Beneficiaries | Collection of CreateAddEmployeeEndorsementBeneficiary |
None. |
|
| DocumentUrl | string |
None. |
|
| FileName | string |
None. |
|
| PolicyEndorsementID | integer |
None. |
|
| Result | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"Beneficiaries": [
{
"SLNO": "sample string 1",
"EMPCODE": "sample string 2",
"NAME": "sample string 3",
"GENDER": "sample string 4",
"RELATIONSHIP": "sample string 5",
"DOB": "sample string 6",
"DOJ": "sample string 7",
"DOM": "sample string 8",
"CLAIM_EXISTS": "sample string 9",
"SUMINSURED": "sample string 10",
"CTC": "sample string 11"
},
{
"SLNO": "sample string 1",
"EMPCODE": "sample string 2",
"NAME": "sample string 3",
"GENDER": "sample string 4",
"RELATIONSHIP": "sample string 5",
"DOB": "sample string 6",
"DOJ": "sample string 7",
"DOM": "sample string 8",
"CLAIM_EXISTS": "sample string 9",
"SUMINSURED": "sample string 10",
"CTC": "sample string 11"
}
],
"DocumentUrl": "sample string 1",
"FileName": "sample string 2",
"PolicyEndorsementID": 3,
"Result": {
"Result": 1,
"Messages": [
"sample string 1",
"sample string 2"
],
"TechnicalMessages": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<CreateAddEmployeeEndorsementResponse 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>
<Beneficiaries>
<CreateAddEmployeeEndorsementBeneficiary>
<CLAIM_EXISTS>sample string 9</CLAIM_EXISTS>
<CTC>sample string 11</CTC>
<DOB>sample string 6</DOB>
<DOJ>sample string 7</DOJ>
<DOM>sample string 8</DOM>
<EMPCODE>sample string 2</EMPCODE>
<GENDER>sample string 4</GENDER>
<NAME>sample string 3</NAME>
<RELATIONSHIP>sample string 5</RELATIONSHIP>
<SLNO>sample string 1</SLNO>
<SUMINSURED>sample string 10</SUMINSURED>
</CreateAddEmployeeEndorsementBeneficiary>
<CreateAddEmployeeEndorsementBeneficiary>
<CLAIM_EXISTS>sample string 9</CLAIM_EXISTS>
<CTC>sample string 11</CTC>
<DOB>sample string 6</DOB>
<DOJ>sample string 7</DOJ>
<DOM>sample string 8</DOM>
<EMPCODE>sample string 2</EMPCODE>
<GENDER>sample string 4</GENDER>
<NAME>sample string 3</NAME>
<RELATIONSHIP>sample string 5</RELATIONSHIP>
<SLNO>sample string 1</SLNO>
<SUMINSURED>sample string 10</SUMINSURED>
</CreateAddEmployeeEndorsementBeneficiary>
</Beneficiaries>
<DocumentUrl>sample string 1</DocumentUrl>
<FileName>sample string 2</FileName>
<PolicyEndorsementID>3</PolicyEndorsementID>
</CreateAddEmployeeEndorsementResponse>