Get Generics

The Drug API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP to authenticate.

HTTP REQUEST

Get Generic

get

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Query parameters

SearchQuerystringOptional

PageNumberinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Generic

HTTPcURLJavaScriptPython

GET /api/v1/Generic HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "dosage": "text"
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com"
}

Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

Get Generic by ID

Get Generic by Id

get

e.g GET /api/v1/a69ec22e-892f-401c-b447-7aec13caa6bd

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Path parameters

Idstring · uuidRequired

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Generic/{Id}

HTTPcURLJavaScriptPython

GET /api/v1/Generic/{Id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "dosage": "text"
  }
}

Good to know: This API method was auto-generated from an example Swagger file. You'll see that it's not editable – that's because the contents are synced to an URL! Any time the linked file changes, the documentation will change too.

Get Generic by Lite

Get All Generics For Drop Down

get

e.g GET /api/v1/generic/dropdown

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Generic/lite

HTTPcURLJavaScriptPython

GET /api/v1/Generic/lite HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ]
}