GET v1/PolicySummaryForApi?policyID={policyID}

Get policy information summary detail information for a policy (for 3rd party devs)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyID

Id of the policy

integer

Required

Body Parameters

None.

Response Information

Resource Description

Policy information summary detail information for a policy

PolicySummaryForApiDTO
NameDescriptionTypeAdditional information
PolicyID

integer

None.

CustomerID

integer

None.

PolicyNo

string

None.

EffectiveDate

date

None.

ExpirationDate

date

None.

Status

string

None.

TotalPremiumString

string

None.

PolicyStatusCaption

string

None.

EffectiveDateString

string

None.

ExpirationDateString

string

None.

AgentID

integer

None.

AgentName

string

None.

CSRID

integer

None.

CSRName

string

None.

TotalPremium

decimal number

None.

Description

string

None.

LOBID

integer

None.

LOB

string

None.

MGAID

integer

None.

MGA

string

None.

CarrierID

integer

None.

WritingCarrier

string

None.

WritingCarrierNAIC

string

None.

WritingCarrierDisplayName

string

None.

CustomerName

string

None.

NonRenewal

boolean

None.

PriorPolicyID

integer

None.

PriorPolicyNo

string

None.

BusinessType

string

None.

PremiumBase

decimal number

None.

PremiumDownPayAmount

decimal number

None.

ProducerIds

Collection of integer

None.

PolicyAgencyFees

Collection of PolicyAgencyFeesDataDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyID": 1,
  "CustomerID": 2,
  "PolicyNo": "sample string 3",
  "EffectiveDate": "0001-01-01T00:00:00",
  "ExpirationDate": "0001-01-01T00:00:00",
  "Status": "sample string 6",
  "TotalPremiumString": "$13.00",
  "PolicyStatusCaption": "sample string 7",
  "EffectiveDateString": "",
  "ExpirationDateString": "",
  "AgentID": 10,
  "AgentName": "sample string 11",
  "CSRID": 1,
  "CSRName": "sample string 12",
  "TotalPremium": 13.0,
  "Description": "sample string 14",
  "LOBID": 1,
  "LOB": "sample string 15",
  "MGAID": 1,
  "MGA": "sample string 16",
  "CarrierID": 17,
  "WritingCarrier": "sample string 18",
  "WritingCarrierNAIC": "sample string 19",
  "WritingCarrierDisplayName": "sample string 18 (sample string 19)",
  "CustomerName": "sample string 20",
  "NonRenewal": true,
  "PriorPolicyID": 1,
  "PriorPolicyNo": "sample string 22",
  "BusinessType": "sample string 23",
  "PremiumBase": 24.0,
  "PremiumDownPayAmount": 25.0,
  "ProducerIds": [
    1,
    2
  ],
  "PolicyAgencyFees": [
    {
      "AgencyFeeName": "sample string 1",
      "Amount": 2.0,
      "AmountIsPercent": "sample string 3",
      "CalculatedAmount": 4.0
    },
    {
      "AgencyFeeName": "sample string 1",
      "Amount": 2.0,
      "AmountIsPercent": "sample string 3",
      "CalculatedAmount": 4.0
    }
  ]
}

application/xml, text/xml

Sample:
<PolicySummaryForApiDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <AgentID>10</AgentID>
  <AgentName>sample string 11</AgentName>
  <BusinessType>sample string 23</BusinessType>
  <CSRID>1</CSRID>
  <CSRName>sample string 12</CSRName>
  <CarrierID>17</CarrierID>
  <CustomerID>2</CustomerID>
  <CustomerName>sample string 20</CustomerName>
  <Description>sample string 14</Description>
  <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
  <EffectiveDateString></EffectiveDateString>
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <ExpirationDateString></ExpirationDateString>
  <LOB>sample string 15</LOB>
  <LOBID>1</LOBID>
  <MGA>sample string 16</MGA>
  <MGAID>1</MGAID>
  <NonRenewal>true</NonRenewal>
  <PolicyAgencyFees xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.Contracts.Dto.Policy">
    <d2p1:PolicyAgencyFeesDataDTO>
      <d2p1:AgencyFeeName>sample string 1</d2p1:AgencyFeeName>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:AmountIsPercent>sample string 3</d2p1:AmountIsPercent>
      <d2p1:CalculatedAmount>4</d2p1:CalculatedAmount>
    </d2p1:PolicyAgencyFeesDataDTO>
    <d2p1:PolicyAgencyFeesDataDTO>
      <d2p1:AgencyFeeName>sample string 1</d2p1:AgencyFeeName>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:AmountIsPercent>sample string 3</d2p1:AmountIsPercent>
      <d2p1:CalculatedAmount>4</d2p1:CalculatedAmount>
    </d2p1:PolicyAgencyFeesDataDTO>
  </PolicyAgencyFees>
  <PolicyID>1</PolicyID>
  <PolicyNo>sample string 3</PolicyNo>
  <PolicyStatusCaption>sample string 7</PolicyStatusCaption>
  <PremiumBase>24</PremiumBase>
  <PremiumDownPayAmount>25</PremiumDownPayAmount>
  <PriorPolicyID>1</PriorPolicyID>
  <PriorPolicyNo>sample string 22</PriorPolicyNo>
  <ProducerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProducerIds>
  <Status>sample string 6</Status>
  <TotalPremium>13</TotalPremium>
  <WritingCarrier>sample string 18</WritingCarrier>
  <WritingCarrierNAIC>sample string 19</WritingCarrierNAIC>
</PolicySummaryForApiDTO>