POST v1/PolicyActions/{policyId}/Renew

Request Information

URI Parameters

Name	Description	Type	Additional information
policyId		string	Required

Body Parameters

PolicyActionRequestDTO

Name	Description	Type	Additional information
CreatedBy	Optional. Id of the QQ employee the action is performed on behalf of. Must be an active employee in one of the caller's offices. When omitted the authenticated user is used.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CreatedBy": 1
}

application/x-www-form-urlencoded

Sample:

Form URL encoded content is supported for requests. The form keys are the property names shown in the JSON sample, nested as Property.Child and Collection[0].Property.

application/xml, text/xml

Sample:

<PolicyActionRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <CreatedBy>1</CreatedBy>
</PolicyActionRequestDTO>

Response Information

Resource Description

ActionResultDTOOfNewPolicyResultDTO

Name	Description	Type	Additional 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>