POST v1/Commissions/AgencyRules/Update

Adds or updates a commission rule for the agency

Request Information

URI Parameters

None.

Body Parameters

CommRuleAgencyDto
NameDescriptionTypeAdditional information
CommApplyAllLines

boolean

None.

PremiumTier

integer

None.

RuleEntries

Collection of CommRuleAgencyEntryDto

None.

RuleId

integer

None.

PolicyType

EnumPolicyType

None.

PackageType

EnumPackageType

None.

Term

EnumPolicyTerm

None.

OfficeId

integer

None.

MgaId

integer

None.

ParentCarrierId

integer

None.

CarrierId

integer

None.

SublineId

integer

None.

LobId

integer

None.

RuleWeight

integer

None.

EffectiveOn

date

None.

ExpiresOn

date

None.

OfficeName

string

None.

CarrierName

string

None.

ParentCarrierName

string

None.

MgaName

string

None.

SublineName

string

None.

LobName

string

None.

LobList

Collection of CommRuleLobListItemDto

None.

Request Formats

application/json, text/json

Sample:
{
  "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": "2017-08-20T08:11:57.5053467+00:00",
  "ExpiresOn": "2017-08-20T08:11:57.5053467+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"
    }
  ]
}

application/xml, text/xml

Sample:
<CommRuleAgencyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.CommissionCentral">
  <CarrierId>1</CarrierId>
  <CarrierName>sample string 6</CarrierName>
  <EffectiveOn>2017-08-20T08:11:57.5053467+00:00</EffectiveOn>
  <ExpiresOn>2017-08-20T08:11:57.5053467+00:00</ExpiresOn>
  <LobId>1</LobId>
  <LobList>
    <CommRuleLobListItemDto>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </CommRuleLobListItemDto>
    <CommRuleLobListItemDto>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </CommRuleLobListItemDto>
  </LobList>
  <LobName>sample string 10</LobName>
  <MgaId>1</MgaId>
  <MgaName>sample string 8</MgaName>
  <OfficeId>1</OfficeId>
  <OfficeName>sample string 5</OfficeName>
  <PackageType>Personal</PackageType>
  <ParentCarrierId>1</ParentCarrierId>
  <ParentCarrierName>sample string 7</ParentCarrierName>
  <PolicyType>Monoline</PolicyType>
  <RuleId>3</RuleId>
  <RuleWeight>4</RuleWeight>
  <SublineId>1</SublineId>
  <SublineName>sample string 9</SublineName>
  <Term>Annual</Term>
  <CommApplyAllLines>true</CommApplyAllLines>
  <PremiumTier>2</PremiumTier>
  <RuleEntries>
    <CommRuleAgencyEntryDto>
      <EntryId>1</EntryId>
      <LobId>1</LobId>
      <LobInternalCode>sample string 8</LobInternalCode>
      <LobName>sample string 7</LobName>
      <NewBusiness>2</NewBusiness>
      <Renewal>3</Renewal>
      <Rewrite>4</Rewrite>
      <RuleEntryIsPercent>true</RuleEntryIsPercent>
      <TierMax>5</TierMax>
    </CommRuleAgencyEntryDto>
    <CommRuleAgencyEntryDto>
      <EntryId>1</EntryId>
      <LobId>1</LobId>
      <LobInternalCode>sample string 8</LobInternalCode>
      <LobName>sample string 7</LobName>
      <NewBusiness>2</NewBusiness>
      <Renewal>3</Renewal>
      <Rewrite>4</Rewrite>
      <RuleEntryIsPercent>true</RuleEntryIsPercent>
      <TierMax>5</TierMax>
    </CommRuleAgencyEntryDto>
  </RuleEntries>
</CommRuleAgencyDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActionResultDTOOfInt32
NameDescriptionTypeAdditional information
Result

integer

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": 1,
  "CreatedBy": "sample string 2",
  "EntityID": 3,
  "RowSource": "sample string 4",
  "PolicyID": 5,
  "IsSuccess": true,
  "ErrorCode": "sample string 7",
  "ErrorMessage": "sample string 8",
  "InfoMessage": "sample string 9"
}

application/xml, text/xml

Sample:
<ActionResultOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 7</ErrorCode>
  <ErrorMessage>sample string 8</ErrorMessage>
  <InfoMessage>sample string 9</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 2</CreatedBy>
  <EntityID>3</EntityID>
  <PolicyID>5</PolicyID>
  <Result>1</Result>
  <RowSource>sample string 4</RowSource>
</ActionResultOfint>