Get Plan Rules
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Platform GUID of the participant (person_id).
Platform GUID of the plan (BenefitsOffering.PlanSystemId).
Response
Successfully retrieved plan rules.
Response Attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Section 5 — plan group balances ordered by effective date.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Balance grid for the full plan template (Section 9).
Show child attributes
Balance grid for the limited reimbursement section (Section 10).
Show child attributes
Show child attributes
Invalid request parameters (e.g. malformed GUID).
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
The caller is not authenticated or does not hold the required scope
(ReadClaims). This code is emitted exclusively by the ASP.NET
authorization filter and the System.UnauthorizedAccessException
catch block — it is never used for identity or plan lookup failures.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Returned when the handler cannot produce a result for any of the following reasons: The consumer_id cannot be resolved to a known platform identity (unknown participant or a token with no resolvable person record). The plan_id does not exist in the participant's shard, or the participant has no active enrollment election for that plan. The plan type is not supported by the rules engine (e.g. HSA plans are suppressed at Gate 2 and the engine returns null).
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected server error; the request may be retried.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: