PATCH v1/Policy/Amend?PolicyNumber={PolicyNumber}&amendEffDate={amendEffDate}&Term={Term}&note={note}

Update Policy Partially

Request Information

URI Parameters

Name	Description	Type	Additional information
PolicyNumber		string	Required
amendEffDate	Effective date of amendment	date	Required
Term	Policy term	PolicyTermEnum	Default value is Current
note	Amendment note	string	None.

Body Parameters

JSON Patch of amendments to perform

JsonPatchDocument

Name	Description	Type	Additional information
Operations		Collection of Operation	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "path": "sample string 2",
    "op": "sample string 3"
  },
  {
    "path": "sample string 2",
    "op": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<JsonPatchDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNetCore.JsonPatch">
  <ContractResolver i:nil="true" />
</JsonPatchDocument>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SimplePolicyResponseDTO

Name	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>