Skip to content

MedTechChainAPI.md

Latest commit

 

History

History
443 lines (314 loc) · 12.3 KB

MedTechChainAPI.md

File metadata and controls

443 lines (314 loc) · 12.3 KB
Raw

MedTech Chain

Backend API for the User Management Server.

Admin

Can do everything related to user management, i.e. the admin can do everything that a researcher can and more. However, the admin cannot run queries on the blockchain.

Register New Researcher

POST http://localhost:8088/api/users/register

The generated username and password will be sent to the specified email.

Request Headers

Header Value
Content-Type application/json
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Body

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "J.Doe@tudelft.nl",
  "affiliation": "Delft University of Technology"
}

Example

Request
curl --location 'http://localhost:8088/api/users/register' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk' \
--data-raw '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "J.Doe@tudelft.nl",
    "affiliation": "Delft University of Technology"
}'
Response

201 CREATED

This request does not return any response body.

Get All Researchers

GET http://localhost:8088/api/users/researchers

Request Headers

Header Value
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Example

Request
curl --location 'http://localhost:8088/api/users/researchers' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk'
Response

200 OK

[ {
  "user_id" : "8eeda5c8-8a4c-47de-bdac-880e8c69c233",
  "first_name" : "John",
  "last_name" : "Doe",
  "email" : "J.Doe@tudelft.nl",
  "affiliation" : "Delft University of Technology"
}, {
  "user_id" : "0abe1518-07a1-4782-a2fa-af4a5a2adf6b",
  "first_name" : "Jane",
  "last_name" : "Doe",
  "email" : "J.Doe-1@tudelft.nl",
  "affiliation" : "Delft University of Technology"
} ]

Update Personal Details

PUT http://localhost:8088/api/users/update?user_id=8eeda5c8-8a4c-47de-bdac-880e8c69c233

Request Headers

Header Value
Content-Type application/json
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Query Parameters

Parameter Value
user_id 8eeda5c8-8a4c-47de-bdac-880e8c69c233

Body

{
  "first_name": "John",
  "last_name": "Roe",
  "affiliation": "Delft University of Technology"
}

Example

Request
curl --location --request PUT 'http://localhost:8088/api/users/update?user_id=8eeda5c8-8a4c-47de-bdac-880e8c69c233' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk' \
--data '{
    "first_name": "John",
    "last_name": "Roe",
    "affiliation": "Delft University of Technology"
}'
Response

200 OK

This request does not return any response body.

Delete Researcher

DELETE http://localhost:8088/api/users/delete?user_id=8eeda5c8-8a4c-47de-bdac-880e8c69c233

Request Headers

Header Value
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Query Params

Parameter Value
user_id 8eeda5c8-8a4c-47de-bdac-880e8c69c233

Example

Request
curl --location --request DELETE 'http://localhost:8088/api/users/delete?user_id=8eeda5c8-8a4c-47de-bdac-880e8c69c233' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk'
Response

200 OK

This request does not return any response body.

Researcher

A researcher can only log in, change their password and query the chain.

Log In

POST http://localhost:8088/api/users/login

After a successful login attempt, the server sends back a JWT with the specified expiration time (in minutes).

Request Headers

Header Value
Content-Type application/json

Body

{
  "username": "jdoe",
  "password": "%n&Z*4vRj@q@S9ww3eUpX))4)s7&p+)8W]TljG4i"
}

Example

Request
curl --location 'http://localhost:8088/api/users/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "jdoe",
    "password": "%n&Z*4vRj@q@S9ww3eUpX))4)s7&p+)8W]TljG4i"
}'
Response

200 OK

{
    "jwt": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NTlhYTIwYy0zMTA2LTRhYzgtODNjNi02MjQzMGUzMTYxNDkiLCJyb2xlIjoiUkVTRUFSQ0hFUiIsImlhdCI6MTcwODkyNTAxMywiZXhwIjoxNzA4OTI4NjEzfQ.QiEpuZOzpUHE8bKWJ35nIqTjSw835pa-7HPgSl-HUJI",
    "token_type": "JWT",
    "expires_in": 15
}

Change Password

PUT http://localhost:8088/api/users/change_password

Request Headers

Header Value
Content-Type application/json

Body

{
  "username": "jdoe",
  "old_password": "%n&Z*4vRj@q@S9ww3eUpX))4)s7&p+)8W]TljG4i",
  "new_password": "more_secure_password"
}

Example

Request
curl --location --request PUT 'http://localhost:8088/api/users/change_password' \
--data '{
    "username": "jdoe",
    "old_password": "weak_password",
    "new_password": "more_secure_password"
}'
Response

200 OK

This request does not return any response body.

Run Query (Average)

POST http://localhost:8088/api/queries

Request Headers

Header Value
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Body

{
  "query_type" : "AVERAGE",
  "device_type" : "WEARABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE", "MEDIVALE", "HEALPOINT" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z",
  "field" : "rental_price"
}

Example

Request
curl --location 'http://localhost:8088/api/queries' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk' \
--data '{
  "query_type" : "AVERAGE",
  "device_type" : "WEARABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE", "MEDIVALE", "HEALPOINT" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z",
  "field" : "rental_price"
}'
Response

200 OK

{
    "result": 0
}

Run Query (Count)

POST http://localhost:8088/api/queries

Request Headers

Header Value
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Body

{
  "query_type" : "COUNT",
  "device_type" : "PORTABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE", "HEALPOINT" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z"
}

Example

Request
curl --location 'http://localhost:8088/api/queries' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk' \
--data '{
  "query_type" : "COUNT",
  "device_type" : "PORTABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE", "HEALPOINT" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z"
}'
Response

200 OK

{
    "result": 3
}

Run Query (Count All)

POST http://localhost:8088/api/queries

Request Headers

Header Value
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk

Body

{
  "query_type" : "COUNT_ALL",
  "device_type" : "PORTABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z",
  "field": "medical_speciality"
}

Example

Request
curl --location 'http://localhost:8088/api/queries' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMSIsInJvbGUiOiJyZXNlYXJjaGVyIn0.l-K2Bh-XtvtlTBsvn-2lRZxV6nGqjO8PuxRpiFH0Bhk' \
--data '{
  "query_type" : "COUNT_ALL",
  "device_type" : "PORTABLE_DEVICE",
  "hospital_list" : {
    "hospitals" : [ "LIFECARE" ]
  },
  "start_time" : "2024-03-29T16:26:01.141238759Z",
  "stop_time" : "2024-03-29T16:26:01.141332438Z",
  "field": "medical_speciality"
}'
Response

200 OK

{
    "result": {}
}