Get Rate Table Lookup Rows

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

Overview

Returns complete row data from a rate table in the insurance system. Unlike the /api/MetaData/RateTables/SelectList endpoint which returns only key-value pairs for dropdowns, this endpoint returns all columns from matching rate table rows for more complex rating scenarios.

What is a Rate Table Lookup Row? Rate tables store versioned rating data (rates, factors, codes, rules) that varies by:

  • Carrier (rating company)
  • Effective date (rate tables are date-versioned)
  • State (some rate tables are state-specific)
  • Rate table set (configured per insurance program)

This endpoint retrieves the complete row data for rating calculations, validation, or display purposes.

Key Difference from SelectList:

  • SelectList: Returns {Key, Description} pairs for populating dropdowns (2 columns)
  • RateTableLookupRows: Returns all columns from matching rows as key-value dictionaries

Typical Use Cases:

  • Rating calculations: Get rate factors, multipliers, or base rates for premium calculation
  • Multi-column lookups: Need more than just key and description (e.g., rate + territory + class)
  • Validation: Check if a combination of values exists in a rate table
  • Display: Show detailed rate table information to users

When to Use This Endpoint

Use RateTableLookupRows when:

  • ✅ Performing rating calculations that need rate factors, multipliers, or base rates
  • ✅ Need multiple columns from rate table rows (not just key and description)
  • ✅ Validating that a combination of match keys exists in a rate table
  • ✅ Displaying detailed rate table information to users
  • ✅ Building complex rating logic based on multiple rate table columns

Use SelectList endpoint instead when:

  • ❌ Only need key and description for a dropdown
  • ❌ Populating form field options (SelectList is optimized for this)

Use other metadata endpoints when:

  • ❌ Need form field metadata (use FormFields, ProposalFields, etc.)
  • ❌ Not working with rate tables at all
Query Params
string
required

This is an encrypted token containing rate table context (RateTableSetID, EffectiveDate, CarrierID, StateID).

This value that would have been included in the response payload of a prior MetaData lookup:

/api/MetaData/FormFields
/api/MetaData/ProposalFields
/api/MetaData/ProposalCoverageFields
/api/MetaData/ProposalScheduleFields
string
required

The exact name of the rate table to query (case-sensitive). This comes from system configuration documentation, not from metadata endpoints. Examples: "TerritoryTable", "WCClassCodeTable", "ConstructionTypeTable".

Understanding rateTableName

What is it?
The exact name of the rate table to query. This name matches the rate table definition in the system configuration.

Format:

  • Case-sensitive
  • No spaces (typically CamelCase or PascalCase)
  • Must match rate table name exactly as configured

Common Examples:

  • "TerritoryTable" - Territory codes and descriptions
  • "WCClassCodeTable" - Workers' compensation class codes
  • "ISOConstructionTypeTable" - ISO construction classifications
  • "ExperienceModTable" - Experience modification factors
  • "IncreasedLimitFactorTable" - Increased limit multipliers
  • "DeductibleCreditTable" - Deductible credit factors

How to find available table names:
Rate table names are not provided by metadata endpoints - they come from system configuration and documentation:

  • System configuration documentation - Lists rate tables configured for each insurance program
  • Technical specifications - Rating engine documentation for developers
  • Insurance program setup guides - Defines which tables are used for rating
  • Domain knowledge - Rating developers know which tables they need (e.g., TerritoryTable, WCClassCodeTable)
string

Optional JSON object containing match key filters. Keys are column names, values are filter values. Example: {"ZipCode":"02134","StateID":"23"}. If omitted, returns all rows (subject to rate table context filtering).

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