.. _rws_requests: .. index:: rws_requests rws_requests ************ The rws_requests module contains the core RWSRequest class and a set of Request classes that are standard in all versions of Rave Web Services for Rave. Also part of this module: * :ref:`architect` * :ref:`glv` * :ref:`working_clinical_data` * :ref:`post_clinical_data` rws_requests also provides additional requests in sub-modules for additional features: * :ref:`biostats_gateway` * :ref:`odm_adapter` .. _version_request: .. index:: VersionRequest VersionRequest() ---------------- Returns the text result of calling:: https://{ host }/RaveWebServices/version Example:: >>> from rwslib import RWSConnection >>> from rwslib.rws_requests import VersionRequest >>> r = RWSConnection('innovate', 'username', 'password') #Authorization optional >>> r.send_request(VersionRequest()) u'1.15.0' .. _buildversion_request: .. index:: BuildVersionRequest BuildVersionRequest() --------------------- Returns the text result of calling:: https://{ host }/RaveWebServices/version/build Returns a 200 response code and the internal build number. Example:: >>> from rwslib import RWSConnection >>> from rwslib.rws_requests import BuildVersionRequest >>> r = RWSConnection('innovate', 'username', 'password') #Authorization optional >>> r.send_request(BuildVersionRequest()) u'5.6.5.213' .. _codename_request: .. index:: CodeNameRequest CodeNameRequest() ----------------- Returns the text result of calling:: https://{ host }/RaveWebServices/version/codename Returns a 200 response code and the internal code name of the RWS version. Example:: >>> from rwslib import RWSConnection >>> from rwslib.rws_requests import CodeNameRequest >>> r = RWSConnection('innovate') #Authorization optional >>> r.send_request(CodeNameRequest()) u'Uakari' .. _diagnostics_request: .. index:: DiagnosticsRequest DiagnosticsRequest() -------------------- Returns the text result of calling:: https://{ host }/RaveWebServices/diagnostics Returns a 200 response code and the text *OK* if RWS self-checks pass. Example:: >>> from rwslib import RWSConnection >>> from rwslib.rws_requests import DiagnosticsRequest >>> r = RWSConnection('innovate', 'username', 'password') #Authorization optional >>> r.send_request(DiagnosticsRequest()) u'OK' .. _twohundred_request: .. index:: TwoHundredRequest TwoHundredRequest() ------------------- Returns the html result of calling:: https://{ host }/RaveWebServices/twohundred Returns a 200 response code and a html document that contains information about the MAuth configuration of Rave Web Services on this url. Example:: >>> from rwslib import RWSConnection >>> from rwslib.rws_requests import TwoHundredRequest >>> r = RWSConnection('innovate') #Authorization optional >>> r.send_request(TwoHundredRequest()) u'\r\n\r\n