Get Rating Input (POST)

Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API (/connect/insurance/product-rating) after replacing sample values with real data.

Use this resource at design time to generate a sample rating input payload for a root insurance product. Provide a Product2 ID. The API traverses the product hierarchy, including bundles, components, and attributes, builds a fully populated sample request body suitable for /connect/insurance/product-rating, and returns it as a JSON string in ratingInput.

The generated payload includes product codes, instance keys, and attribute codes with sample values. Parse the ratingInput string, replace sample values with real data, and then submit the result to the product-rating API. Review additionalDetails for guidance about fields the sample may omit, such as transactionType.

When generation succeeds, ratingInput contains the sample payload and errors is empty or absent. When generation fails, errors lists the failures. Examples include:

SF-INS-DSAV-00013 — a product ID is required. Specify a valid product ID. Returned with HTTP status 400 when productId is missing.
SF-INS-DSAV-00014 — the specified product ID doesn’t exist or isn’t accessible. Returned with HTTP status 400.

Insufficient access, or Design Advisor not enabled for the org, returns HTTP status 403. An unexpected failure returns HTTP status 500.

Resource

1/connect/insurance/design-advisor/get-rating-input

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/get-rating-input

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "productId": "01txx0000006iPnAAI"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`productId`	String	ID of the product for which you want to generate a sample rating API request. Must be a valid 15- or 18-character Salesforce ID.	Required	68.0

Response Body for POST

Insurance Get Rating Input Response