GET api/cmppformulary/{formularyID}/cmppformularyproduct?tier={tier}&nameStartsWith={nameStartsWith}&page={page}&pageSize={pageSize}

Gets a paged result of formulary products for a given formulary id for authorized location

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formularyID

Formulary identifier

integer

Required

tier

Tier

integer

None.

nameStartsWith

Optional parameter to search products by name

string

None.

page

Parameter to supply page

integer

Default value is 1

pageSize

Parameter to supply page size

integer

Default value is 100

Body Parameters

None.

Response Information

Resource Description

A paged result formulary products

PagedResultModelOfFormularyProductCMPPModel
NameDescriptionTypeAdditional information
PageNumber

integer

None.

PageCount

integer

None.

PageSize

integer

None.

Items

Collection of FormularyProductCMPPModel

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 17",
      "id": 18,
      "productID": "sample string 1",
      "productIDType": "sample string 2",
      "tier": 3,
      "tierName": "sample string 4",
      "drugName": "sample string 5",
      "genericName": "sample string 6",
      "dosageForm": "sample string 7",
      "dosageFormDescription": "sample string 8",
      "strength": "sample string 9",
      "strengthUnitOfMeasure": "sample string 10",
      "strengthDescription": "sample string 11",
      "drugAndStrength": "sample string 12",
      "routeOfAdministration": "sample string 13",
      "isBrand": true,
      "therapeuticGroup": "sample string 14",
      "quantity": 15.0,
      "networkPriceInfo": [
        {
          "networkName": "sample string 1",
          "avgWAC": 1.0,
          "cmppPrice": 1.0,
          "logoURL": "sample string 2",
          "seqNo": 3
        },
        {
          "networkName": "sample string 1",
          "avgWAC": 1.0,
          "cmppPrice": 1.0,
          "logoURL": "sample string 2",
          "seqNo": 3
        }
      ],
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "drugIdentifier": "sample string 16"
    },
    {
      "url": "sample string 17",
      "id": 18,
      "productID": "sample string 1",
      "productIDType": "sample string 2",
      "tier": 3,
      "tierName": "sample string 4",
      "drugName": "sample string 5",
      "genericName": "sample string 6",
      "dosageForm": "sample string 7",
      "dosageFormDescription": "sample string 8",
      "strength": "sample string 9",
      "strengthUnitOfMeasure": "sample string 10",
      "strengthDescription": "sample string 11",
      "drugAndStrength": "sample string 12",
      "routeOfAdministration": "sample string 13",
      "isBrand": true,
      "therapeuticGroup": "sample string 14",
      "quantity": 15.0,
      "networkPriceInfo": [
        {
          "networkName": "sample string 1",
          "avgWAC": 1.0,
          "cmppPrice": 1.0,
          "logoURL": "sample string 2",
          "seqNo": 3
        },
        {
          "networkName": "sample string 1",
          "avgWAC": 1.0,
          "cmppPrice": 1.0,
          "logoURL": "sample string 2",
          "seqNo": 3
        }
      ],
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "drugIdentifier": "sample string 16"
    }
  ],
  "totalRecordCount": 4
}