GET api/groupplans/{groupplanid}/formularies/{formularyid}/planquantitylimits/{id}
Gets a Plan Quantity Limit by formulary identifier and group plan identifier and plan quantity limit id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| groupplanid |
Group Plan Identifier |
integer |
Required |
| formularyid |
Formulary Identifier |
integer |
Required |
| id |
Plan Quantity limit identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
An quantity limit resource
PlanQuantityLimitModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FormularyCompanyQuantityLimitId |
Gets or sets the Formulary Company Quantity Limit ID |
integer |
None. |
| FormularyCompanyQuantityLimitUrl |
Gets or sets the Formulary Company Quantity Limit Url |
string |
None. |
| ProductID |
Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI. |
string |
None. |
| ProductIDType |
Gets or sets the product ID Type for this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid. |
string |
None. |
| MaxAmount |
Gets or sets the Max Amount |
decimal number |
None. |
| MaxAmountQualifier |
Gets or sets the two letter code representing the qualifier for the max amount value DS - Days Supply FL - Fills DL - Dollar Amount QY - Quantity |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 6",
"id": 7,
"formularyCompanyQuantityLimitId": 1,
"formularyCompanyQuantityLimitUrl": "sample string 2",
"productID": "sample string 3",
"productIDType": "sample string 4",
"maxAmount": 1.0,
"maxAmountQualifier": 0,
"maxAmountTimePeriod": 0,
"maxAmountTimePeriodStartDate": "2025-05-30T21:07:42.5869131-05:00",
"maxAmountTimePeriodEndDate": "2025-05-30T21:07:42.5869131-05:00",
"maxAmountTimePeriodUnits": "sample string 5",
"effectiveStartDate": "2025-05-30T21:07:42.5869131-05:00",
"effectiveEndDate": "2025-05-30T21:07:42.5869131-05:00",
"createdOn": "2025-05-30T21:07:42.5869131-05:00",
"needsReview": true,
"optOut": true,
"modified": true
}