Get a Proposal's Schedule Rating Categories

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns the schedule rating categories for a proposal's schedule domain and rate table. These categories define the numeric ranges and precision used when rating individual scheduled items (e.g., buildings, vehicles) against a rate table, and directly affect how those items contribute to the premium calculation.

Examples

Scenario 1: Retrieve schedule rating categories for a domain:

GET /api/Quotes/Proposals/12345/Schedules/ProposalLocation/ScheduleRatingCategories?rateTableName=BuildingRates&stateID=10
200 OK
[
  {
    "RateTableContentID": 501,
    "Category": "Fire Protection",
    "LowLimit": -25.0,
    "HighLimit": 25.0,
    "Precision": 2,
    "PrecisionStep": 0.01
  },
  {
    "RateTableContentID": 502,
    "Category": "Electrical",
    "LowLimit": -10.0,
    "HighLimit": 10.0,
    "Precision": 0,
    "PrecisionStep": 1.0
  }
]

Scenario 2: No categories found for the given parameters:

GET /api/Quotes/Proposals/12345/Schedules/ProposalLocation/ScheduleRatingCategories?rateTableName=UnknownTable&stateID=10
200 OK
[]
Path Params
integer
required

The ID of the Proposal.

string
required

The schedule domain name identifying the type of scheduled item (e.g., locations, vehicles). Use GET .../Schedules/Domains to discover available domains. Example: ProposalLocation.

Query Params
string
required

The name of the rate table containing the categories. The rateTableName value is determined by the client's policy configuration. There is no discovery endpoint in this API for listing available rate table names; callers must know the rate table name from their policy setup.

integer

If applicable, the State ID to filter categories by state. Pass null if not state-specific.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json