Skip to content
Snippets Groups Projects
Commit e3aa31e2 authored by sveseli's avatar sveseli
Browse files

starting to document DS experiment API

parent f7506e9f
No related branches found
No related tags found
No related merge requests found
......@@ -7,6 +7,6 @@ ExperimentDsApi
.. autoclass:: dm.ds_web_service.api.experimentDsApi.ExperimentDsApi()
:show-inheritance:
:members: __init__, getExperimentTypes, getExperiments
:members: __init__, getExperimentTypes, getExperiments, getExperimentsByStation
......@@ -78,8 +78,25 @@ class ExperimentDsApi(DsRestApi):
responseData = self.sendSessionRequest(url=url, method='GET')
return self.toDmObjectList(responseData, Experiment)
@DsRestApi.execute
@DsRestApi.execute2
def getExperimentsByStation(self, stationName):
'''
Get list of experiments on a given station.
:param stationName: DM station name
:type stationName: str
:returns: list of Experiment objects
:raises AuthorizationError: in case user is not authorized to manage the given DM station
:raises DmException: in case of any other errors
>>> experimentList = api.getExperiments()
>>> for experiment in experimentList:
>>> print experiment['id'], experiment['name']
'''
url = '%s/experimentsByStation/%s' % (self.getContextRoot(), stationName)
if not stationName:
raise InvalidRequest('Experiment station name must be provided.')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment