api-docs v5.116.0

API Docs

Table of contents

Medicine_Formulation

Formulation - Delete

Back to top

Delete a specific medicine formulation. Can only delete user's own.

DELETE /medicine-formulations/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

uid of formulation

Examples

Example usage:

curl "https://yourdomain.com/medicine-formulations/<formulation-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
medicine String

medicine id
formulation String
classification String
form String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medicine-1-uid",
  "medicine": "medicine-id",
  "formulation": "some formulation"
}

Formulation - Find

Back to top

Fetch the list of medicine formulations registered in the database

GET /medicine-formulations

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medicine-formulations" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
formulations Object[]

array of medicine profiles
formulations.id String
formulations.medicine String
formulations.formulation String
formulations.classification String
formulations.form String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medicine-formulation-1-uid",
    "medicine": "medicine-id",
    "formulation": "some formulation"
  },
  {
    "id": "medicine-formulation-2-uid",
    "medicine": "medicine-id",
    "formulation": "some formulation"
  },
]

Formulation - Get

Back to top

Get a specific medicine formulation

GET /medicine-formulations/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

uid of formulation

Examples

Example usage:

curl "https://yourdomain.com/medicine-formulations/<formulation-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
medicine String

medicine id
formulation String
classification String
form String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medicine-1-uid",
  "medicine": "medicine-id",
  "formulation": "some formulation"
}

Formulation - Post

Back to top

Create/Register an medicine formulation

POST /medicine-formulations

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
formulation String
classification String
form String

Examples

Example usage:

curl "https://yourdomain.com/medicine-formulations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "medicine": "medicine-id",
    "formulation": "some formulation"
  }'

Parameters examples

json - Request-Example

{
  "medicine": "medicine-id",
  "formulation": "some formulation"
}

Success response

Success response - Success 200

Name Type Description
id String
medicine String

medicine id
formulation String
classification String
form String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medicine-1-uid",
  "medicine": "medicine-id",
  "formulation": "some formulation"
}

results matching ""

    No results matching ""