POST v1/Commissions/AgencyRules/Get

Gets the list of Agency Commissions rules based on the filter

Request Information

URI Parameters

None.

Body Parameters

Filter

Name	Type	Additional information
AnyCarrierId	integer	None.
PageNo	integer	None.
PageSize	integer	None.
OrderList	Collection of CommListOrderEntry	None.
OfficeId	integer	None.
MgaId	integer	None.
ParentCarrierId	integer	None.
CarrierId	integer	None.
LobId	integer	None.
SublineId	integer	None.
Term	EnumPolicyTerm	None.

Request Formats

application/json, text/json

Sample:

{
  "AnyCarrierId": 1,
  "PageNo": 1,
  "PageSize": 2,
  "OrderList": [
    {
      "OrderBy": 0,
      "OrderByDirection": 0
    },
    {
      "OrderBy": 0,
      "OrderByDirection": 0
    }
  ],
  "OfficeId": 1,
  "MgaId": 1,
  "ParentCarrierId": 1,
  "CarrierId": 1,
  "LobId": 1,
  "SublineId": 1,
  "Term": 0
}

application/xml, text/xml

Sample:

<CommFilterAgency xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.CommissionCentral">
  <CarrierId>1</CarrierId>
  <LobId>1</LobId>
  <MgaId>1</MgaId>
  <OfficeId>1</OfficeId>
  <OrderList>
    <CommListOrderEntry>
      <OrderBy>EffectiveOn</OrderBy>
      <OrderByDirection>Asc</OrderByDirection>
    </CommListOrderEntry>
    <CommListOrderEntry>
      <OrderBy>EffectiveOn</OrderBy>
      <OrderByDirection>Asc</OrderByDirection>
    </CommListOrderEntry>
  </OrderList>
  <PageNo>1</PageNo>
  <PageSize>2</PageSize>
  <ParentCarrierId>1</ParentCarrierId>
  <SublineId>1</SublineId>
  <Term>Annual</Term>
  <AnyCarrierId>1</AnyCarrierId>
</CommFilterAgency>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CommFilterAgency'.

Response Information

Resource Description

Paged list of Agency Commissions rules

PageOfOfCommRuleAgencyDto

