PATCH api/maxoutofpockets/{id}

Patches an existing global max out of pocket resource

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Global Max out of pocket identifier

integer

Required

Body Parameters

The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target rule

JsonPatchDocument
NameDescriptionTypeAdditional information
Operations

Collection of Operation

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/json-patch+json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A patched global max out of pocket record

MaxOutOfPocketModel
NameDescriptionTypeAdditional 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

Sample:
{
  "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-16T15:08:59.0532746-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "maxOutOfPocketNo": 2
    },
    {
      "url": "sample string 3",
      "id": 4,
      "effectiveStartDate": "2025-07-16T15:08:59.0532746-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "maxOutOfPocketNo": 2
    }
  ]
}