com.odin.controller

Class StudyConsentRest

java.lang.Object

com.odin.controller.StudyConsentRest

@Component
public class StudyConsentRest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StudyConsentRest()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	completeWithdrawConsent(java.lang.String keyAsString, UserConsentDetails userConsentDetails) This Restful Web Service takes one parameter keyAsString and UserConsentDetails json object This is used to store the user consent withdrawn date RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/completeWithdrawConsent REQUEST TYPE: POST
java.lang.String	getConsentFields(java.lang.String keyAsString) This Restful Web Service takes one parameter keyAsString This is used to get consent fields,review consent form and withdraw consent form for the particular study RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/getConsentFields REQUEST TYPE: GET
java.lang.String	putUserConsentDetails(java.lang.String keyAsString, UserConsentDetails userConsentDetails) This Restful Web Service takes one parameter keyAsString and UserConsentDetails json object This is used to store user details (name,signature,consentAgreed date) RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/putUserConsentDetails REQUEST TYPE: POST

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StudyConsentRest

public StudyConsentRest()

Method Detail

getConsentFields

public java.lang.String getConsentFields(java.lang.String keyAsString)

 This Restful Web Service takes one parameter keyAsString
 This is used to get consent fields,review consent form and withdraw consent form for the particular study
 RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/getConsentFields
 REQUEST TYPE: GET
 
 

Parameters:

keyAsString - - phone session key

Returns:

If session key is invalid,
     returns json object with fields("code":404,"message":"error")
If study is completed,
     returns json object with fields("code":600,"message":"study is completed")
If consent not agreed,
     returns json object with fields("code":600,"message":"consent not agreed")
If study not exists,
     returns json object with fields ("code":700,message":"study not exists")
 If session key is valid
      -onSuccess- returns json object with fields (jsonResult={consentid,studyid,heading,longFormData,shortFormData},code=200,message="ok")
      -If any exception occurs then returns json object with fields(code=500,message="error")
 

putUserConsentDetails

public java.lang.String putUserConsentDetails(java.lang.String keyAsString,
                                     UserConsentDetails userConsentDetails)

 This Restful Web Service takes one parameter keyAsString and UserConsentDetails json object
 This is used to store user details (name,signature,consentAgreed date)
 RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/putUserConsentDetails
 REQUEST TYPE: POST
 
 

Parameters:

keyAsString - - phone session key

json - object of type UserConsentDetails class with fields (name,signature,consentAgreedDate)

Returns:

If session key is invalid,
     returns json object with fields("code":404,"message":"error")
If study is completed,
     returns json object with fields("code":600,"message":"study is completed")
If consent not agreed,
     returns json object with fields("code":600,"message":"consent not agreed")
If study not exists,
     returns json object with fields ("code":700,message":"study not exists")
 If session key is valid
      -onSuccess- store user details and returns (code=200,message="ok")
      -If any exception occurs then returns json object with fields(code=500,message="error")
 

completeWithdrawConsent

public java.lang.String completeWithdrawConsent(java.lang.String keyAsString,
                                       UserConsentDetails userConsentDetails)

 This Restful Web Service takes one parameter keyAsString and UserConsentDetails json object
 This is used to store the user consent withdrawn date 
 RestFul End Point URI: http://host:port/ResearcherService/rest/studyConsent/completeWithdrawConsent
 REQUEST TYPE: POST
 
 

Parameters:

keyAsString - - phone session key

json - object of type UserConsentDetails class with fields (consentWithdrawnDate)

Returns:

If session key is invalid,
     returns json object with fields("code":404,"message":"error")
If study is completed,
     returns json object with fields("code":600,"message":"study is completed")
If consent not agreed,
     returns json object with fields("code":600,"message":"consent not agreed")
If study not exists,
     returns json object with fields ("code":700,message":"study not exists")
 If session key is valid
      -onSuccess- store user consent withdrawn details and returns (code=200,message="ok")
      -If any exception occurs then returns json object with fields(code=500,message="error")