POST api/Policy360Renewal/VerifyRenewalLetterForAgent

To Verify if Document available for download

Request Information

URI Parameters

None.

Body Parameters

RetrievalParamsRenewalLetter
NameDescriptionTypeAdditional information
PolicyId

string

None.

EffectiveDate

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyId": "sample string 1",
  "EffectiveDate": "sample string 2"
}

application/xml, text/xml

Sample:
<RetrievalParamsRenewalLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Renewals">
  <EffectiveDate>sample string 2</EffectiveDate>
  <PolicyId>sample string 1</PolicyId>
</RetrievalParamsRenewalLetter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VerifyRenewalLetterViewModel
NameDescriptionTypeAdditional information
RenewalLetterGenerated

boolean

None.

DocumentId

integer

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "RenewalLetterGenerated": true,
  "DocumentId": 1,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<VerifyRenewalLetterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Renewals">
  <DocumentId>1</DocumentId>
  <ErrorMessage>sample string 2</ErrorMessage>
  <RenewalLetterGenerated>true</RenewalLetterGenerated>
</VerifyRenewalLetterViewModel>