GET api/groupplans/{groupplanid}/formularies/{formularyid}/planformularyproducts?page={page}&pagesize={pagesize}

Gets a collection of Plan Formulary Products by formulary identifier and group plan identifier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupplanid

Group Plan Identifier

integer

Required

formularyid

Plan Formulary Identifier

integer

Required

page

The 1-based index of the page of plan age limits to return (optional, 1 by default)

integer

Default value is 1

pagesize

The number of plan formulary products to return per page (optional, 25 by default, max 100)

integer

Default value is 25

Body Parameters

None.

Response Information

Resource Description

A list of plan formulary product objects

PagedResultModelOfPlanFormularyProductModel
NameDescriptionTypeAdditional information
PageNumber

integer

None.

PageCount

integer

None.

PageSize

integer

None.

Items

Collection of PlanFormularyProductModel

None.

TotalRecordCount

integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "pageNumber": 1,
  "pageCount": 2,
  "pageSize": 3,
  "items": [
    {
      "url": "sample string 6",
      "id": 7,
      "formularyProductId": 1,
      "formularyProductUrl": "sample string 1",
      "formularyTierId": 1,
      "formularyTierUrl": "sample string 2",
      "productID": "sample string 3",
      "productIDType": "sample string 4",
      "effectiveEndDate": "2025-05-30T21:26:31.3371203-05:00",
      "effectiveStartDate": "2025-05-30T21:26:31.3371203-05:00",
      "needsReview": true,
      "optOut": true,
      "modified": true,
      "auditNote": "sample string 5",
      "parentRemoved": true
    },
    {
      "url": "sample string 6",
      "id": 7,
      "formularyProductId": 1,
      "formularyProductUrl": "sample string 1",
      "formularyTierId": 1,
      "formularyTierUrl": "sample string 2",
      "productID": "sample string 3",
      "productIDType": "sample string 4",
      "effectiveEndDate": "2025-05-30T21:26:31.3371203-05:00",
      "effectiveStartDate": "2025-05-30T21:26:31.3371203-05:00",
      "needsReview": true,
      "optOut": true,
      "modified": true,
      "auditNote": "sample string 5",
      "parentRemoved": true
    }
  ],
  "totalRecordCount": 4
}