Name	Type	Additional information
Data	Collection of CommRuleAgencyDto	None.
PageNumber	integer	None.
PagesTotal	integer	None.
TotalItems	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
DisplayMessage	string	None.
Links	Collection of PageLink	None.
Href	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "CommApplyAllLines": true,
      "PremiumTier": 2,
      "RuleEntries": [
        {
          "EntryId": 1,
          "LobId": 1,
          "NewBusiness": 2.0,
          "Renewal": 3.0,
          "Rewrite": 4.0,
          "TierMax": 5.0,
          "RuleEntryIsPercent": true,
          "LobName": "sample string 7",
          "LobInternalCode": "sample string 8"
        },
        {
          "EntryId": 1,
          "LobId": 1,
          "NewBusiness": 2.0,
          "Renewal": 3.0,
          "Rewrite": 4.0,
          "TierMax": 5.0,
          "RuleEntryIsPercent": true,
          "LobName": "sample string 7",
          "LobInternalCode": "sample string 8"
        }
      ],
      "RuleId": 3,
      "PolicyType": 0,
      "PackageType": 0,
      "Term": 0,
      "OfficeId": 1,
      "MgaId": 1,
      "ParentCarrierId": 1,
      "CarrierId": 1,
      "SublineId": 1,
      "LobId": 1,
      "RuleWeight": 4,
      "EffectiveOn": "2024-11-21T09:52:31.6069894+00:00",
      "ExpiresOn": "2024-11-21T09:52:31.6069894+00:00",
      "OfficeName": "sample string 5",
      "CarrierName": "sample string 6",
      "ParentCarrierName": "sample string 7",
      "MgaName": "sample string 8",
      "SublineName": "sample string 9",
      "LobName": "sample string 10",
      "LobList": [
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        }
      ]
    },
    {
      "CommApplyAllLines": true,
      "PremiumTier": 2,
      "RuleEntries": [
        {
          "EntryId": 1,
          "LobId": 1,
          "NewBusiness": 2.0,
          "Renewal": 3.0,
          "Rewrite": 4.0,
          "TierMax": 5.0,
          "RuleEntryIsPercent": true,
          "LobName": "sample string 7",
          "LobInternalCode": "sample string 8"
        },
        {
          "EntryId": 1,
          "LobId": 1,
          "NewBusiness": 2.0,
          "Renewal": 3.0,
          "Rewrite": 4.0,
          "TierMax": 5.0,
          "RuleEntryIsPercent": true,
          "LobName": "sample string 7",
          "LobInternalCode": "sample string 8"
        }
      ],
      "RuleId": 3,
      "PolicyType": 0,
      "PackageType": 0,
      "Term": 0,
      "OfficeId": 1,
      "MgaId": 1,
      "ParentCarrierId": 1,
      "CarrierId": 1,
      "SublineId": 1,
      "LobId": 1,
      "RuleWeight": 4,
      "EffectiveOn": "2024-11-21T09:52:31.6069894+00:00",
      "ExpiresOn": "2024-11-21T09:52:31.6069894+00:00",
      "OfficeName": "sample string 5",
      "CarrierName": "sample string 6",
      "ParentCarrierName": "sample string 7",
      "MgaName": "sample string 8",
      "SublineName": "sample string 9",
      "LobName": "sample string 10",
      "LobList": [
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:

<PageOfCommRuleAgencyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.CommissionCentral">
    <d2p1:CommRuleAgencyDto>
      <d2p1:CarrierId>1</d2p1:CarrierId>
      <d2p1:CarrierName>sample string 6</d2p1:CarrierName>
      <d2p1:EffectiveOn>2024-11-21T09:52:31.6069894+00:00</d2p1:EffectiveOn>
      <d2p1:ExpiresOn>2024-11-21T09:52:31.6069894+00:00</d2p1:ExpiresOn>
      <d2p1:LobId>1</d2p1:LobId>
      <d2p1:LobList>
        <d2p1:CommRuleLobListItemDto>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CommRuleLobListItemDto>
        <d2p1:CommRuleLobListItemDto>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CommRuleLobListItemDto>
      </d2p1:LobList>
      <d2p1:LobName>sample string 10</d2p1:LobName>
      <d2p1:MgaId>1</d2p1:MgaId>
      <d2p1:MgaName>sample string 8</d2p1:MgaName>
      <d2p1:OfficeId>1</d2p1:OfficeId>
      <d2p1:OfficeName>sample string 5</d2p1:OfficeName>
      <d2p1:PackageType>Personal</d2p1:PackageType>
      <d2p1:ParentCarrierId>1</d2p1:ParentCarrierId>
      <d2p1:ParentCarrierName>sample string 7</d2p1:ParentCarrierName>
      <d2p1:PolicyType>Monoline</d2p1:PolicyType>
      <d2p1:RuleId>3</d2p1:RuleId>
      <d2p1:RuleWeight>4</d2p1:RuleWeight>
      <d2p1:SublineId>1</d2p1:SublineId>
      <d2p1:SublineName>sample string 9</d2p1:SublineName>
      <d2p1:Term>Annual</d2p1:Term>
      <d2p1:CommApplyAllLines>true</d2p1:CommApplyAllLines>
      <d2p1:PremiumTier>2</d2p1:PremiumTier>
      <d2p1:RuleEntries>
        <d2p1:CommRuleAgencyEntryDto>
          <d2p1:EntryId>1</d2p1:EntryId>
          <d2p1:LobId>1</d2p1:LobId>
          <d2p1:LobInternalCode>sample string 8</d2p1:LobInternalCode>
          <d2p1:LobName>sample string 7</d2p1:LobName>
          <d2p1:NewBusiness>2</d2p1:NewBusiness>
          <d2p1:Renewal>3</d2p1:Renewal>
          <d2p1:Rewrite>4</d2p1:Rewrite>
          <d2p1:RuleEntryIsPercent>true</d2p1:RuleEntryIsPercent>
          <d2p1:TierMax>5</d2p1:TierMax>
        </d2p1:CommRuleAgencyEntryDto>
        <d2p1:CommRuleAgencyEntryDto>
          <d2p1:EntryId>1</d2p1:EntryId>
          <d2p1:LobId>1</d2p1:LobId>
          <d2p1:LobInternalCode>sample string 8</d2p1:LobInternalCode>
          <d2p1:LobName>sample string 7</d2p1:LobName>
          <d2p1:NewBusiness>2</d2p1:NewBusiness>
          <d2p1:Renewal>3</d2p1:Renewal>
          <d2p1:Rewrite>4</d2p1:Rewrite>
          <d2p1:RuleEntryIsPercent>true</d2p1:RuleEntryIsPercent>
          <d2p1:TierMax>5</d2p1:TierMax>
        </d2p1:CommRuleAgencyEntryDto>
      </d2p1:RuleEntries>
    </d2p1:CommRuleAgencyDto>
    <d2p1:CommRuleAgencyDto>
      <d2p1:CarrierId>1</d2p1:CarrierId>
      <d2p1:CarrierName>sample string 6</d2p1:CarrierName>
      <d2p1:EffectiveOn>2024-11-21T09:52:31.6069894+00:00</d2p1:EffectiveOn>
      <d2p1:ExpiresOn>2024-11-21T09:52:31.6069894+00:00</d2p1:ExpiresOn>
      <d2p1:LobId>1</d2p1:LobId>
      <d2p1:LobList>
        <d2p1:CommRuleLobListItemDto>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CommRuleLobListItemDto>
        <d2p1:CommRuleLobListItemDto>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CommRuleLobListItemDto>
      </d2p1:LobList>
      <d2p1:LobName>sample string 10</d2p1:LobName>
      <d2p1:MgaId>1</d2p1:MgaId>
      <d2p1:MgaName>sample string 8</d2p1:MgaName>
      <d2p1:OfficeId>1</d2p1:OfficeId>
      <d2p1:OfficeName>sample string 5</d2p1:OfficeName>
      <d2p1:PackageType>Personal</d2p1:PackageType>
      <d2p1:ParentCarrierId>1</d2p1:ParentCarrierId>
      <d2p1:ParentCarrierName>sample string 7</d2p1:ParentCarrierName>
      <d2p1:PolicyType>Monoline</d2p1:PolicyType>
      <d2p1:RuleId>3</d2p1:RuleId>
      <d2p1:RuleWeight>4</d2p1:RuleWeight>
      <d2p1:SublineId>1</d2p1:SublineId>
      <d2p1:SublineName>sample string 9</d2p1:SublineName>
      <d2p1:Term>Annual</d2p1:Term>
      <d2p1:CommApplyAllLines>true</d2p1:CommApplyAllLines>
      <d2p1:PremiumTier>2</d2p1:PremiumTier>
      <d2p1:RuleEntries>
        <d2p1:CommRuleAgencyEntryDto>
          <d2p1:EntryId>1</d2p1:EntryId>
          <d2p1:LobId>1</d2p1:LobId>
          <d2p1:LobInternalCode>sample string 8</d2p1:LobInternalCode>
          <d2p1:LobName>sample string 7</d2p1:LobName>
          <d2p1:NewBusiness>2</d2p1:NewBusiness>
          <d2p1:Renewal>3</d2p1:Renewal>
          <d2p1:Rewrite>4</d2p1:Rewrite>
          <d2p1:RuleEntryIsPercent>true</d2p1:RuleEntryIsPercent>
          <d2p1:TierMax>5</d2p1:TierMax>
        </d2p1:CommRuleAgencyEntryDto>
        <d2p1:CommRuleAgencyEntryDto>
          <d2p1:EntryId>1</d2p1:EntryId>
          <d2p1:LobId>1</d2p1:LobId>
          <d2p1:LobInternalCode>sample string 8</d2p1:LobInternalCode>
          <d2p1:LobName>sample string 7</d2p1:LobName>
          <d2p1:NewBusiness>2</d2p1:NewBusiness>
          <d2p1:Renewal>3</d2p1:Renewal>
          <d2p1:Rewrite>4</d2p1:Rewrite>
          <d2p1:RuleEntryIsPercent>true</d2p1:RuleEntryIsPercent>
          <d2p1:TierMax>5</d2p1:TierMax>
        </d2p1:CommRuleAgencyEntryDto>
      </d2p1:RuleEntries>
    </d2p1:CommRuleAgencyDto>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfCommRuleAgencyDto>