API Documentation v1
This is the auto-generated documentation for version.
Change me in /resources/vendor/dingodocs/partials/hero.blade.php
General Information
You can change me in /resources/vendor/dingodocs/partials/info.blade.php
Authentication
We use a token-based authentication (e.g., JWT). In order to send the token, you must provide a
?token=XYZ parameter to each of your requests!
Request Throttling
We limit the amount of requests you can send to our API. The limit is set to 60 requests per minute!
Language
Our API may provide data in multiple languages. In order to request the data in a specific language, please use
the
Accept-Language header field. To request data in German, use: Accept-Language=de
Auth
Register user
Handle a registration request for the application.
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/register |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.email | email |
||
| data.attributes.password | string |
Minimum: 8. |
|
| data.attributes.password_confirmation | string |
Must be the same as data.attributes.password. |
|
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.settings | array |
Resend Verification Link
Resends a link for verifying a user (if he is not verified yet)
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/verify/resend |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.email | email |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If no user can be found. |
400 |
If the user is already verified. |
Verifies the email address of the user
Checks, if the verification is done within 7 days.
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/auth/verify/token/{token} |
| HEAD | /api/v1/auth/verify/token/{token} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If no user can be obtained for the given token. |
400 |
If the user is already verified. |
409 |
If the token is already expired. |
500 |
If the user cannot be verified. |
Login
Authenticates a user with his email or username and generate a JWT token.
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/login |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.email | email |
Required if the parameters `data.attributes.name` are not present. |
|
| data.attributes.name | string |
Required if the parameters `data.attributes.email` are not present. |
|
| data.attributes.password | string |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
401 |
If the credentials are invalid. |
500 |
If the token could not be decoded. |
403 |
If the (decoded) user is not verified yet. |
Logout
Logout from the API by "blacklisting" the token. Unfortunately, JWT does not allow "deleting" tokens. The only way to "destroy" a token is by blacklisting it. The user must be authenticated (i.e., send a token) in order to be logged out.
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/auth/logout |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
500 |
If an error occurs. |
Refreshes a token
Refreshes an existing (expired) token and returns a new one.
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/refresh |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If the token is expired. |
409 |
If the token is blacklisted. |
/api/v1/auth/reactivate
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/reactivate |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.email | email |
Send the password reset instructions
Sends the user a link to reset his password (in case he wants to set a new password)
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/password/reset/instructions |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.email | email |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If no user can found. |
400 |
If the user is not verified. |
Set new Password
Set a new password for a user if given tokens are provided and valid
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/auth/password/reset |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.reset_token | string |
||
| data.attributes.password | string |
Minimum: 8. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If no user can be found. |
400 |
If the user is not verified. |
409 |
If the token is already expired. |
Misc
Get available Locales
Get all available locales from the platform (including its locale name in respective language).
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/misc/locales |
| HEAD | /api/v1/misc/locales |
Get a Text Fragment
Returns an active Text Fragment (or Fragments!) based on the identifier
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/misc/texts/{identifier} |
| HEAD | /api/v1/misc/texts/{identifier} |
Get the latest "updated_at" dates
Retrieves the latest "updated_at" dates for texts
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/misc/latest |
| HEAD | /api/v1/misc/latest |
Faqs
Get all Faqs
Returns all active Faqs.
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/faqs |
| HEAD | /api/v1/faqs |
Get one Faq
Returns one Faq entry.
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/faqs/{faq} |
| HEAD | /api/v1/faqs/{faq} |
Tips
Get all Tips
Returns all active Tips.
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/tips |
| HEAD | /api/v1/tips |
Get random Tip
Returns one random Tip entry (if it is active)
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/tips/random |
| HEAD | /api/v1/tips/random |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
404 |
If no random Tip can be found. |
Get one Tip
Show details of a Tip.
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/tips/{tip} |
| HEAD | /api/v1/tips/{tip} |
Gamification
Unlock Achievement
Unlocks (completes) the achievement. The achievement needs to be active and the user must be assigned to the study of this achievement.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/achievements/{achievement}/unlock |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
409 |
If the Achievement is not active. |
400 |
If the User is not subscribed to the Study of the Achievement. |
400 |
If the User has already unlocked this Achievement. |
Show Achievements for Study
Get all active Achievements fot a given Study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/gamification/achievements |
| HEAD | /api/v1/studies/{study}/gamification/achievements |
Get Highscores of Study
Get the Highscores of all Users within the study (ordered by Points DESC)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/gamification/highscores |
| HEAD | /api/v1/studies/{study}/gamification/highscores |
Answersheets
Get one Answersheet
Returns the given answersheet if it was submitted by the user.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/answersheets/{answersheet} |
| HEAD | /api/v1/answersheets/{answersheet} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
if the user has not submitted this answersheet. |
Evaluate one Answersheet
Returns the evaluation for an answersheet if it was submitted by the user.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/answersheets/{answersheet}/evaluate |
| HEAD | /api/v1/answersheets/{answersheet}/evaluate |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
if the user has not submitted this answersheet. |
409 |
if errors occurred during processing of evaluation. |
Get Answers for a given Question
Returns all answers to a specific question (identified by its label) within one questionnaire. You can specify the amount of days you want to get data for, by appending ?days=7.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/answersheets/questionnaires/{questionnaire}/elements/{label} |
| HEAD | /api/v1/answersheets/questionnaires/{questionnaire}/elements/{label} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
404 |
if no answersheets exist. |
Feedbacks
Get Feedbacks
Get all Feedbacks that are defined across all studies and questionnaires.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/feedbacks |
| HEAD | /api/v1/feedbacks |
Show Feedback
Get the details of one Feedback object.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/feedbacks/{feedback} |
| HEAD | /api/v1/feedbacks/{feedback} |
Likes
Get Likes
Get all likes of the current user!
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/likes |
| HEAD | /api/v1/likes |
Show Like
Show one like of the user. The respective 'base transformer' for this type of entity is used!
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/likes/{like} |
| HEAD | /api/v1/likes/{like} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Get Likes
Get all likes of a given Entity. The respective 'base transformer' for this entity is used!
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/likes/type/{likeable_type} |
| HEAD | /api/v1/likes/type/{likeable_type} |
Like Entity
Like an entity or Exception if you already liked it before.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/likes |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.likeable_id | integer |
Minimum: 1. |
|
| data.attributes.likeable_type | string |
||
| data.attributes.rating | integer |
Minimum: 1. Maximum: 5. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If the User has liked this Resource before. |
Unlike Entity
Unlike an Entity or Exception if you have not liked it before.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/likes |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.likeable_id | integer |
Minimum: 1. |
|
| data.attributes.likeable_type | string |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If the User has not liked this Resource before. |
Messages
Show Inbox
Show the "Inbox" folder of the current user. This method retrieves all threads where the current user acts as a participant.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/messages |
| HEAD | /api/v1/messages |
Transformer includes
messages
participants
Show one thread
Retrieves all messages for one thread, where the current user acts as a participant.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/messages/threads/{thread} |
| HEAD | /api/v1/messages/threads/{thread} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Delete Thread
Delete a Thread (including all of its messages and so on) if we are the owner.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/messages/threads/{thread} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Show Inbox
Show the "Inbox" folder of the current user. This method retrieves all threads where the current user acts as a participant.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/messages/folders/inbox |
| HEAD | /api/v1/messages/folders/inbox |
Transformer includes
messages
participants
Show Sent
Show the "Sent" folder of the current user. This method retrieves all threads which are started by the current user.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/messages/folders/sent |
| HEAD | /api/v1/messages/folders/sent |
Transformer includes
messages
participants
Create Thread
Creates a new (empty) thread and assigns the current user as a participant. The current user is, therefore, the owner of the newly created thread.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/messages/threads |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.subject | string |
Maximum: 255. |
Create Message
Adds a message to the given thread, if the user (of the message) can access the thread.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/messages/threads/{thread}/messages |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.body | string |
||
| data.attributes.deliver_at | date |
Date format: U. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Get Participants
Get all participants (users) who have access to this thread. Must participate in this thread to access this route.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/messages/threads/{thread}/participants |
| HEAD | /api/v1/messages/threads/{thread}/participants |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Add participants to thread
Adds a list of participants to the thread if the current user already participates in this thread.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/messages/threads/{thread}/relationships/participants |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.participants | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Removes participants from thread
Removes a list of participants from the thread if the user is allowed to.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/messages/threads/{thread}/relationships/participants |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.participants | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Notes
Get All Notes
Get a list of all Notes (open and archive).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/notes |
| HEAD | /api/v1/notes |
Show a Note
Show a Note if respective permissions are valid. Exceptions otherwise
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/notes/{note} |
| HEAD | /api/v1/notes/{note} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Get Open Notes
Get a list of all open Notes.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/notes/folders/open |
| HEAD | /api/v1/notes/folders/open |
Get my archived Notes
Get a list of all closed Notes.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/notes/folders/archive |
| HEAD | /api/v1/notes/folders/archive |
Add a new Note
Adds a new Entry to the database. It is automatically defined as "open".
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/notes |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.is_done | boolean |
||
| data.attributes.title | string |
Maximum: 255. |
Update a Note entry
Updates a note entry if it belongs to a user.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/notes/{note} |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.is_done | boolean |
||
| data.attributes.title | string |
Maximum: 255. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Delete a note entry
Permanently removes a note entry from the list of the user
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/notes/{note} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Questionnaires
Get Questionnaires
Lists all questionnaires (across all studies!)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires |
| HEAD | /api/v1/questionnaires |
Get a questionnaire
Get the details for a specific questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires/{questionnaire} |
| HEAD | /api/v1/questionnaires/{questionnaire} |
Elements of Questionnaire
Gets all elements of the questionnaire in respective order (ascending). NOte that NO PAGINATION is provided for this route, as all elements must be processed by the client. Must have access to this questionnaire through the study relation. All elements provide information regarding their type.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires/{questionnaire}/structure |
| HEAD | /api/v1/questionnaires/{questionnaire}/structure |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Get Answersheets
Get all Answersheets of the current user for this specific Questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires/{questionnaire}/answersheets |
| HEAD | /api/v1/questionnaires/{questionnaire}/answersheets |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
Submit Answers
Submit the answers to a questionnaire. Must have access to this questionnaire through the study relation. Returns an exception if the questionnaire is_onetime and already filled in. The client MUST check, if the questionnaire is filled in correctly (e.g., all "required" fields are set!)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/questionnaires/{questionnaire}/answersheets |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.locale | string |
Maximum: 255. |
|
| data.attributes.answers | array |
||
| data.attributes.sensordata | array |
||
| data.attributes.client | array |
||
| data.attributes.client.name | string |
||
| data.attributes.client.device | string |
||
| data.attributes.client.os | string |
||
| data.attributes.collected_at | date |
Date format: U. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If we are not allowed to access this Resource |
409 |
If the Study this Questionnaire is assigned to, is not running. |
409 |
If the Questionnaire is a one-time Questionnaire and already filled in. |
Studies
Get all Studies
Returns all studies that are available
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies |
| HEAD | /api/v1/studies |
Transformer includes
questionnaires
collaborators
members
Get one Study
Returns the given study if it publicly available. Note that studies that are NOT running anymore are also available through this route. This is needed because one wants to read the description of expired studies.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study} |
| HEAD | /api/v1/studies/{study} |
Transformer includes
questionnaires
collaborators
members
Subscribe to Study
Subscribes the current user to the study. Study must be public and running. If the study is set to private, an additional password field can be sent in order to authenticate. If no code is needed (and no password is required) you MUST set the code to NULL. If the study is an INVITE study, a request is sent to the study owner in order to accept / decline the user for this study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/studies/{study}/subscribe |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.code | string |
Maximum: 255. |
|
| data.attributes.password | string |
Maximum: 255. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the Study is currently not running. |
400 |
If the password is missing. |
403 |
If the password does not match. |
409 |
If the User has an open pending request for this study. |
409 |
If the User is already subscribed to this study. |
Unsubscribe from Study
Removes the current user from a study. Exception if the user was not subscribed before.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/studies/{study}/unsubscribe |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
409 |
If the User is not subscribed to this Study. |
409 |
If the Study he wants to unsubscribe is not unsubscribable |
Associated Questionnaires
Get the active questionnaires, which are associated with this study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/questionnaires |
| HEAD | /api/v1/studies/{study}/questionnaires |
Associated Questionnaire Relationship
Get the relationship of the active questionnaires, which are associated with this study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/relationships/questionnaires |
| HEAD | /api/v1/studies/{study}/relationships/questionnaires |
Get Gamification Data
Returns the Gamification Data for one study (e.g., the points or configuration objects).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Member
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/gamification/data |
| HEAD | /api/v1/studies/{study}/gamification/data |
Update Gamification Data
Updates / Sets the Gamification Data for one study (e.g., the points or configuration objects).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Member
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/studies/{study}/gamification/data |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.points | integer |
||
| data.attributes.data | array |
Accept Invitation
Accepts the Invitation for a Study (if it exists).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Member
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/studies/invitation/{code} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
if no Invitation can be found for this token. |
409 |
if the token for this Invitation has expired. |
400 |
if the Invitation has been used before. |
409 |
if no Study Model can be generated from the Invitation. |
Users
Get all verified Users
returns all verified users
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/users |
| HEAD | /api/v1/users |
Show verified user
Get data of a specific user (if he is verified)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/users/{user} |
| HEAD | /api/v1/users/{user} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
404 |
If the User is not verified yet. |
Get Studies where User is Member
Get all studies, where a specific user is listed as "member". User must be verified
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/users/{user}/studies/member |
| HEAD | /api/v1/users/{user}/studies/member |
Transformer includes
questionnaires
collaborators
members
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
404 |
If the User is not verified yet. |
Get Studies where User is Collaborator
Get all studies, where a specific user is listed as "collaborator". User must be verified
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/users/{user}/studies/collaborator |
| HEAD | /api/v1/users/{user}/studies/collaborator |
Transformer includes
questionnaires
collaborators
members
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
404 |
If the User is not verified yet. |
My
My Profile
Get the profile of the current user (including settings, ...).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/profile |
| HEAD | /api/v1/my/profile |
Update My Profile
Changes the users profile. Sex is defined as described here ( https://en.wikipedia.org/wiki/ISO/IEC_5218 )
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/my/profile |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.firstname | string |
Maximum: 255. |
|
| data.attributes.lastname | string |
Maximum: 255. |
|
| data.attributes.sex | integer |
Must be in: `0`, `1`, `2` or `9`. |
|
| data.attributes.picture | array |
||
| data.attributes.picture.content | string |
Required if the parameters `data.attributes.picture` are present. |
|
| data.attributes.picture.extension | string |
Required if the parameters `data.attributes.picture` are present. |
|
| data.attributes.settings | array |
Update My Password
Updates the password if the user is already authenticated (without emails!). The access token currently used is NOT invalidated!
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/my/profile/password |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.password | string |
Minimum: 8. |
Delete Profile
Delete the user including all its data..
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/my/profile |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
500 |
If an error occurs. |
My Roles
Return the roles the user is currently assigned to.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/roles |
| HEAD | /api/v1/my/roles |
Show My Achievements
Returns all achievements this user has unlocked so far.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/achievements |
| HEAD | /api/v1/my/achievements |
Get History
Get the history (i.e., all activities done) by the current user. Returns appropriate text snippets to show (must be correctly assembled). Ordered by date DESC
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/activities |
| HEAD | /api/v1/my/activities |
My Answersheets
Get a list of all filled in answersheets from this user across all questionnaires.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/answersheets |
| HEAD | /api/v1/my/answersheets |
Show my Invitations
Show all Invitations for the current user. Only invitations, that are not accepted and are not expired yet.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/invitations |
| HEAD | /api/v1/my/invitations |
My Notes
Get all Notes, the current user has (open and archived)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/notes |
| HEAD | /api/v1/my/notes |
My Questionnaires
Get all active questionnaires for all currently running studies this user is currently subscribed to.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/questionnaires |
| HEAD | /api/v1/my/questionnaires |
My Studies
Get all studies, the current user is subscribed to. Note that studies, which are currently NOT running anymore are also returned (e.g., if one wants to unsubscribe!)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/studies |
| HEAD | /api/v1/my/studies |
Transformer includes
questionnaires
collaborators
members
Get Pending Requests
Get the studies for all currently pending requests of the user
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/studies/pending |
| HEAD | /api/v1/my/studies/pending |
Delete Pending Request
Deletes a pending request for a study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/my/studies/pending/{study} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If there is no pending request for this study. |
Returns available values
Returns all available values for comparision between the current user and the "critical mass"
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/values |
| HEAD | /api/v1/my/values |
Returns Values for Tinnitus Loudness
Returns the min/max values for the tinnitus loudness for the current user. Note that this feature is currently in beta stadium. Can be configured via START and AMOUNT query parameters. MIN and MAX values are objects; the key of this object, however, denotes the day (with respect to START and AMOUNT parameters).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
User
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/my/values/loudness |
| HEAD | /api/v1/my/values/loudness |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If no answersheet exist. |
Editor-Studies
Show collaborating Studies
Show all studies, the user has access to. This route only returns collaborating studies and NOT participating studies (e.g., when subscribing to a study!)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/editor/studies |
| HEAD | /api/v1/editor/studies |
Transformer includes
questionnaires
collaborators
members
Show pending Requests
Show all pending requests for the given study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/editor/studies/{study}/requests |
| HEAD | /api/v1/editor/studies/{study}/requests |
Accept a pending request
Accept a pending request for a given study
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/editor/studies/{study}/requests/{user} |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.code | string |
Maximum: 255. |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If the User to accept the request does not exist. |
409 |
If the User is already subscribed to this study. |
Delete a pending request
Delete a pending request for a given study
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/editor/studies/{study}/requests/{user} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
400 |
If the User to accept the request does not exist. |
409 |
If the User is already subscribed to this study. |
Update study
The owner of the study may change its details and update the study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/studies/{study} |
Transformer includes
questionnaires
collaborators
members
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.is_shareable | boolean |
||
| data.attributes.is_private | boolean |
||
| data.attributes.accesstype | string |
Required if data.attributes.is_private is 1. Must be in: `password` or `invite`. |
|
| data.attributes.password | string |
Required if data.attributes.accesstype is password. Maximum: 255. |
|
| data.attributes.starts_at | date |
Date format: U. |
|
| data.attributes.ends_at | date |
Date format: U. Must be a date after: Thursday, 01-Jan-70 00:00:00 UTC. |
|
| data.attributes.picture | array |
||
| data.attributes.picture.content | string |
Required if the parameters `data.attributes.picture` are present. |
|
| data.attributes.picture.extension | string |
Required if the parameters `data.attributes.picture` are present. |
|
| data.attributes.translations | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Delete Study
Deletes a Study AND all of its Questionnaires. Furthermore, all Collaborators and Members are removed from this Study as well.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/studies/{study} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Get collaborators
Get all collaborators (and their roles) for a given study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/collaborators |
| HEAD | /api/v1/studies/{study}/collaborators |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Add Collaborator(s)
Add collaborators to work in this study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/studies/{study}/relationships/collaborators |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.users | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Remove Collaborator(s)
Remove collaborators from this study. The user is, however, not deleted.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/studies/{study}/relationships/collaborators |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.users | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Get Members
Show all members (e.g., Users) of a given study including their code within the study (if set).
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/members |
| HEAD | /api/v1/studies/{study}/members |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Remove Member(s)
Removes members from a study. The user, however, is not deleted.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/studies/{study}/relationships/members |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.users | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Get Answersheets for Questionnaire
Get all Answersheets for a Questionnaire. Thereby, only users from the Study are "selected". You can "limit" the amount of answersheets with ?amount=x. Thereby, only the last x entries (based on the collected_at timestamp) are returned!
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/questionnaires/{questionnaire}/answersheets |
| HEAD | /api/v1/studies/{study}/questionnaires/{questionnaire}/answersheets |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Study is not flagged as shareable. |
403 |
If the current user is not a collaborator of the shared study. |
Get Answersheets for Member
Get all Answersheets for a Member of the Study. Member must be assigned to this study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/members/{user}/answersheets |
| HEAD | /api/v1/studies/{study}/members/{user}/answersheets |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Member is not assigned to this Study. |
Get Answersheet Details for Member
Get the Answersheet Details for a Member of the Study. Member must be assigned to this study, the Answersheet must be owned by the member.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet} |
| HEAD | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Member is not assigned to this Study. |
403 |
If the Answersheet is not owned by the Member. |
Update Flags of Answersheet
Update the Flags for a given Answersheet. Flags are always appended to the list.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet}/flags |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.flags | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Member is not assigned to this Study. |
403 |
If the Answersheet is not owned by the Member. |
Remove Flags from Answersheet
Removes specific Flags from a given Answersheet. Flags are always appended to the list.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet}/flags |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.flags | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Member is not assigned to this Study. |
403 |
If the Answersheet is not owned by the Member. |
Get Evaluation for Answersheet of Member
Get the Evaluation for an Answersheet of a Member of the Study. Member must be assigned to this study, the Answersheet must be owned by the member.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet}/evaluate |
| HEAD | /api/v1/studies/{study}/members/{user}/answersheets/{answersheet}/evaluate |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Member is not assigned to this Study. |
403 |
If the Answersheet is not owned by the Member. |
409 |
If an error occurs during the evaluation of the Answersheet. |
Editor-Questionnaires
Create Questionnaire
Create a new Questionnaire and adds it to respective study
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/studies/{study}/questionnaires |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.origin | string |
Maximum: 255. |
|
| data.attributes.can_use | array |
||
| data.attributes.is_onetime | boolean |
||
| data.attributes.is_multiple | boolean |
||
| data.attributes.points | integer |
Minimum: 0. |
|
| data.attributes.schedule | array |
Required if data.attributes.is_multiple is 1. |
|
| data.attributes.is_schedule_changeable | boolean |
Required if data.attributes.is_multiple is 1. |
|
| data.attributes.translations | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Update a Questionnaire
Update the main attributes of a questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/questionnaires/{questionnaire} |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.can_use | array |
||
| data.attributes.is_onetime | boolean |
||
| data.attributes.is_multiple | boolean |
||
| data.attributes.points | integer |
Minimum: 0. |
|
| data.attributes.schedule | array |
Required if data.attributes.is_multiple is 1. |
|
| data.attributes.is_schedule_changeable | boolean |
Required if data.attributes.is_multiple is 1. |
|
| data.attributes.translations | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Delete Questionnaire
Delete a Questionnaire, all its Feedbacks and all other depending objects..
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/questionnaires/{questionnaire} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Activate Questionnaire
Activates a Questionnaire. Must have the appropriate rights in the study of the questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/questionnaires/{questionnaire}/activate |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Get Feedbacks
Get the Feedbacks, which are defined for a questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires/{questionnaire}/feedbacks |
| HEAD | /api/v1/questionnaires/{questionnaire}/feedbacks |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Get Elements of Questionnaire
Get all Elements of the questionnaire in order to update or append new elements.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/questionnaires/{questionnaire}/elements |
| HEAD | /api/v1/questionnaires/{questionnaire}/elements |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Create Elements for Questionnaire
Create Elements and appends it to respective questionnaire within a study.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/questionnaires/{questionnaire}/elements |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.elements | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
403 |
If the Questionnaire is already active. |
Editor-Feedbacks
Create Feedback
Creates a new Feedback for a given Questionnaire
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/questionnaires/{questionnaire}/feedbacks |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.is_private | boolean |
||
| data.attributes.rule | string |
||
| data.attributes.translations | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Update Feedback
Updates a Feedback (incl. translations) if the appropriate rights are available.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/feedbacks/{feedback} |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.is_private | boolean |
||
| data.attributes.rule | string |
||
| data.attributes.translations | array |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Delete Feedback
Deletes a Feedback from a Questionnaire.
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/feedbacks/{feedback} |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Activate Feedback
Activates a Feedback for a Questionnaire
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/feedbacks/{feedback}/activate |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Deactivate Feedback
Deactivates a Feedback for a Questionnaire
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
Required Role
This route requires you to have the role
Editor
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/feedbacks/{feedback}/deactivate |
Exceptions
This route may throw the following Exceptions.
| HTTP Status | Description |
|---|---|
403 |
If the User does not have the required Role. |
Admin-Dashboard
/api/v1/admin
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/admin |
| HEAD | /api/v1/admin |
Admin-Tips
Returns all Tips
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/admin/tips |
| HEAD | /api/v1/admin/tips |
Shows one specific Tip
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| GET | /api/v1/admin/tips/{tip} |
| HEAD | /api/v1/admin/tips/{tip} |
Adds a new Tip to the database
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| POST | /api/v1/admin/tips |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.is_active | boolean |
||
| data.attributes.translations | array |
Updates a Tip entry (including translations)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/admin/tips/{tip} |
Validator Parameters
These parameters are validated upon each request to the API.
| Parameter | Type | Required | Details |
|---|---|---|---|
| data | array |
||
| data.type | string |
||
| data.attributes | array |
||
| data.attributes.name | string |
Maximum: 255. |
|
| data.attributes.is_active | boolean |
||
| data.attributes.translations | array |
Activate a given Tip entry (toggles flag)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/admin/tips/{tip}/activate |
Deactivate a given Tip entry (toggles flag)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| PATCH | /api/v1/admin/tips/{tip}/deactivate |
Removes an Tip entry from the database (including translations)
Authentication Required
Heads up! You need to authenticate yourself, before using this route!
HTTP Request Methods
| Method | URI |
|---|---|
| DELETE | /api/v1/admin/tips/{tip} |