GET Agency/{agencyId}/profile

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agencyId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Magnesium.Insurance.Contracts.AgencyAdmin.AgencyProfile
NameDescriptionTypeAdditional information
AgencyId

globally unique identifier

None.

AgencyName

string

None.

AgencyCode

string

None.

MainChannel

string

None.

ParentAccount

Magnesium.Insurance.Contracts.AgencyAdmin.ParentAccount

None.

Language

string

None.

Bdm

Magnesium.Insurance.Contracts.AgencyAdmin.AssociatedBdm

None.

HomeProvince

string

None.

PartnerURL

string

None.

AgreementDate

date

None.

EffectiveDate

date

None.

TerminationDate

date

None.

BillToTop

boolean

None.

AllowAgencyBilled

boolean

None.

EnableB2CSite

boolean

None.

SponsoredLicense

boolean

None.

IsCobranded

boolean

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "AgencyId": "082e685a-bf7f-4d42-9eef-ecd3d0d665bc",
  "AgencyName": "sample string 2",
  "AgencyCode": "sample string 3",
  "MainChannel": "sample string 4",
  "ParentAccount": {
    "Id": "38f59ba0-cf47-40ad-b630-0ffad5b86ec8",
    "AgencyName": "sample string 2"
  },
  "Language": "sample string 5",
  "Bdm": null,
  "HomeProvince": "sample string 6",
  "PartnerURL": "sample string 7",
  "AgreementDate": "2023-06-09T01:45:27.6469758-04:00",
  "EffectiveDate": "2023-06-09T01:45:27.6469758-04:00",
  "TerminationDate": "2023-06-09T01:45:27.6469758-04:00",
  "BillToTop": true,
  "AllowAgencyBilled": true,
  "EnableB2CSite": true,
  "SponsoredLicense": true,
  "IsCobranded": true
}