POST v1/PolicyActions/{policyId}/Renew

Renew an existing policy. The policy must be active or expired, must not be flagged as non-renewal and must have no intent to cancel recorded; every other policy is rejected.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyId

Required. Id of the policy to renew

string

Required

Body Parameters

None.

Response Information

Resource Description

Action result carrying the id of the newly created policy

ActionResultDTOOfNewPolicyResultDTO
NameDescriptionTypeAdditional information
Result

NewPolicyResultDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

Signifies whether action is successful

boolean

None.

ErrorCode

Error code

string

None.

ErrorMessage

Error message

string

None.

InfoMessage

Information message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "NewPolicyID": 1
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfNewPolicyResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
    <d2p1:NewPolicyID>1</d2p1:NewPolicyID>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfNewPolicyResultDTO>