GET Agency/Partners?page={page}&limit={limit}&orderBy={orderBy}&orderByDir={orderByDir}&agencyCode={agencyCode}&agencyName={agencyName}&postalCode={postalCode}&city={city}&parentAccountId={parentAccountId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page | integer |
Required |
|
| limit | integer |
Required |
|
| orderBy | string |
Required |
|
| orderByDir | string |
Required |
|
| agencyCode | string |
Default value is |
|
| agencyName | string |
Default value is |
|
| postalCode | string |
Default value is |
|
| city | string |
Default value is |
|
| parentAccountId | globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
Magnesium.Insurance.Contracts.AgencyAdmin.AgencyPartnersPaginated| Name | Description | Type | Additional information |
|---|---|---|---|
| Partners | Collection of Magnesium.Insurance.Contracts.AgencyAdmin.AgencySummary |
None. |
|
| PerPage | integer |
None. |
|
| CurrentPage | integer |
None. |
|
| TotalResults | integer |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"Partners": [
{
"AgencyId": "ec74f29b-0a30-4c3c-ac42-e749ab2bb85d",
"Profile": {
"AgencyId": "21bbf4c5-08b8-4545-a5e4-a821c7f5fad2",
"AgencyName": "sample string 2",
"AgencyCode": "sample string 3",
"MainChannel": "sample string 4",
"ParentAccount": {
"Id": "2faa211c-6899-4ef5-8135-ebd46b445d9a",
"AgencyName": "sample string 2"
},
"Language": "sample string 5",
"Bdm": null,
"HomeProvince": "sample string 6",
"PartnerURL": "sample string 7",
"AgreementDate": "2023-06-09T00:19:33.9743975-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9743975-04:00",
"TerminationDate": "2023-06-09T00:19:33.9743975-04:00",
"BillToTop": true,
"AllowAgencyBilled": true,
"EnableB2CSite": true,
"SponsoredLicense": true,
"IsCobranded": true
},
"Address": {
"AgencyId": "b10b7bdd-b3df-4a04-94d2-e5d39bccab49",
"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-09T00:19:33.9753971-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9753971-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-09T00:19:33.9753971-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9753971-04:00",
"Description": "sample string 4",
"Province": "sample string 5",
"Type": "sample string 6",
"Status": true
}
],
"Agents": [
{
"AgentId": "73dc68b4-ea25-405d-bbde-d684991c32ce",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"HomeProvince": "sample string 4",
"Role": "sample string 5",
"Status": true
},
{
"AgentId": "73dc68b4-ea25-405d-bbde-d684991c32ce",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"HomeProvince": "sample string 4",
"Role": "sample string 5",
"Status": true
}
]
},
{
"AgencyId": "ec74f29b-0a30-4c3c-ac42-e749ab2bb85d",
"Profile": {
"AgencyId": "21bbf4c5-08b8-4545-a5e4-a821c7f5fad2",
"AgencyName": "sample string 2",
"AgencyCode": "sample string 3",
"MainChannel": "sample string 4",
"ParentAccount": {
"Id": "2faa211c-6899-4ef5-8135-ebd46b445d9a",
"AgencyName": "sample string 2"
},
"Language": "sample string 5",
"Bdm": null,
"HomeProvince": "sample string 6",
"PartnerURL": "sample string 7",
"AgreementDate": "2023-06-09T00:19:33.9743975-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9743975-04:00",
"TerminationDate": "2023-06-09T00:19:33.9743975-04:00",
"BillToTop": true,
"AllowAgencyBilled": true,
"EnableB2CSite": true,
"SponsoredLicense": true,
"IsCobranded": true
},
"Address": {
"AgencyId": "b10b7bdd-b3df-4a04-94d2-e5d39bccab49",
"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-09T00:19:33.9753971-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9753971-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-09T00:19:33.9753971-04:00",
"EffectiveDate": "2023-06-09T00:19:33.9753971-04:00",
"Description": "sample string 4",
"Province": "sample string 5",
"Type": "sample string 6",
"Status": true
}
],
"Agents": [
{
"AgentId": "73dc68b4-ea25-405d-bbde-d684991c32ce",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"HomeProvince": "sample string 4",
"Role": "sample string 5",
"Status": true
},
{
"AgentId": "73dc68b4-ea25-405d-bbde-d684991c32ce",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"HomeProvince": "sample string 4",
"Role": "sample string 5",
"Status": true
}
]
}
],
"PerPage": 1,
"CurrentPage": 2,
"TotalResults": 3
}