Operations

Here is a list of all the operations provided by the web services. Operations on the module web service start with module, operations on the Memdoc central server web service start with server

Client identification functions:

server.getServerSessionId : Creates a session on the server and returns a serverSessionId which will be used to log into the module
module.loginToModule : login into the module. Creates a session for the user
server.loginToServer : login into the server.
module.logoutFromModule : logout and delete the module session
server.logoutFromServer : logout and delete the server session

User related function:

module.getUserInformation : get information like what permissions the current user has

module.getUserFields : get a list of parameters that can be read/saved for a user

module.getUserById : get information about the field data of a specific user

Patient management functions:

module.getPatientById : get information about a specific patient
module.searchPatient : search for patients
module.getPatientFields : get a list of parameters that can be read/saved for a patient
module.createNewPatient: create a new patient on the module.
module.deletePatient: delete an existing patient
server.insertPatient : insert the newly create patient on the server
server.deletePatient: delete an existing patient on the server

module.modifyPatient : update the information about a patient administered by the module

server.modifyPatient : update the information about a patient administered by the server

Form definition functions:

server.getListOfStudies : list all the available studies.
server.getListOfForms : list all the available forms of a given study.
server.downloadFormDefinition : download the structure of a form

Data management functions:

server.getListOfFormData : get a list of form data
server.insertForm : insert a form into the database

server.deleteFormData : deletes a form data

server.searchFormData : obtain form data records that match the specified search critieria
server.submitForm : make it impossible to modify the form anymore.
server.unSubmitForm : make it possible to change a committed form again.