PATCH api/groups/{groupid}/groupplans/{groupplanid}/plancontracts/{plancontractid}/benefitperiods/{id}

Patches an existing benefit period

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupid

Group identifier

integer

Required

groupplanid

Group Plan Identifier

integer

Required

plancontractid

Plan Contract Identifier

integer

Required

id

Pricing Group 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 plan pricing group

BenefitPeriodModel
NameDescriptionTypeAdditional information
PlanContractNo

Gets or sets the identifier for the Plan Contract associated with this benefit period

integer

None.

EffectiveStartDate

Gets or sets the effective start date of the benefit period

date

None.

FacilityARTypeNo

Gets or sets the Facility AR Type of the benefit period. This value is not required.

integer

None.

FacilityARTypeUrl

Url for the facility AR Type resource of this benefit period.

string

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,
  "planContractNo": 1,
  "effectiveStartDate": "2025-05-30T21:23:05.6035093-05:00",
  "facilityARTypeNo": 1,
  "facilityARTypeUrl": "sample string 3"
}