Input representation of the optional filters that scope a price comparison for a group
census. Use these settings to narrow the comparison to a product category or to specific members,
and to control whether to get the plan and coverage attributes in the response.
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 |