api-docs v5.116.0

API Docs

Table of contents

Medicine_Configuration

Medicine Configuration - Delete

Back to top

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

DELETE /medicine-configurations/: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>"
}

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
medicine string
brandName string
drugType string
beforeFood string
afterFood string
morning string
afternoon string
night string
duration number
durationUnit string
dispense string
dosageSig string
dosageAmount number
frequency string
frequencyReminderInterval number
formulation string
note string
label string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Medicine Configuration - Find

Back to top

Get list of medicine configurations

GET /medicine-configurations

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-configurations" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicineConfigurations object[]

array of medicineConfiguration
medicineConfigurations.id string
medicineConfigurations.createdAt number

timestamp

Default value: currentTime
medicineConfigurations.createdBy string

account uid
medicineConfigurations.medicine string
medicineConfigurations.brandName string
medicineConfigurations.drugType string
medicineConfigurations.beforeFood string
medicineConfigurations.afterFood string
medicineConfigurations.morning string
medicineConfigurations.afternoon string
medicineConfigurations.night string
medicineConfigurations.duration number
medicineConfigurations.durationUnit string
medicineConfigurations.dispense string
medicineConfigurations.dosageSig string
medicineConfigurations.dosageAmount number
medicineConfigurations.frequency string
medicineConfigurations.frequencyReminderInterval number
medicineConfigurations.formulation string
medicineConfigurations.note string
medicineConfigurations.label string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Medicine Configuration - Get

Back to top

Get a specific medicine configuration

GET /medicine-configurations/: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>"
}

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
medicine string
brandName string
drugType string
beforeFood string
afterFood string
morning string
afternoon string
night string
duration number
durationUnit string
dispense string
dosageSig string
dosageAmount number
frequency string
frequencyReminderInterval number
formulation string
note string
label string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Medicine Configuration - Patch

Back to top

Update medicine configuration

PATCH /medicine-configurations/: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
brandName string optional
drugType string optional
beforeFood string optional
afterFood string optional
morning string optional
afternoon string optional
night string optional
duration number optional
durationUnit string optional
dispense string optional
dosageSig string optional
dosageAmount number optional
frequency string optional
frequencyReminderInterval number optional
formulation string optional
note string optional
label string optional
createdAt string optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/medicine-configurations/<medicine-configuration-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "brandName": "some brand name"
  }'

Parameters examples

json - Request-Example

{
  "brandName": "some brand name"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
medicine string
brandName string
drugType string
beforeFood string
afterFood string
morning string
afternoon string
night string
duration number
durationUnit string
dispense string
dosageSig string
dosageAmount number
frequency string
frequencyReminderInterval number
formulation string
note string
label string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Medicine Configuration - Post

Back to top

Create medicine configuration

POST /medicine-configurations

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
medicine string
brandName string optional
drugType string optional
beforeFood string optional
afterFood string optional
morning string optional
afternoon string optional
night string optional
duration number optional
durationUnit string optional
dispense string optional
dosageSig string optional
dosageAmount number optional
frequency string optional
frequencyReminderInterval number optional
formulation string optional
note string optional
label string optional
createdAt string optional

timestamp

Default value: currentTime

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "medicine": "medicine-id",
  "brandName": "some brand name"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
medicine string
brandName string
drugType string
beforeFood string
afterFood string
morning string
afternoon string
night string
duration number
durationUnit string
dispense string
dosageSig string
dosageAmount number
frequency string
frequencyReminderInterval number
formulation string
note string
label string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""