GET api/Broker/GetAgencyDetails?License={License}

Request Information

URI Parameters

Name	Description	Type	Additional information
License		string	Required String length: inclusive between 0 and 20

Name

Description

Type

Additional information

License

string

Required

String length: inclusive between 0 and 20

Body Parameters

None.

Request Formats

text/json, application/json

Sample:

Request sample for Agency 

--------------------------------------------------------------------------------------------------------------------------------

{
  "License": "sample string 1"
}

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:

Request sample for Agency 

--------------------------------------------------------------------------------------------------------------------------------

<AgencyDetailsRequest xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <License>sample string 1</License>
</AgencyDetailsRequest>

--------------------------------------------------------------------------------------------------------------------------------

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:


--------------------------------------------------------------------------------------------------------------------------------

{
  "AgencyAddress": {
    "State": "sample string 1",
    "Zip4": "sample string 2",
    "CountyName": "sample string 3",
    "CountyCode": "sample string 4",
    "Type": 0,
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "City": "sample string 7",
    "Zip": "sample string 8"
  },
  "AgencyPersonalInfo": {
    "DateOfBirth": "sample string 1",
    "Sex": "sample string 2",
    "ID": "sample string 3",
    "GenderSelfIdentificationCode": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "MI": "sample string 7",
    "Suffix": "sample string 8",
    "Prefix": "sample string 9",
    "Ethnicity": [
      {
        "Label": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Label": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "Race": [
      {
        "Label": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Label": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "OrgName": "sample string 1",
  "Email": "sample string 2",
  "EmailCommissions": "sample string 3",
  "EmailForEvents": "sample string 4",
  "Phone": "sample string 5",
  "License": "sample string 6",
  "Status": "sample string 7",
  "Independent": true,
  "CompanyCode": "sample string 9",
  "ContractState": "sample string 10",
  "EandOExpireDate": "2026-06-03T09:19:53.2014945-07:00",
  "EmailGeneralPrimary": "sample string 12",
  "EmailCommissionsPrimary": "sample string 13",
  "EmailForEventsPrimary": "sample string 14",
  "BrokerType": "sample string 15",
  "AgencyTermDate": "2026-06-03T09:19:53.2014945-07:00",
  "EOPolicyNum": "sample string 16",
  "PhoneOffice": "sample string 17",
  "OfficePhoneExtension": "sample string 18",
  "PhonePrincipal": "sample string 19",
  "PrincipalPhoneExtension": "sample string 20",
  "PrincipalContactName": "sample string 21",
  "LicenseEndDate": "2026-06-03T09:19:53.2014945-07:00",
  "EffectiveDate": "2026-06-03T09:19:53.2014945-07:00",
  "AgencyLevel": "sample string 22",
  "EmailAgentOnboardPrimary": "sample string 23",
  "RecruitedBy": "sample string 24",
  "EventsContactName": "sample string 25",
  "EventsPhone": "sample string 26",
  "EventsPhoneExtension": "sample string 27",
  "CommisionsContactName": "sample string 28",
  "CommisionsPhone": "sample string 29",
  "CommisionsPhoneExtension": "sample string 30",
  "ContractingContactName": "sample string 31",
  "ContractingPhone": "sample string 32",
  "ContractingPhoneExtension": "sample string 33",
  "MarketingAreas": "sample string 34",
  "ShippingAddress": {
    "State": "sample string 1",
    "Zip4": "sample string 2",
    "CountyName": "sample string 3",
    "CountyCode": "sample string 4",
    "Type": 0,
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "City": "sample string 7",
    "Zip": "sample string 8"
  }
}

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:


--------------------------------------------------------------------------------------------------------------------------------

<AgencyDetailsResponse xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AgencyAddress xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
    <a:AddressLine1>sample string 5</a:AddressLine1>
    <a:AddressLine2>sample string 6</a:AddressLine2>
    <a:City>sample string 7</a:City>
    <a:State>sample string 1</a:State>
    <a:Zip>sample string 8</a:Zip>
    <a:CountyCode>sample string 4</a:CountyCode>
    <a:CountyName>sample string 3</a:CountyName>
    <a:Type>None</a:Type>
    <a:Zip4>sample string 2</a:Zip4>
  </AgencyAddress>
  <AgencyLevel>sample string 22</AgencyLevel>
  <AgencyPersonalInfo xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
    <a:Ethnicity>
      <EthnicityInfo>
        <Label>sample string 1</Label>
        <Value>sample string 2</Value>
      </EthnicityInfo>
      <EthnicityInfo>
        <Label>sample string 1</Label>
        <Value>sample string 2</Value>
      </EthnicityInfo>
    </a:Ethnicity>
    <a:FirstName>sample string 5</a:FirstName>
    <a:LastName>sample string 6</a:LastName>
    <a:MI>sample string 7</a:MI>
    <a:Prefix>sample string 9</a:Prefix>
    <a:Race>
      <RaceInfo>
        <Label>sample string 1</Label>
        <Value>sample string 2</Value>
      </RaceInfo>
      <RaceInfo>
        <Label>sample string 1</Label>
        <Value>sample string 2</Value>
      </RaceInfo>
    </a:Race>
    <a:Suffix>sample string 8</a:Suffix>
    <a:DateOfBirth>sample string 1</a:DateOfBirth>
    <a:GenderSelfIdentificationCode>sample string 4</a:GenderSelfIdentificationCode>
    <a:ID>sample string 3</a:ID>
    <a:Sex>sample string 2</a:Sex>
  </AgencyPersonalInfo>
  <AgencyTermDate>2026-06-03T09:19:53.2014945-07:00</AgencyTermDate>
  <BrokerType>sample string 15</BrokerType>
  <CommisionsContactName>sample string 28</CommisionsContactName>
  <CommisionsPhone>sample string 29</CommisionsPhone>
  <CommisionsPhoneExtension>sample string 30</CommisionsPhoneExtension>
  <CompanyCode>sample string 9</CompanyCode>
  <ContractState>sample string 10</ContractState>
  <ContractingContactName>sample string 31</ContractingContactName>
  <ContractingPhone>sample string 32</ContractingPhone>
  <ContractingPhoneExtension>sample string 33</ContractingPhoneExtension>
  <EOPolicyNum>sample string 16</EOPolicyNum>
  <EandOExpireDate>2026-06-03T09:19:53.2014945-07:00</EandOExpireDate>
  <EffectiveDate>2026-06-03T09:19:53.2014945-07:00</EffectiveDate>
  <Email>sample string 2</Email>
  <EmailAgentOnboardPrimary>sample string 23</EmailAgentOnboardPrimary>
  <EmailCommissions>sample string 3</EmailCommissions>
  <EmailCommissionsPrimary>sample string 13</EmailCommissionsPrimary>
  <EmailForEvents>sample string 4</EmailForEvents>
  <EmailForEventsPrimary>sample string 14</EmailForEventsPrimary>
  <EmailGeneralPrimary>sample string 12</EmailGeneralPrimary>
  <EventsContactName>sample string 25</EventsContactName>
  <EventsPhone>sample string 26</EventsPhone>
  <EventsPhoneExtension>sample string 27</EventsPhoneExtension>
  <Independent>true</Independent>
  <License>sample string 6</License>
  <LicenseEndDate>2026-06-03T09:19:53.2014945-07:00</LicenseEndDate>
  <MarketingAreas>sample string 34</MarketingAreas>
  <OfficePhoneExtension>sample string 18</OfficePhoneExtension>
  <OrgName>sample string 1</OrgName>
  <Phone>sample string 5</Phone>
  <PhoneOffice>sample string 17</PhoneOffice>
  <PhonePrincipal>sample string 19</PhonePrincipal>
  <PrincipalContactName>sample string 21</PrincipalContactName>
  <PrincipalPhoneExtension>sample string 20</PrincipalPhoneExtension>
  <RecruitedBy>sample string 24</RecruitedBy>
  <ShippingAddress xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
    <a:AddressLine1>sample string 5</a:AddressLine1>
    <a:AddressLine2>sample string 6</a:AddressLine2>
    <a:City>sample string 7</a:City>
    <a:State>sample string 1</a:State>
    <a:Zip>sample string 8</a:Zip>
    <a:CountyCode>sample string 4</a:CountyCode>
    <a:CountyName>sample string 3</a:CountyName>
    <a:Type>None</a:Type>
    <a:Zip4>sample string 2</a:Zip4>
  </ShippingAddress>
  <Status>sample string 7</Status>
</AgencyDetailsResponse>

--------------------------------------------------------------------------------------------------------------------------------