Backend Socket.io description 1.0.0

Accepts one of the following messages:

• #0Get annotationannotationGet

  Get annotation by Id

  Payload

  Expand all

  object

  Payload object

  annotationId

  integer

  uid: annotationId

  id of the annotation

  Additional properties are allowed.

  Examples

  Payload

  {
    "annotationId": 0
  }
  

  This example has been generated automatically.

• #1Update annotationannotationUpdate

  Update annotation by id, Payload can have additional fields which wants to be set, Draft will be set to false!

  Payload

  Expand all

  object

  Annotation DB Object

  annotationId

  required

  integer

  uid: annotationId

  id of the annotation

  tagId

  integer

  uid: tagId

  id of the tag

  deleted

  boolean

  set true to delete annotation

  Additional properties are allowed.

  Examples

  Payload

  {
    "annotationId": 0,
    "tagId": 0,
    "deleted": true
  }
  

  This example has been generated automatically.

• #2Get annotation by document idannotationGetByDocument

  Get annotation by document id

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #3Export annotation by document idannotationExportByDocument

  Export annotation by document id

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Update annotationannotationRefresh

  Update annotation by Id

  Payload

  Expand all

  array<any>

  List of Annotation DB Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

• #1Export annotationannotationExport

  Export annotation by document id

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the export was successful

  documentId

  integer

  uid: documentId

  id of the document

  objs

  Expand all

  array<any>

  List of Annotation DB Objects

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "documentId": 0,
    "objs": []
  }
  

  This example has been generated automatically.

Accepts the following message:

{
  "collabId": 0,
  "deleted": true
}

Accepts one of the following messages:

• #0Refresh collaborationcollabRefresh

  Refresh collaboration by Id

  Payload

  Expand all

  object

  Collaboration DB Object

  collabId

  integer

  id of the collaboration

  collabHash

  string

  uid: collabHash

  unique hash of the collaboration

  deleted

  boolean

  set true to delete collaboration

  Additional properties are allowed.

  Examples

  Payload

  {
    "collabId": 0,
    "collabHash": "string",
    "deleted": true
  }
  

  This example has been generated automatically.

• #1Start collaboration indicatorcollabStart

  Start collaboration indicator with hash

  Payload

  Expand all

  object

  Payload object

  collabId

  integer

  uid: collabId

  id of the collaboration

  collabHash

  string

  uid: collabHash

  unique hash of the collaboration

  Additional properties are allowed.

  Examples

  Payload

  {
    "collabId": 0,
    "collabHash": "string"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Get commentcommentGet

  Get comment by Id

  Payload

  Expand all

  object

  Payload object

  commentId

  integer

  uid: commentId

  id of the comment

  Additional properties are allowed.

  Examples

  Payload

  {
    "commentId": 0
  }
  

  This example has been generated automatically.

• #1Update commentcommentUpdate

  Update comment by Id (adding if commentId is not set, deleting if deleted is set to true)

  Payload

  Expand all

  object

  Payload object

  commentId

  integer

  uid: commentId

  id of the comment

  text

  string

  Text of the comment

  deleted

  boolean

  If the comment should be deleted

  tags

  Expand all

  array<string>

  List of tags

  Items:

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "commentId": 0,
    "text": "string",
    "deleted": true,
    "tags": [
      "string"
    ]
  }
  

  This example has been generated automatically.

• #2Get comment by document idcommentGetByDocument

  Get comment by document id

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #3Export comment by document idcommentExportByDocument

  Export comment by document id

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Export commentcommentExport

  Export comment by document id

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the export was successful

  documentId

  integer

  uid: documentId

  id of the document

  objs

  Expand all

  array<any>

  List of Comment DB Objects

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "documentId": 0,
    "objs": []
  }
  

  This example has been generated automatically.

• #1Refresh commentscommentRefresh

  Refresh comment by Id

  Payload

  Expand all

  array<any>

  List of DB Comment Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Get documentdocumentGet

  Get document by document id (triggers documentRefresh and documentFile for pdfs)

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #1Get all documents available by userdocumentGetAll

  Get all documents (only for admin) otherwise selected by user, only documentRefresh is triggered

  Payload

  Expand all

  object

  Payload object, if userId is set, only documents of this user are returned (only for admin)

  userId

  integer

  uid: userId

  id of a user

  Additional properties are allowed.

  Examples

  Payload

  {
    "userId": 0
  }
  

  This example has been generated automatically.

• #2Update documentdocumentUpdate

  Update document (if documentId is not set, a new document is created)

  Payload

  Expand all

  object

  Payload object, document object with entries to update

  documentId

  integer

  uid: documentId

  id of the document

  deleted

  boolean

  If true, the document will be deleted

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0,
    "deleted": true
  }
  

  This example has been generated automatically.

• #3Get document by hashdocumentGetByHash

  Get document by hash (triggers documentRefresh)

  Payload

  Expand all

  object

  Payload object

  documentHash

  string

  uid: documentHash

  unique hash of a document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentHash": "string"
  }
  

  This example has been generated automatically.

• #4Get document datadocumentGetData

  Get document data by document id (all data except file, e.g. annotations, comments, etc.)

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #5Publish documentdocumentPublish

  Publish document

  Payload

  Expand all

  object

  Payload object

  documentId

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #6Subscribe to a documentdocumentSubscribe

  Receive updates for a document (e.g. annotations, comments)

  Payload

  Expand all

  object

  Payload object

  documentId

  required

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

• #7Unsubscribe from a documentdocumentUnsubscribe

  Don't receive updates for a document anymore

  Payload

  Expand all

  object

  Payload object

  documentId

  required

  integer

  uid: documentId

  id of the document

  Additional properties are allowed.

  Examples

  Payload

  {
    "documentId": 0
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Refresh documentdocumentRefresh

  Refresh document

  Payload

  Expand all

  array<any>

  List of DB document objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

• #1Receive document filedocumentFile

  Receive requested document file

  Payload

  Expand all

  object

  Payload object

  document

  Expand all

  object

  Document DB Object

  Additional properties are allowed.

  file

  Expand all

  object

  File object

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "document": {},
    "file": {}
  }
  

  This example has been generated automatically.

• #2Published documentdocumentPublished

  Info about the published document after documentPublish

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the publishing was successful

  message

  string

  Message if the publishing was not successful

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "message": "string"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Add loglog

  Add log (Env-Var LOGGING_ALLOW_FRONTEND must be set to "true")

  Payload

  Expand all

  object

  Payload object

  level

  required

  string

  Log level

  message

  required

  string

  Log message

  meta

  Expand all

  object

  Additional meta data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "level": "string",
    "message": "string",
    "meta": {}
  }
  

  This example has been generated automatically.

• #1Get all logslogGetAll

  Get all logs (only for admin)

  Payload

  Expand all

  object

  Payload object

  limit

  required

  number

  Limit the number of returned logs

  Additional properties are allowed.

  Examples

  Payload

  {
    "limit": 0
  }
  

  This example has been generated automatically.

Accepts the following message:

[]

Accepts one of the following messages:

• #0Connect serviceserviceConnect

  Connect client to service

  Payload

  Expand all

  object

  Payload object

  service

  required

  string

  Service name

  data

  Expand all

  object

  Additional data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "service": "string",
    "data": {}
  }
  

  This example has been generated automatically.

• #1Disconnect serviceserviceDisconnect

  Disconnect client from service

  Payload

  Expand all

  object

  Payload object

  service

  required

  string

  Service name

  data

  Expand all

  object

  Additional data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "service": "string",
    "data": {}
  }
  

  This example has been generated automatically.

• #2Send request to a serviceserviceRequest

  Send a typical request to a available service

  Payload

  Expand all

  object

  Payload object

  service

  required

  string

  Service name

  data

  Expand all

  object

  Additional data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "service": "string",
    "data": {}
  }
  

  This example has been generated automatically.

• #3Send command to a serviceserviceCommand

  Send a command to a available service (can be used to trigger additional commands to a service)

  Payload

  Expand all

  object

  Payload object

  service

  required

  string

  Service name

  command

  string

  Command name

  data

  Expand all

  object

  Additional data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "service": "string",
    "command": "string",
    "data": {}
  }
  

  This example has been generated automatically.

Accepts the following message:

{
  "service": "string",
  "type": "string",
  "data": {}
}

Accepts one of the following messages:

• #0Get all settingssettingGetAll

  Get all settings overwritten by user settings

  Examples

• #1Get navigation elements for dashboardsettingGetNavigation

  Get navigation elements showing in dashboard

  Examples

• #2Set settingsettingSet

  Set setting as user (overwrites global setting, but not set it as global setting)

  Payload

  Expand all

  object

  Payload object

  key

  string

  Setting key

  value

  string

  Setting value

  Additional properties are allowed.

  Examples

  Payload

  {
    "key": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• #3Get all settingssettingGetData

  Get all global settings (only for admin)

  Examples

• #4Save global settingssettingSave

  Save global settings (only for admin)

  Payload

  Expand all

  array<object>

  Payload object

  key

  string

  Setting key

  value

  string

  Setting value

  Examples

  Payload

  [
    {
      "key": "string",
      "value": "string"
    }
  ]
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Refresh settingssettingRefresh

  Refresh settings

  Payload

  Expand all

  array<any>

  List of DB settings objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

• #1Navigation elementssettingNavigation

  Dashboard navigation elements

  Payload

  Expand all

  object

  Payload object

  groups

  Expand all

  array<object>

  List of navigation groups

  Items:

  Expand all

  object

  Navigation group

  Additional properties are allowed.

  elements

  Expand all

  array<object>

  List of navigation elements

  Items:

  Expand all

  object

  Navigation element

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "groups": [
      {}
    ],
    "elements": [
      {}
    ]
  }
  

  This example has been generated automatically.

