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

Gets a collection of step medications tied to the specified formulary

Request Information

URI Parameters

Name	Description	Type	Additional information
formularyid	The id of the formulary for which step medications will be returned	integer	Required
page	The 1-based index of the page of step medications to return (optional, 1 by default)	integer	Default value is 1
pagesize	The number of step medications 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 step medication objects

PagedResultModelOfFormularyCompanyStepMedicationModel

Name	Type	Additional information
PageNumber	integer	None.
PageCount	integer	None.
PageSize	integer	None.
Items	Collection of FormularyCompanyStepMedicationModel	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 11",
      "id": 12,
      "companyStepMedicationSeqNo": 1,
      "companyStepMedicationUrl": "sample string 1",
      "productID": "sample string 3",
      "productIDType": "sample string 4",
      "name": "sample string 5",
      "noOfDrugsToTry": 1,
      "stepOrder": "sample string 6",
      "diagnosisCode": "sample string 7",
      "effectiveStartDate": "2025-05-30T21:22:02.3852692-05:00",
      "effectiveEndDate": "2025-05-30T21:22:02.3852692-05:00",
      "active": true,
      "stepDrugMultiSourceCodesUrl": "sample string 9",
      "stepDrugProductsUrl": "sample string 10",
      "stepDrugs": [
        {
          "url": "sample string 7",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "stepDrugProductID": "sample string 3",
          "stepDrugProductIDType": "sample string 4",
          "stepDrugClassID": "sample string 5",
          "stepDrugSubClassID": "sample string 6",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        },
        {
          "url": "sample string 7",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "stepDrugProductID": "sample string 3",
          "stepDrugProductIDType": "sample string 4",
          "stepDrugClassID": "sample string 5",
          "stepDrugSubClassID": "sample string 6",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        }
      ],
      "multiSourceCodes": [
        {
          "url": "sample string 4",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "multiSourceCode": "sample string 3",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        },
        {
          "url": "sample string 4",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "multiSourceCode": "sample string 3",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        }
      ]
    },
    {
      "url": "sample string 11",
      "id": 12,
      "companyStepMedicationSeqNo": 1,
      "companyStepMedicationUrl": "sample string 1",
      "productID": "sample string 3",
      "productIDType": "sample string 4",
      "name": "sample string 5",
      "noOfDrugsToTry": 1,
      "stepOrder": "sample string 6",
      "diagnosisCode": "sample string 7",
      "effectiveStartDate": "2025-05-30T21:22:02.3852692-05:00",
      "effectiveEndDate": "2025-05-30T21:22:02.3852692-05:00",
      "active": true,
      "stepDrugMultiSourceCodesUrl": "sample string 9",
      "stepDrugProductsUrl": "sample string 10",
      "stepDrugs": [
        {
          "url": "sample string 7",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "stepDrugProductID": "sample string 3",
          "stepDrugProductIDType": "sample string 4",
          "stepDrugClassID": "sample string 5",
          "stepDrugSubClassID": "sample string 6",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        },
        {
          "url": "sample string 7",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "stepDrugProductID": "sample string 3",
          "stepDrugProductIDType": "sample string 4",
          "stepDrugClassID": "sample string 5",
          "stepDrugSubClassID": "sample string 6",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        }
      ],
      "multiSourceCodes": [
        {
          "url": "sample string 4",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "multiSourceCode": "sample string 3",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        },
        {
          "url": "sample string 4",
          "id": 0,
          "seqNo": 1,
          "companyStepMedicationSeqNo": 2,
          "multiSourceCode": "sample string 3",
          "isActive": true,
          "createdOn": "2025-05-30T21:22:02.386268-05:00",
          "changedOn": "2025-05-30T21:22:02.386268-05:00"
        }
      ]
    }
  ],
  "totalRecordCount": 4
}