GET api/formularies/{formularyid}/formularyproducts?page={page}&pagesize={pagesize}
Gets a collection of Formulary Product resources for a Formulary.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formularyid |
The id of the formulary for which formulary products will be returned |
integer |
Required |
page |
The 1-based index of the page of formulary products to return (optional, default is 1) |
integer |
Default value is 1 |
pagesize |
The number of formulary products to return per page (optional, default is 100, max is 200) |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
A paged collection of formulary product objects
PagedResultModelOfFormularyProductModelName | Description | Type | Additional information |
---|---|---|---|
PageNumber | integer |
None. |
|
PageCount | integer |
None. |
|
PageSize | integer |
None. |
|
Items | Collection of FormularyProductModel |
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 9", "id": 10, "formularyTierId": 1, "formularyTierUrl": "sample string 2", "productID": "sample string 3", "productIDType": "sample string 4", "therapeuticGroup": "sample string 5", "therapeuticClass": "sample string 6", "therapeuticSubClass": "sample string 7", "effectiveEndDate": "2025-05-30T21:08:45.4642729-05:00", "effectiveStartDate": "2025-05-30T21:08:45.4642729-05:00", "auditNote": "sample string 8" }, { "url": "sample string 9", "id": 10, "formularyTierId": 1, "formularyTierUrl": "sample string 2", "productID": "sample string 3", "productIDType": "sample string 4", "therapeuticGroup": "sample string 5", "therapeuticClass": "sample string 6", "therapeuticSubClass": "sample string 7", "effectiveEndDate": "2025-05-30T21:08:45.4642729-05:00", "effectiveStartDate": "2025-05-30T21:08:45.4642729-05:00", "auditNote": "sample string 8" } ], "totalRecordCount": 4 }