• #2All settingssettingData

  All settings

  Payload

  Expand all

  array<any>

  List of DB settings objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Add statsstats

  Add stats entry

  Payload

  Expand all

  object

  Payload object

  action

  required

  string

  Action name

  data

  Expand all

  object

  Additional data

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "string",
    "data": {}
  }
  

  This example has been generated automatically.

• #1Get stats by userstatsGetByUser

  Get stats by user

  Payload

  Expand all

  object

  Payload object

  userId

  required

  integer

  uid: userId

  id of a user

  Additional properties are allowed.

  Examples

  Payload

  {
    "userId": 0
  }
  

  This example has been generated automatically.

• #2Get all statsstatsGetAll

  Get all stats

  Examples

Accepts one of the following messages:

• #0All stats by userstatsDataByUser

  All stats by user

  Payload

  Expand all

  array<any>

  List of Stats DB Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

• #1All statsstatsData

  All stats

  Payload

  Expand all

  array<any>

  List of Stats DB Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Get studystudyGet

  Get study by Id

  Payload

  Expand all

  object

  Payload object

  studyId

  integer

  uid: studyId

  id of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "studyId": 0
  }
  

  This example has been generated automatically.

• #1Get all studiesstudyGetAll

  Get all studies (if user is admin, all studies will be returned or only studies of the user if userId is set)

  Payload

  Expand all

  object

  Payload object

  userId

  integer

  uid: userId

  id of a user

  Additional properties are allowed.

  Examples

  Payload

  {
    "userId": 0
  }
  

  This example has been generated automatically.

• #2Get study by hashstudyGetByHash

  Get study by hash

  Payload

  Expand all

  object

  Payload object

  studyHash

  string

  uid: studyHash

  unique hash of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "studyHash": "string"
  }
  

  This example has been generated automatically.

• #3Update studystudyUpdate

  Update study by Id (if study id is not set, a new study will be created)

  Payload

  Expand all

  object

  Payload object (only the properties which should be updated are required)

  studyId

  integer

  uid: studyId

  id of a study

  deleted

  boolean

  set to true if study should be deleted

  Additional properties are allowed.

  Examples

  Payload

  {
    "studyId": 0,
    "deleted": true
  }
  

  This example has been generated automatically.

• #4Start studystudyStart

  Start study by Id (create a new study session and return studySessionId)

  Payload

  Expand all

  object

  Payload object

  studyId

  integer

  uid: studyId

  id of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "studyId": 0
  }
  

  This example has been generated automatically.

• #5Publish studystudyPublish

  Create a new study and return the study hash

  Payload

  Expand all

  object

  Study object

  Additional properties are allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Study started responsestudyStarted

  Study started response with study session id

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the study was started successfully

  studySessionId

  integer

  uid: studySessionId

  id of a study session

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "studySessionId": 0
  }
  

  This example has been generated automatically.

• #1Study error responsestudyError

  Study error response if hash request fails

  Payload

  Expand all

  object

  Payload object

  message

  string

  Error message

  studyHash

  string

  uid: studyHash

  unique hash of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "message": "string",
    "studyHash": "string"
  }
  

  This example has been generated automatically.

• #2Refresh studiesstudyRefresh

  Refresh studies

  Payload

  Expand all

  array<object>

  Payload object

  Items:

  Expand all

  object

  Study DB objects

  Additional properties are allowed.

  Examples

  Payload

  [
    {}
  ]
  

  This example has been generated automatically.

• #3Study published responsestudyPublished

  Study published response with study hash

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the study was published successfully

  message

  string

  If success is false, this contains the error message

  studyHash

  string

  uid: studyHash

  unique hash of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "message": "string",
    "studyHash": "string"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Get study sessionstudySessionGet

  Get study by sessionId or studyId

  Payload

  Expand all

  object

  only one of the properties is required (studySessionId will be used if both are set)

  studySessionId

  integer

  uid: studySessionId

  id of a study session

  studyId

  integer

  uid: studyId

  id of a study

  Additional properties are allowed.

  Examples

  Payload

  {
    "studySessionId": 0,
    "studyId": 0
  }
  

  This example has been generated automatically.

