GET api/groups/{groupid}/groupplans/{groupplanid}/maxoutofpockets
Gets a collection of max out of pocket resources for a Group Plan
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupid |
Group identifier |
integer |
Required |
groupplanid |
Group Plan identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of max out of pocket resources
Collection of MaxOutOfPocketModelName | Description | Type | Additional information |
---|---|---|---|
GroupPlanNo |
Gets or sets the identifier for the Group Plan associated with this MaxOutOfPocket |
integer |
None. |
Description |
Gets or sets the description of this max out of pocket resource |
string |
None. |
PersonAmount |
Gets or sets the max out of pocket amount for members *DEPRECATED - moved to MaxOutOfPocketRates. will be removed at a later date |
decimal number |
None. |
FamilyAmount |
Gets or sets the max out of pocket amount for families *DEPRECATED - moved to MaxOutOfPocketRates. will be removed at a later date |
decimal number |
None. |
MemberPortalDescription |
Gets or sets the description to show on the member portal |
string |
None. |
MaxOutOfPocketRates |
Gets or sets the MaxOutOfPocketRates associated with this MaxOutOfPocket model |
Collection of MaxOutOfPocketRateModel |
None. |
Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
[ { "url": "sample string 4", "id": 5, "groupPlanNo": 1, "description": "sample string 2", "personAmount": 1.0, "familyAmount": 1.0, "memberPortalDescription": "sample string 3", "maxOutOfPocketRates": [ { "url": "sample string 3", "id": 4, "effectiveStartDate": "2025-07-16T16:05:58.9407237-05:00", "personAmount": 1.0, "familyAmount": 1.0, "maxOutOfPocketNo": 2 }, { "url": "sample string 3", "id": 4, "effectiveStartDate": "2025-07-16T16:05:58.9407237-05:00", "personAmount": 1.0, "familyAmount": 1.0, "maxOutOfPocketNo": 2 } ] }, { "url": "sample string 4", "id": 5, "groupPlanNo": 1, "description": "sample string 2", "personAmount": 1.0, "familyAmount": 1.0, "memberPortalDescription": "sample string 3", "maxOutOfPocketRates": [ { "url": "sample string 3", "id": 4, "effectiveStartDate": "2025-07-16T16:05:58.9407237-05:00", "personAmount": 1.0, "familyAmount": 1.0, "maxOutOfPocketNo": 2 }, { "url": "sample string 3", "id": 4, "effectiveStartDate": "2025-07-16T16:05:58.9407237-05:00", "personAmount": 1.0, "familyAmount": 1.0, "maxOutOfPocketNo": 2 } ] } ]