Compare the previous and the current cost for a group census for one member and its
associated dependents, or the summary for the entire census, to view the impact of enrollment,
adjustment, or renewal before it's finalized. The comparison can cover a single product category
or all product categories. You can also compare plan attributes by using this API. By default,
the API returns the price comparison details. Set fetchAttributes to true to retrieve plan
attribute differences instead of price comparison details.
Resource
{censusId} is a placeholder.
/connect/insurance/group-censuses/{censusId}/price-comparisons
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/price-comparisons
Available Version
68.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| censusId | String | ID of the group census to compare the prices for. | Required | 68.0 |
Request Body for POST
JSON Example
{
"category": "0ZGIO0000000gAX4AY",
"fetchAttributes": false,
"memberIds": {
"values": [
"0r6IO0000004F25AE"
]
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| category | String | ID of the product category to filter the comparison. If not specified, the API returns only the overall summary and the list of available categories. | Optional | 68.0 |
| fetchAttributes | Boolean | Indicates whether to return the attributes of the root products and coverages, such
as copay and coinsurance (true) or not (false). The default value is false. If set to true, the API returns plan attribute differences instead of price comparison details. |
Optional | 68.0 |
| memberIds | String[] | List of group census member IDs to compare prices for. If not specified, the API returns the summary view of the census instead of member-level comparisons. | Optional | 68.0 |