GET v1/Policy/{PolicyNumber}?Term={Term}

Retrieve Policy

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PolicyNumber

string

Required

Term

PolicyTermEnum

Default value is Current

Body Parameters

None.

Response Information

Resource Description

PolicyProductOutboundDTO
NameDescriptionTypeAdditional information
Policy

PolicyOutboundDTO

Required

Product

Object

Required

Id

Primary Id

integer

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Policy": {
    "AgencyId": 1,
    "AgentId": 1,
    "SubagencyId": 1,
    "CustomerId": 1,
    "Customer": {
      "FirstName": "sample string 1",
      "Id": 2,
      "LastName": "sample string 3",
      "CommercialName": "sample string 4",
      "Type": "Unknown",
      "LegalStatus": "Unknown",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MobilePhone": "sample string 5",
      "HomePhone": "sample string 6",
      "WorkPhone": "sample string 7",
      "SecondaryMobilePhone": "sample string 8",
      "FaxNumber": "sample string 9",
      "Email": "sample string 10",
      "Quotes": [
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "DivisionOrganizationId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2022-01-20T03:39:05.9249157-10:00",
          "ExpirationDate": "2022-01-20T03:39:05.9249157-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 1",
          "PolicyNumber": "sample string 2",
          "Premium": 1.0,
          "PrimaryNamedInsured": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "CommercialName": "sample string 3",
            "EmailAddress": "sample string 4",
            "HomePhone": "sample string 5",
            "MobilePhone": "sample string 6",
            "RiskAddress": {
              "Type": "Unknown",
              "Address1": "sample string 1",
              "Address2": "sample string 2",
              "City": "sample string 3",
              "State": "sample string 4",
              "County": "sample string 5",
              "Country": "sample string 6",
              "Zipcode1": "sample string 7",
              "Zipcode2": "sample string 8",
              "Id": 9
            },
            "RiskAddressIsMailingAddress": true,
            "MailingAddress": {
              "Type": "Unknown",
              "Address1": "sample string 1",
              "Address2": "sample string 2",
              "City": "sample string 3",
              "State": "sample string 4",
              "County": "sample string 5",
              "Country": "sample string 6",
              "Zipcode1": "sample string 7",
              "Zipcode2": "sample string 8",
              "Id": 9
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 3",
          "RateGuaranteeDate": "2022-01-20T03:39:05.9249157-10:00",
          "RatingTaxa": "sample string 4",
          "State": "sample string 5",
          "Country": "sample string 6",
          "UnderwritingCompanyId": 7,
          "UniversalAccountId": 8,
          "AgencyCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "SubagencyCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "AgentCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "AdditionalPayees": [
            {
              "Type": "Unknown",
              "CommissionOverride": {
                "Type": "Unknown",
                "Rate": 1.0,
                "OverrideType": "Unknown",
                "OverrideRate": 1.0,
                "CommissionOverride": true,
                "Id": 2
              },
              "Id": 1
            },
            {
              "Type": "Unknown",
              "CommissionOverride": {
                "Type": "Unknown",
                "Rate": 1.0,
                "OverrideType": "Unknown",
                "OverrideRate": 1.0,
                "CommissionOverride": true,
                "Id": 2
              },
              "Id": 1
            }
          ],
          "CustomQuoteNumber": "sample string 9",
          "UnderwritingResults": [
            {
              "RuleCode": "sample string 1",
              "Message": "sample string 2"
            },
            {
              "RuleCode": "sample string 1",
              "Message": "sample string 2"
            }
          ],
          "Id": 10
        },
        {
          "AgencyId": 1,
          "AgentId": 1,
          "SubagencyId": 1,
          "DivisionOrganizationId": 1,
          "BillPlanId": 1,
          "RenewalBillPlanId": 1,
          "CustomerId": 1,
          "CompleteQuote": true,
          "EffectiveDate": "2022-01-20T03:39:05.9249157-10:00",
          "ExpirationDate": "2022-01-20T03:39:05.9249157-10:00",
          "QuoteTerm": "Unknown",
          "LineOfBusiness": "sample string 1",
          "PolicyNumber": "sample string 2",
          "Premium": 1.0,
          "PrimaryNamedInsured": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "CommercialName": "sample string 3",
            "EmailAddress": "sample string 4",
            "HomePhone": "sample string 5",
            "MobilePhone": "sample string 6",
            "RiskAddress": {
              "Type": "Unknown",
              "Address1": "sample string 1",
              "Address2": "sample string 2",
              "City": "sample string 3",
              "State": "sample string 4",
              "County": "sample string 5",
              "Country": "sample string 6",
              "Zipcode1": "sample string 7",
              "Zipcode2": "sample string 8",
              "Id": 9
            },
            "RiskAddressIsMailingAddress": true,
            "MailingAddress": {
              "Type": "Unknown",
              "Address1": "sample string 1",
              "Address2": "sample string 2",
              "City": "sample string 3",
              "State": "sample string 4",
              "County": "sample string 5",
              "Country": "sample string 6",
              "Zipcode1": "sample string 7",
              "Zipcode2": "sample string 8",
              "Id": 9
            },
            "Type": "Unknown",
            "Id": 7
          },
          "QuoteNumber": "sample string 3",
          "RateGuaranteeDate": "2022-01-20T03:39:05.9249157-10:00",
          "RatingTaxa": "sample string 4",
          "State": "sample string 5",
          "Country": "sample string 6",
          "UnderwritingCompanyId": 7,
          "UniversalAccountId": 8,
          "AgencyCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "SubagencyCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "AgentCommissionOverride": {
            "Type": "Unknown",
            "Rate": 1.0,
            "OverrideType": "Unknown",
            "OverrideRate": 1.0,
            "CommissionOverride": true,
            "Id": 2
          },
          "AdditionalPayees": [
            {
              "Type": "Unknown",
              "CommissionOverride": {
                "Type": "Unknown",
                "Rate": 1.0,
                "OverrideType": "Unknown",
                "OverrideRate": 1.0,
                "CommissionOverride": true,
                "Id": 2
              },
              "Id": 1
            },
            {
              "Type": "Unknown",
              "CommissionOverride": {
                "Type": "Unknown",
                "Rate": 1.0,
                "OverrideType": "Unknown",
                "OverrideRate": 1.0,
                "CommissionOverride": true,
                "Id": 2
              },
              "Id": 1
            }
          ],
          "CustomQuoteNumber": "sample string 9",
          "UnderwritingResults": [
            {
              "RuleCode": "sample string 1",
              "Message": "sample string 2"
            },
            {
              "RuleCode": "sample string 1",
              "Message": "sample string 2"
            }
          ],
          "Id": 10
        }
      ]
    },
    "EffectiveDate": "2022-01-20T03:39:05.9249157-10:00",
    "ExpirationDate": "2022-01-20T03:39:05.9249157-10:00",
    "TermNumber": 1,
    "Status": "Unknown",
    "LineOfBusiness": "sample string 2",
    "PolicyNumber": "sample string 3",
    "UnderlyingPolicyNumber": "sample string 4",
    "Premium": 5.0,
    "BillPlanId": 1,
    "ThirdPartyBillTypeId": 1,
    "RenewalBillPlanId": 1,
    "PrimaryNamedInsured": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "CommercialName": "sample string 3",
      "EmailAddress": "sample string 4",
      "HomePhone": "sample string 5",
      "MobilePhone": "sample string 6",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "RiskAddressIsMailingAddress": true,
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "BillingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "Type": "Unknown",
      "Id": 7
    },
    "NamedInsuredLegalStatus": "Unknown",
    "RateGuaranteeDate": "2022-01-20T03:39:05.9249157-10:00",
    "RatingTaxa": "sample string 6",
    "State": "sample string 7",
    "Country": "sample string 8",
    "UnderwritingCompanyId": 9,
    "UniversalAccountId": 10,
    "DivisionOrganizationId": 1,
    "AgencyCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "SubagencyCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "AgentCommissionOverride": {
      "Type": "Unknown",
      "Rate": 1.0,
      "OverrideType": "Unknown",
      "OverrideRate": 1.0,
      "CommissionOverride": true,
      "Id": 2
    },
    "AdditionalPayees": [
      {
        "Type": "Unknown",
        "CommissionOverride": {
          "Type": "Unknown",
          "Rate": 1.0,
          "OverrideType": "Unknown",
          "OverrideRate": 1.0,
          "CommissionOverride": true,
          "Id": 2
        },
        "Id": 1
      },
      {
        "Type": "Unknown",
        "CommissionOverride": {
          "Type": "Unknown",
          "Rate": 1.0,
          "OverrideType": "Unknown",
          "OverrideRate": 1.0,
          "CommissionOverride": true,
          "Id": 2
        },
        "Id": 1
      }
    ],
    "ProductType": "sample string 11",
    "Id": 12
  },
  "Product": {},
  "Id": 2
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.