Psiconexia API

This API containts all the routes necessary to send and fetch data to use in the Psiconexia app

Levels
Evaluations
Users
Submodules v1
Pquestions
Modules
Auth
Patients

Levels 5

raw

POST new level | POST {{URL}}/api/v1/levels

Description

This route allows certain roles to add a new level

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "title": "Tercera edad", "ageFrom": 65, "ageTo": 105 }

GET all levels | GET {{URL}}/api/v1/levels

raw

GET single level | GET {{URL}}/api/v1/levels/600819b9bd48530f50cf3d92

Description

Route to fetch single level from Psiconexia Predict

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

raw

EDIT existing level | PUT {{URL}}/api/v1/levels/601d6e0ad6f14209040f39c7

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "ageFrom": 20 }

raw

DELETE single level | DELETE {{URL}}/api/v1/levels/6008196d49e68c0f20b0ee97

Description

Route to delete one of the levels

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Evaluations 5

raw

POST new evaluation | POST {{URL}}/api/v1/evaluations/6102b7a1a41be4146c4767c4/62dfbcf7fd81163f9925a3ff

Description

This route allows certain roles to add a new level

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "questions": [], "results": [] }

GET all evaluations | GET {{URL}}/api/v1/evaluations

raw

GET single evaluation | GET {{URL}}/api/v1/evaluations/single/62e13e709b76fc941d5f0974

Description

Route to fetch single level from Psiconexia Predict

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

raw

EDIT existing evaluation | PUT {{URL}}/api/v1/evaluations/edit/62e13e709b76fc941d5f0974

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "questions": [ { "title": "Te sientes triste?", "options": [ "Si", "No" ], "answer": { "title": "Si", "counts": true } } ] }

raw

DELETE single evaluation | DELETE {{URL}}/api/v1/evaluations/62e13e709b76fc941d5f0974

Description

Route to delete one of the levels

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Users 5

These are all the routes related to user administration

raw

POST new user | POST {{URL}}/api/v1/users/

Description

Route to create a new user

Body

{ "name": "Jane", "lastName": "Doe", "email": "info@jane.com", "role": "user", "password": "password", "dateOfBirth": "12 Nov 2021", "workSpace": "Psiquiatra", "collegiate": "6475-H", "dni": "47237460Z", "hasAcceptedTerms": true }

raw

GET all users | GET {{URL}}/api/v1/users

Description

Route to fetch all users from database

raw

GET single user | GET {{URL}}/api/v1/users/601ecfa16b511121faae6f82

Description

Route to fetch single user based on ID

raw

EDIT existing user | PUT {{URL}}/api/v1/users/600dc52638546023f6646e76

Body

{ "name": "Alex" }

raw

DELETE single user | DELETE {{URL}}/api/v1/users/601ae8c085af722c9c83d465

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

Submodules v1 5

GET all submodules | GET {{URL}}/api/v1/submodules

raw

POST new submodule | POST {{URL}}/api/v1/submodules

Body

{ "title": "Riesgo sintomático", "type": "Range", "possibleResults": [ { "title": "Bajo", "description": "La persona padece riesgo bajo de padecer depresión" }, { "title": "Medio", "description": "La persona padece riesgo medio de padecer depresión" }, { "title": "Alto", "description": "La persona padece riesgo alto de padecer depresión" } ] }

raw

GET single submodule | GET {{URL}}/api/v1/submodules/62d95ddb56ec702a4e99fe71

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

raw

EDIT existing submodule | PUT {{URL}}/api/v1/submodules/600dc52638546023f6646e76

Body

{ "name": "Alex" }

raw

DELETE single submodule | DELETE {{URL}}/api/v1/submodules/600dc52638546023f6646e76

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

Pquestions 5

raw

EDIT existing pquestion | PUT {{URL}}/api/v1/pquestions/601192bafbbb5d279ea0e855

Body

{ "possibleAnswers": ["Sí", "No"] }

GET all pquestions | GET {{URL}}/api/v1/pquestions/

GET single pquestion | GET {{URL}}/api/v1/pquestions/60119600e174482900500a89

raw

POST new pquestion | POST {{URL}}/api/v1/pquestions/

Body

{ "order": 1, "title": "¿Te has sentido bajo de ánimo, deprimido o decaído la mayor parte de la noche?", "refersTo": "Estado de ánimo pocho la mayor parte del día", "clarification": "Estos síntomas se dan la mayor parte del día", "type": "Si/No", "requiresValidation": false, "examples": [ "Tengo muy pocas ganas de hacer actividades que antes me gustaban", "Ya no disfruto de los pequeños momentos que antes me gustaban", "Ya no siento ningun placer cuando hago el amor con mi pareja ni con nadie", "Prefiero quedarme en casa" ], "conditionals": [ { "condition": "Equal", "answer": 2, "jumpsToQuestion": 3 } ] }

raw

DELETE single pquestion | DELETE {{URL}}/api/v1/pquestions/6011962de174482900500a8a

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

Modules 6

raw

GET all modules | GET {{URL}}/api/v1/modules

raw

GET single module | GET {{URL}}/api/v1/modules/62d95ddb56ec702a4e99fe76

raw

