validateApiRequest(insRequestValidationInputRepresentation)

Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model.

API Version

68.0

Requires Chatter

Signature

public static ConnectApi.InsRequestValidationRepresentation validateApiRequest(ConnectApi.InsRequestValidationInputRepresentation insRequestValidationInputRepresentation)

Parameters

insRequestValidationInputRepresentation

Type: ConnectApi.InsRequestValidationInputRepresentation

Required. Input that specifies the insurance Connect API path and the serialized JSON request body to validate.

Return Value

Type: ConnectApi.InsRequestValidationRepresentation

Usage

Use this method at design time to pre-validate an Insurance Connect API request body before submission. Provide an API path such as insurance/quotes or insurance/product-rating, and a serialized JSON request body. The method verifies product references, hierarchy relationships, instance keys, attribute definitions, and JSON structure, and returns actionable findings for any detected issues.

Validation includes these checks:

Product code existence and active status
Parent-child hierarchy structure in quoteLineItems / salesTransactionItems and nested childProducts
Non-empty instanceKey arrays in instanceKeys entries
Attribute code existence and active status against registered AttributeDefinition records
JSON parse validation for the request body string

For unsupported API paths, the method returns a valid result with an informational message rather than an error. Supported paths are insurance/quotes and insurance/product-rating.

When validation succeeds, isValid is true and results is empty or contains only informational findings. When validation finds issues, isValid is false and results lists the findings. When required input is missing, errors can include request-level failures such as:

SF-INS-DSAV-00041 — the request payload is required. Provide a valid JSON payload and API path.

Example

This sample validates an API request payload from Apex.

1ConnectApi.InsRequestValidationInputRepresentation input =
2    new ConnectApi.InsRequestValidationInputRepresentation();
3input.apiPath     = 'insurance/product-rating';
4input.requestBody = '{"ratingInputs":[{"productCode":"autoSilver"}]}';
5
6ConnectApi.InsRequestValidationRepresentation result =
7    ConnectApi.InsuranceDesignAdvisorFamily.validateApiRequest(input);
8
9System.debug('isValid=' + result.isValid);
10System.debug('results=' + result.results);
11System.debug('errors=' + result.errors);