Brand
Treatment-medication
Get Medications

Get Medications

GET endpoint for /brand/treatment-medication/get-medications in brand category

Overview

  • Method: GET
  • Path: /brand/treatment-medication/get-medications
  • Tags: brand

Parameters

gender (query)

  • Type: object
  • Required: No
  • Description: gender query parameter

namesOnly (query)

  • Type: object
  • Required: No
  • Description: namesOnly query parameter

includeAilments (query)

  • Type: object
  • Required: No
  • Description: includeAilments query parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "type": "object",
  "properties": {
    "medications": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "dispenseNum": {
      "type": "number"
    },
    "dispenseUnit": {
      "type": "string"
    },
    "directions": {
      "type": "string"
    },
    "refills": {
      "type": "number"
    },
    "daysOfSupply": {
      "type": "number"
    },
    "ailments": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "displayOrder": {
      "type": "number"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "medications",
    "name",
    "displayName",
    "dispenseNum",
    "dispenseUnit",
    "directions",
    "refills",
    "daysOfSupply",
    "ailments",
    "category",
    "displayOrder",
    "created_at",
    "updated_at"
  ]
}

400

Bad Request

Content Type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "error",
    "details"
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  http://localhost:9000/brand/treatment-medication/get-medications \
  -H "Content-Type: application/json" \

Interactive Testing

You can test this endpoint interactively in the Swagger UI (opens in a new tab).

Get CompoundsUpdate Medications