PATCH api/groups/{groupid}/groupplans/{groupplanid}/planincentives/{id}
Patches an existing plan incentive record
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| groupid |
Group identifier |
integer |
Required |
| groupplanid |
Group Plan Identifier |
integer |
Required |
| id |
Plan Incentive 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| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/json-patch+json
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A patched plan incentive record
PlanIncentiveModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PriceCodesUrl |
Gets or sets a link to the price code |
string |
None. |
| GroupPlanNo |
Gets or sets the identifier for the Group Plan associated with this plan incentive |
integer |
None. |
| Description |
Gets or sets the description of the plan incentive resource |
string |
None. |
| UseNetworkDrugPrice |
Gets or sets whether to use the drug unit price from the network plan |
boolean |
None. |
| LimitAmountPeriod |
Gets or sets the plan incentive limit per member for a period |
decimal number |
None. |
| LimitAmountMonth |
Gets or sets the plan incentive limit per member for a month |
decimal number |
None. |
| LimitMonthRollover |
Gets or sets whether to allow monthly amount to rollover within a period |
boolean |
None. |
| PlanIncentiveRates |
Gets or sets the plan insentive rates associated with this plan insentive model |
Collection of PlanIncentiveRateModel |
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,
"priceCodesUrl": "sample string 1",
"groupPlanNo": 2,
"description": "sample string 3",
"useNetworkDrugPrice": true,
"limitAmountPeriod": 1.0,
"limitAmountMonth": 1.0,
"limitMonthRollover": true,
"planIncentiveRates": [
{
"url": "sample string 4",
"id": 5,
"daysSupply": 1,
"priceCodeNo": 1,
"priceAdjustment": 1.0,
"amount": 1.0,
"amountPerUnit": true,
"inactive": true,
"priceCode2No": 1,
"priceAdjustment2": 1.0,
"amount2": 1.0,
"amountPerUnit2": true,
"applyDeductibleFirst": true,
"includeDeductibleInPostCalc": true,
"planIncentiveNo": 3
},
{
"url": "sample string 4",
"id": 5,
"daysSupply": 1,
"priceCodeNo": 1,
"priceAdjustment": 1.0,
"amount": 1.0,
"amountPerUnit": true,
"inactive": true,
"priceCode2No": 1,
"priceAdjustment2": 1.0,
"amount2": 1.0,
"amountPerUnit2": true,
"applyDeductibleFirst": true,
"includeDeductibleInPostCalc": true,
"planIncentiveNo": 3
}
]
}