• #1Get all study sessionsstudySessionGetAll

  Get all study sessions (if user is admin, all study sessions will be returned or only study sessions of the user if userId is set)

  Payload

  Expand all

  object

  Payload object

  userId

  integer

  uid: userId

  id of a user

  Additional properties are allowed.

  Examples

  Payload

  {
    "userId": 0
  }
  

  This example has been generated automatically.

• #2Get study session by hashstudySessionGetByHash

  Get study session by hash

  Payload

  Expand all

  object

  Payload object

  studySessionHash

  string

  uid: studySessionHash

  unique hash of a study session

  Additional properties are allowed.

  Examples

  Payload

  {
    "studySessionHash": "string"
  }
  

  This example has been generated automatically.

• #3Update study sessionstudySessionUpdate

  Update study session by Id (if study session id is not set, a new study session will be created, but withtout hash response - use studyStart instead)

  Payload

  Expand all

  object

  Payload object (only the properties which should be updated are required)

  studySessionId

  integer

  uid: studySessionId

  id of a study session

  deleted

  boolean

  set to true if study session should be deleted

  Additional properties are allowed.

  Examples

  Payload

  {
    "studySessionId": 0,
    "deleted": true
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Study session error responsestudySessionError

  Study session error response if hash request fails

  Payload

  Expand all

  object

  Payload object

  message

  string

  Error message

  studySessionHash

  string

  uid: studySessionHash

  unique hash of a study session

  Additional properties are allowed.

  Examples

  Payload

  {
    "message": "string",
    "studySessionHash": "string"
  }
  

  This example has been generated automatically.

• #1Refresh study sessionsstudySessionRefresh

  Refresh study sessions

  Payload

  Expand all

  array<object>

  Payload object

  Items:

  Expand all

  object

  Study session DB objects

  Additional properties are allowed.

  Examples

  Payload

  [
    {}
  ]
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Get tagtagGet

  Get tag by Id

  Payload

  Expand all

  object

  Payload object

  tagId

  integer

  uid: tagId

  id of the tag

  Additional properties are allowed.

  Examples

  Payload

  {
    "tagId": 0
  }
  

  This example has been generated automatically.

• #1Get all tagstagGetAll

  Get all tags (only for admin) otherwise only the tags of the user

  Examples

• #2Get tag settagSetGet

  Get tag set by Id

  Payload

  Expand all

  object

  Payload object

  tagSetId

  integer

  uid: tagSetId

  id of the tag set

  Additional properties are allowed.

  Examples

  Payload

  {
    "tagSetId": 0
  }
  

  This example has been generated automatically.

• #3Get all tag setstagSetGetAll

  Get all tag sets (only for admin) otherwise only the tag sets of the user

  Examples

• #4Save tag settagSetUpdate

  Save tag set (if tagSetId is set, the tag set will be updated)

  Payload

  Expand all

  object

  Payload object

  tagSetId

  integer

  uid: tagSetId

  id of the tag set

  tagSet

  Expand all

  object

  Tag Set DB Object to overwrite

  Additional properties are allowed.

  tags

  Expand all

  array<object>

  List of tags

  Items:

  Expand all

  object

  Tag DB Object to overwrite

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "tagSetId": 0,
    "tagSet": {},
    "tags": [
      {}
    ]
  }
  

  This example has been generated automatically.

• #5Publish tag settagSetPublish

  Publish tag set by Id

  Payload

  Expand all

  object

  Payload object

  tagSetId

  integer

  uid: tagSetId

  id of the tag set

  Additional properties are allowed.

  Examples

  Payload

  {
    "tagSetId": 0
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Published tag settagSetPublished

  Info about the published tag set after tagSetPublish

  Payload

  Expand all

  object

  Payload object

  success

  boolean

  If the publishing was successful

  message

  string

  Message if the publishing was not successful

  Additional properties are allowed.

  Examples

  Payload

  {
    "success": true,
    "message": "string"
  }
  

  This example has been generated automatically.

• #1Refresh tagstagRefresh

  Refresh tags

  Payload

  Expand all

  array<any>

  List of DB Tag Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

• #2Refresh tag setstagSetRefresh

  Refresh tag sets

  Payload

  Expand all

  array<any>

  List of DB Tag Set Objects

  Examples

  Payload

  []
  

  This example has been generated automatically.

Accepts the following message:

{
  "type": "string",
  "name": "string",
  "file": {}
}

Accepts the following message:

{
  "success": true,
  "documentId": 0
}

Accepts the following message:

Accepts the following message:

{
  "success": true,
  "users": []
}