GET Agency/GetByCode/{agencyCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
agencyCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Magnesium.Insurance.Contracts.AgencyAdmin.AgencySummary

Name	Type	Additional information
AgencyId	globally unique identifier	None.
Profile	Magnesium.Insurance.Contracts.AgencyAdmin.AgencyProfile	None.
Address	Magnesium.Insurance.Contracts.AgencyAdmin.AgencyAddress	None.
Licenses	Collection of Magnesium.Insurance.Contracts.AgencyAdmin.LicenseSummary	None.
Agents	Collection of Magnesium.Insurance.Contracts.AgencyAdmin.AgentSummary	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "AgencyId": "c7f1a4e8-5b16-46fc-a97d-5c1416fc659a",
  "Profile": {
    "AgencyId": "c7f4cc7a-cb3f-4103-92eb-4b89eff2b266",
    "AgencyName": "sample string 2",
    "AgencyCode": "sample string 3",
    "MainChannel": "sample string 4",
    "ParentAccount": {
      "Id": "a54c0da7-d30f-46c4-b544-0174e386491b",
      "AgencyName": "sample string 2"
    },
    "Language": "sample string 5",
    "Bdm": null,
    "HomeProvince": "sample string 6",
    "PartnerURL": "sample string 7",
    "AgreementDate": "2023-06-09T01:39:20.6032404-04:00",
    "EffectiveDate": "2023-06-09T01:39:20.6032404-04:00",
    "TerminationDate": "2023-06-09T01:39:20.6032404-04:00",
    "BillToTop": true,
    "AllowAgencyBilled": true,
    "EnableB2CSite": true,
    "SponsoredLicense": true,
    "IsCobranded": true
  },
  "Address": {
    "AgencyId": "ea5edb80-c3bc-4368-805f-722ad85d434a",
    "BillingAddress1": "sample string 2",
    "BillingAddress2": "sample string 3",
    "BillingProvince": "sample string 4",
    "BillingCity": "sample string 5",
    "BillingPostalCode": "sample string 6",
    "BillingCountry": "sample string 7",
    "BillingEmail": "sample string 8",
    "BillingPhone": "sample string 9",
    "BillingIsEqual": true,
    "BusinessAddress1": "sample string 10",
    "BusinessAddress2": "sample string 11",
    "BusinessProvince": "sample string 12",
    "BusinessCity": "sample string 13",
    "BusinessPostalCode": "sample string 14",
    "BusinessCountry": "sample string 15",
    "BusinessEmail": "sample string 16",
    "BusinessPhone": "sample string 17",
    "ContactName": "sample string 18",
    "ContactEmail": "sample string 19"
  },
  "Licenses": [
    {
      "Id": 1,
      "LicenseSeq": 2,
      "LicenseNumber": "sample string 3",
      "ExpiryDate": "2023-06-09T01:39:20.6032404-04:00",
      "EffectiveDate": "2023-06-09T01:39:20.6032404-04:00",
      "Description": "sample string 4",
      "Province": "sample string 5",
      "Type": "sample string 6",
      "Status": true
    },
    {
      "Id": 1,
      "LicenseSeq": 2,
      "LicenseNumber": "sample string 3",
      "ExpiryDate": "2023-06-09T01:39:20.6032404-04:00",
      "EffectiveDate": "2023-06-09T01:39:20.6032404-04:00",
      "Description": "sample string 4",
      "Province": "sample string 5",
      "Type": "sample string 6",
      "Status": true
    }
  ],
  "Agents": [
    {
      "AgentId": "17da07ab-b9d2-412f-9420-15cb63ba7828",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "HomeProvince": "sample string 4",
      "Role": "sample string 5",
      "Status": true
    },
    {
      "AgentId": "17da07ab-b9d2-412f-9420-15cb63ba7828",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "HomeProvince": "sample string 4",
      "Role": "sample string 5",
      "Status": true
    }
  ]
}