GET v1/Policy/{PolicyNumber}/CompareInfo?Term={Term}&PolicyId={PolicyId}

Policy Compare Info Retrieval

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PolicyNumber

string

Required

Term

PolicyTermEnum

Default value is Current

PolicyId

integer

None.

Body Parameters

None.

Response Information

Resource Description

Policy Compare Info Retrieval

CompareInfoListResponse
NameDescriptionTypeAdditional information
Limit

Echoed limit of request

integer

None.

Offset

Echoed offset of request

integer

None.

Total

Total records matching search, if requested

integer

None.

Data

List of records matching the search

Collection of CompareInfoDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": null
}

application/xml, text/xml

Sample:
<CompareInfoListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Data i:nil="true" />
  <Limit>1</Limit>
  <Offset>1</Offset>
  <Total>1</Total>
</CompareInfoListResponse>