clinicaltrials.trialserver.TrialServer Class Reference

A server serving clinical trials. More...

Inheritance diagram for clinicaltrials.trialserver.TrialServer:

Public Member Functions
def	__init__
def	base_request
def	api_request
def	trial_request
def	search_request
	Returns a request that performs a search operation. More...
def	search_prepare_parts
	Returns a tuple of path and body data that should be used to construct the search request. More...
def	search_process_response
	Takes response data and returns a list of Trial instances, a meta dictionary and the URL to retrieve to get more results (if applicable). More...
def	get
	Perform a simple GET request against the server. More...

Public Attributes
	base
	api_key
	headers
	trial_endpoint
	trial_headers
	search_endpoint
	search_headers

Detailed Description

A server serving clinical trials.

Responses are expected to be JSON for now.

Constructor & Destructor Documentation

def clinicaltrials.trialserver.TrialServer.__init__	(		self,
			base,
			api_key = None
	)

Member Function Documentation

def clinicaltrials.trialserver.TrialServer.api_request	(		self,
			method,
			add_headers,
			path,
			data = None,
			override_url = None
	)

def clinicaltrials.trialserver.TrialServer.base_request	(		self,
			method,
			add_headers,
			url,
			data = None
	)

def clinicaltrials.trialserver.TrialServer.get	(		self,
			url,
			accept = 'application/json'
	)

Perform a simple GET request against the server.

def clinicaltrials.trialserver.TrialServer.search_prepare_parts	(		self,
			path,
			params
	)

Returns a tuple of path and body data that should be used to construct the search request.

By default appends all parameters (except "countries") as GET params and returns no body.

def clinicaltrials.trialserver.TrialServer.search_process_response	(		self,
			response
	)

Takes response data and returns a list of Trial instances, a meta dictionary and the URL to retrieve to get more results (if applicable).

By default assumes a 'results' and 'meta' dictionary.

def clinicaltrials.trialserver.TrialServer.search_request	(		self,
			params,
			override_url = None
	)

Returns a request that performs a search operation.

:param dict params: A dictionary with search parameters and limitations. Special limitations to support are:

• "countries": A list of country names to limit search to
• "recruiting": A bool flag whether only recruiting trials should be reported :param str override_url: You can override URL generation by providing it here. This is generally used to instantiate a request from a URL the service returned to get the next badge of results. :returns: A requests request instance

def clinicaltrials.trialserver.TrialServer.trial_request	(		self,
			trial_id
	)

Member Data Documentation

clinicaltrials.trialserver.TrialServer.api_key

clinicaltrials.trialserver.TrialServer.base

clinicaltrials.trialserver.TrialServer.headers

clinicaltrials.trialserver.TrialServer.search_endpoint

clinicaltrials.trialserver.TrialServer.search_headers

clinicaltrials.trialserver.TrialServer.trial_endpoint

clinicaltrials.trialserver.TrialServer.trial_headers

---

The documentation for this class was generated from the following file:

• trialserver.py