GET api/formularies/{formularyid}/formularycompanyquantitylimits?page={page}&pagesize={pagesize}

Gets a collection of quantity limits tied to the specified formulary

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formularyid

The id of the formulary for which quantity limits will be returned

integer

Required

page

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

integer

Default value is 1

pagesize

The number of quantity limits 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 quantity limit objects

PagedResultModelOfFormularyCompanyQuantityLimitModel
NameDescriptionTypeAdditional information
PageNumber

integer

None.

PageCount

integer

None.

PageSize

integer

None.

Items

Collection of FormularyCompanyQuantityLimitModel

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 5",
      "id": 6,
      "companyQuantityLimitNo": 1,
      "companyQuantityLimitUrl": "sample string 1",
      "productID": "sample string 2",
      "productIDType": "sample string 3",
      "maxAmount": 1.0,
      "maxAmountQualifier": 0,
      "maxAmountTimePeriod": 0,
      "maxAmountTimePeriodStartDate": "2025-05-30T20:58:59.6288209-05:00",
      "maxAmountTimePeriodEndDate": "2025-05-30T20:58:59.6288209-05:00",
      "maxAmountTimePeriodUnits": "sample string 4",
      "effectiveStartDate": "2025-05-30T20:58:59.6288209-05:00",
      "effectiveEndDate": "2025-05-30T20:58:59.6288209-05:00",
      "active": true
    },
    {
      "url": "sample string 5",
      "id": 6,
      "companyQuantityLimitNo": 1,
      "companyQuantityLimitUrl": "sample string 1",
      "productID": "sample string 2",
      "productIDType": "sample string 3",
      "maxAmount": 1.0,
      "maxAmountQualifier": 0,
      "maxAmountTimePeriod": 0,
      "maxAmountTimePeriodStartDate": "2025-05-30T20:58:59.6288209-05:00",
      "maxAmountTimePeriodEndDate": "2025-05-30T20:58:59.6288209-05:00",
      "maxAmountTimePeriodUnits": "sample string 4",
      "effectiveStartDate": "2025-05-30T20:58:59.6288209-05:00",
      "effectiveEndDate": "2025-05-30T20:58:59.6288209-05:00",
      "active": true
    }
  ],
  "totalRecordCount": 4
}