POST new module | POST {{URL}}/api/v1/modules/

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "title": "Ansiedad", "relatedWords": ["tristeza", "desanimo", "falta de apetito"], "description": "La ansiedad es el diagnóstico psiquiátrico y psicológico que describe un trastorno del estado de ánimo, transitorio o permanente, caracterizado por sentimientos de abatimiento, infelicidad y culpabilidad, además de provocar una incapacidad total o parcial para disfrutar de las cosas y de los acontecimientos de la vida cotidiana", "level": "6008196d49e68c0f20b0ee97", "submodules": [ { "submoduleTitle": "Riesgo sintomático", "type": "Range", "possibleResults": {"low": "La persona tiene un riesgo bajo de sufrir esos síntomas", "medium": "La persona tiene un riesgo medio de sufrir esos síntomas", "high": "La persona tiene un riesgo alto de sufrir esos síntomas" }}, { "submoduleTitle": "Duración del problema", "type": "Range" }, { "submoduleTitle": "Afectación del problema", "type": "Range" }, { "submoduleTitle": "Puede explicarse por otros factores", "type": "Binary" } ] }

raw

EDIT existing module | PUT {{URL}}/api/v1/modules/6023b050809dc70cf39965fc

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "submodules": [{ "submoduleTitle": "Riesgo sintomático", "type": "Range", "low": "La persona tiene un riesgo bajo de sufrir esos síntomas", "medium": "La persona tiene un riesgo medio de sufrir esos síntomas", "high": "La persona tiene un riesgo alto de sufrir esos síntomas" }, { "submoduleTitle": "Duración del problema", "type": "Range", "low": "La persona tiene un riesgo bajo de sufrir esos síntomas", "medium": "La persona tiene un riesgo medio de sufrir esos síntomas", "high": "La persona tiene un riesgo alto de sufrir esos síntomas" }, { "submoduleTitle": "Afectación del problema", "type": "Range", "low": "La persona tiene un riesgo bajo de sufrir esos síntomas", "medium": "La persona tiene un riesgo medio de sufrir esos síntomas", "high": "La persona tiene un riesgo alto de sufrir esos síntomas" }, { "submoduleTitle": "Puede explicarse por otros factores", "type": "Binary", "yes": "Sí puede explicarse por otros factores", "no": "No puede explicarse por otros factores" }]}

raw

DELETE single module | DELETE {{URL}}/api/v1/modules/62d95ddb56ec702a4e99fe76

Body

{ "title": "Adultos", "ageFrom": 20, "ageTo": 100 }

raw

Add question to module | POST {{URL}}/api/v1/pquestions/6023b050809dc70cf39965fc

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "submodule": "Duración del problema", "refersTo": "Alteraciones vinculadas con el peso", "statement": "¿Has tenido un aumento significativo del peso y/o apetito?", "clarification": "Estos síntomas se dan la mayor parte del día", "type": "Elección multiple", "requiresValidation": true, "examples": [ "Últimamente como mucho más de lo habitual", "La ropa me va muy justa", "Me han comentado que he ganado peso" ], "possibleAnswers": [ "a. He aumentado el peso", "b. He perdido peso", "c. He perdido apetito", "d. He ganado apetito" ], "conditionals": [] }

Auth 8

Routes for user authentication including register, login, reset password, etc.

raw

POST register user | POST {{URL}}/api/v1/auth/register

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "name": "Admin", "lastName": "User", "email": "admin@user.com", "role": "admin", "password": "password", "dateOfBirth": "1990-11-12", "workSpace": "Psicólogo clínico", "collegiate": "KITJKJ", "dni": "47237460Z", "hasAcceptedTerms": true }

raw

POST login user | POST {{URL}}/api/v1/auth/login

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "email": "admin@user.com", "password": "password" }

raw

GET logged in user | GET {{URL}}/api/v1/auth/me

Headers

Key	Value	Description
Content-Type	application/json	JSON type

raw

POST user forgot password | POST {{URL}}/api/v1/auth/forgotpassword

Headers

Key	Value	Description
Content-Type	application/json	JSON type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwMWU4NDIzOThkM2JhMTFkZjNhMTk1MSIsImlhdCI6MTYxMjYxNDM0MCwiZXhwIjoxNjE1MjA2MzQwfQ.cIPwiS6Fc8zAOaRih4Q76eggFQH48nzdyA0oObvtcz8

Body

{ "email": "admin@user.com" }

file

PUT reset password | PUT {{URL}}/api/v1/auth/resetpassword/a1575c32cc1dda5883f818f36e9e82c1196a27c9

Headers

Key	Value	Description
Content-Type	application/json	JSON type

raw

Update user name and email | PUT {{URL}}/api/v1/auth/updatedetails

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "email": "ale.bausa@gmail.com", "name": "Ale Bausa" }

raw

Update user password | PUT {{URL}}/api/v1/auth/updatepassword

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "currentPassword": "password2", "newPassword": "password" }

Logout user & clear cookies | GET {{URL}}/api/v1/auth/logout

Patients 6

raw

Create new patient | POST {{URL}}/api/v1/patients

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "name": "Claire", "lastName": "Pritchet", "email": "claire@mail.com", "phone": "+34 875 451 478", "gender": "Mujer", "dateOfBirth": "23 June 1988", "hasActivityControl": true, "idNumber": "CLE-MF", "companion": [ { "name": "Ms. Patientson", "phone": "+34 875 451 479", "email": "petunia@mail.com" } ], "initialComments": "El paciente acude a consulta porque siente atáques de pánico en espacios exteriores." }

raw

Get my patients | GET {{URL}}/api/v1/patients/mypatients

Description

Gets current user’s patients

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "name": "Juliana", "lastName": "Anderson", "email": "patient2@mail.com", "phone": "+34 875 451 478", "gender": "Mujer", "dateOfBirth": "12 Nov 1967", "hasActivityControl": true, "idNumber": "LE-875", "companion": [ { "name": "Ms. Patientson", "phone": "+34 875 451 479", "email": "petunia@mail.com" } ], "initialComments": "El paciente acude a consulta porque siente atáques de pánico en espacios exteriores." }

Headers

Key	Value	Description
Content-Type	application/json	JSON type

Body

{ "email": "patient_new@mail.com" }