DELETE v1/Policy/{PolicyNumber}/EarlyRenewal
Delete Early Renewal
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PolicyNumber | string |
Required |
Body Parameters
Amendment and reason details
AmendmentInputName | Description | Type | Additional information |
---|---|---|---|
AmendmentNumber |
The amendment number to apply to the policy. Valid values can be retrieved from the GET v1/Policy/{PolicyNumber}/AmendmentNumbersAndReasons/{PolicyFunction} API |
integer |
Required |
AmendmentReasons | Collection of AmendmentReasonInput |
None. |
Request Formats
application/json, text/json
Sample:
{ "AmendmentNumber": 1, "AmendmentReasons": [ { "ReasonId": 1, "FreeFormReason": "sample string 2" }, { "ReasonId": 1, "FreeFormReason": "sample string 2" } ] }
application/xml, text/xml
Sample:
<AmendmentInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound"> <AmendmentNumber>1</AmendmentNumber> <AmendmentReasons> <AmendmentReasonInput> <FreeFormReason>sample string 2</FreeFormReason> <ReasonId>1</ReasonId> </AmendmentReasonInput> <AmendmentReasonInput> <FreeFormReason>sample string 2</FreeFormReason> <ReasonId>1</ReasonId> </AmendmentReasonInput> </AmendmentReasons> </AmendmentInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Delete Early Renewal
SimplePolicyResponseDTOName | Description | Type | Additional information |
---|---|---|---|
PolicyId | integer |
None. |
|
ProductId | integer |
None. |
|
PolicyNumber | string |
None. |
|
UnderlyingPolicyNumber | string |
None. |
|
Premium | decimal number |
None. |
|
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "PolicyId": 1, "ProductId": 1, "PolicyNumber": "sample string 2", "UnderlyingPolicyNumber": "sample string 3", "Premium": 4.0 }
application/xml, text/xml
Sample:
<SimplePolicyResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>5</Id> <PolicyId>1</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> <Premium>4</Premium> <ProductId>1</ProductId> <UnderlyingPolicyNumber>sample string 3</UnderlyingPolicyNumber> </SimplePolicyResponseDTO>