GET v1/Customers/{id}

Retrieve Customer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Customer id

integer

Required

Body Parameters

None.

Response Information

Resource Description

CustomerOutboundDTO
NameDescriptionTypeAdditional information
FirstName

Customer first name

string

String length: inclusive between 0 and 30

Id

Customer Id

integer

None.

LastName

Customer last name

string

String length: inclusive between 0 and 30

CommercialName

Customer commercial name

string

String length: inclusive between 0 and 500

Type

Customer type (Personal / Commercial)

CustomerTypeEnum

None.

LegalStatus

Customer legal status

LegalStatusEnum

None.

RiskAddress

Customer risk address

EntityAddressDTO

None.

MailingAddress

Customer mailing address

EntityAddressDTO

None.

MobilePhone

Customer mobile phone

string

String length: inclusive between 0 and 25

HomePhone

Customer home phone

string

String length: inclusive between 0 and 25

WorkPhone

Customer work phone

string

String length: inclusive between 0 and 25

SecondaryMobilePhone

Customer work phone

string

String length: inclusive between 0 and 25

FaxNumber

Customer Fax number

string

String length: inclusive between 0 and 25

Email

Customer e-mail

string

String length: inclusive between 0 and 60

Quotes

Customer's existing quotes

Collection of QuoteOutboundDTO

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "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-20T04:05:45.1850022-10:00",
      "ExpirationDate": "2022-01-20T04:05:45.1850022-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-20T04:05:45.1850022-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-20T04:05:45.1850022-10:00",
      "ExpirationDate": "2022-01-20T04:05:45.1850022-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-20T04:05:45.1850022-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
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.