GET api/v1/Today/PremiumMovementBonus/{AgencyId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AgencyId

string

Required

Body Parameters

None.

Response Information

Resource Description

PremiumMovementBonusSummaryDTO
NameDescriptionTypeAdditional information
AgencyParticipationStatus

string

None.

BonusTiers

Collection of PremiumMovementBonusTier

None.

BonusSummary

Collection of PremiumMovementBonusSummary

None.

About

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AgencyParticipationStatus": "sample string 1",
  "BonusTiers": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "ID": 1,
        "BonusLevel": "sample string 2",
        "MovedPoliciesMinCount": 1,
        "MovedPoliciesMaxCount": 1,
        "MovedPoliciesRange": "sample string 3",
        "BonusPayoutRate": 4.0,
        "BonusPayoutRateDescription": "sample string 5",
        "Active": true,
        "CreatedDateTime": "2025-04-29T14:00:30.4218196-04:00"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "BonusSummary": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "ID": 1,
        "AgencyDatabaseID": "sample string 2",
        "BonusLevel": "sample string 3",
        "BonusPayoutRateDescription": "sample string 4",
        "BonusPayoutRate": 5.0,
        "BonusEstimated": 1,
        "PolicyCountForNextLevel": 1,
        "MovedPolicyCount": 1,
        "MovedPremium": 1,
        "CreatedDateTime": "2025-04-29T14:00:30.4218196-04:00"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "About": "sample string 2"
}

application/xml, text/xml

Sample:
<PremiumMovementBonusSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAIS.API.Models.MobileApp">
  <About>sample string 2</About>
  <AgencyParticipationStatus>sample string 1</AgencyParticipationStatus>
  <BonusSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/RAIS.API.Models.Entities">
    <d2p1:PremiumMovementBonusSummary>
      <d2p1:AgencyDatabaseID>sample string 2</d2p1:AgencyDatabaseID>
      <d2p1:BonusEstimated>1</d2p1:BonusEstimated>
      <d2p1:BonusLevel>sample string 3</d2p1:BonusLevel>
      <d2p1:BonusPayoutRate>5</d2p1:BonusPayoutRate>
      <d2p1:BonusPayoutRateDescription>sample string 4</d2p1:BonusPayoutRateDescription>
      <d2p1:CreatedDateTime>2025-04-29T14:00:30.4218196-04:00</d2p1:CreatedDateTime>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MovedPolicyCount>1</d2p1:MovedPolicyCount>
      <d2p1:MovedPremium>1</d2p1:MovedPremium>
      <d2p1:PolicyCountForNextLevel>1</d2p1:PolicyCountForNextLevel>
    </d2p1:PremiumMovementBonusSummary>
    <d2p1:PremiumMovementBonusSummary>
      <d2p1:AgencyDatabaseID>sample string 2</d2p1:AgencyDatabaseID>
      <d2p1:BonusEstimated>1</d2p1:BonusEstimated>
      <d2p1:BonusLevel>sample string 3</d2p1:BonusLevel>
      <d2p1:BonusPayoutRate>5</d2p1:BonusPayoutRate>
      <d2p1:BonusPayoutRateDescription>sample string 4</d2p1:BonusPayoutRateDescription>
      <d2p1:CreatedDateTime>2025-04-29T14:00:30.4218196-04:00</d2p1:CreatedDateTime>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MovedPolicyCount>1</d2p1:MovedPolicyCount>
      <d2p1:MovedPremium>1</d2p1:MovedPremium>
      <d2p1:PolicyCountForNextLevel>1</d2p1:PolicyCountForNextLevel>
    </d2p1:PremiumMovementBonusSummary>
  </BonusSummary>
  <BonusTiers xmlns:d2p1="http://schemas.datacontract.org/2004/07/RAIS.API.Models.Entities">
    <d2p1:PremiumMovementBonusTier>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:BonusLevel>sample string 2</d2p1:BonusLevel>
      <d2p1:BonusPayoutRate>4</d2p1:BonusPayoutRate>
      <d2p1:BonusPayoutRateDescription>sample string 5</d2p1:BonusPayoutRateDescription>
      <d2p1:CreatedDateTime>2025-04-29T14:00:30.4218196-04:00</d2p1:CreatedDateTime>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MovedPoliciesMaxCount>1</d2p1:MovedPoliciesMaxCount>
      <d2p1:MovedPoliciesMinCount>1</d2p1:MovedPoliciesMinCount>
      <d2p1:MovedPoliciesRange>sample string 3</d2p1:MovedPoliciesRange>
    </d2p1:PremiumMovementBonusTier>
    <d2p1:PremiumMovementBonusTier>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:BonusLevel>sample string 2</d2p1:BonusLevel>
      <d2p1:BonusPayoutRate>4</d2p1:BonusPayoutRate>
      <d2p1:BonusPayoutRateDescription>sample string 5</d2p1:BonusPayoutRateDescription>
      <d2p1:CreatedDateTime>2025-04-29T14:00:30.4218196-04:00</d2p1:CreatedDateTime>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MovedPoliciesMaxCount>1</d2p1:MovedPoliciesMaxCount>
      <d2p1:MovedPoliciesMinCount>1</d2p1:MovedPoliciesMinCount>
      <d2p1:MovedPoliciesRange>sample string 3</d2p1:MovedPoliciesRange>
    </d2p1:PremiumMovementBonusTier>
  </BonusTiers>
</PremiumMovementBonusSummaryDTO>