Skip to content

Commit be1a758

Browse files
author
sreeder
committed
add restype to result function
1 parent 5ec7eb6 commit be1a758

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

odm2api/ODM2/services/readService.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ def getAffiliations(self, ids=None, personfirst=None, personlast=None, orgcode=N
614614
return None
615615

616616
# Results
617-
def getResults(self, ids=None, type=None, uuids=None, actionid=None, simulationid=None, sfid=None,
617+
def getResults(self, ids=None, type=None, restype = None, uuids=None, actionid=None, simulationid=None, sfid=None,
618618
variableid=None, siteid=None, sfids=None, sfuuids=None, sfcodes=None):
619619

620620
# TODO what if user sends in both type and actionid vs just actionid
@@ -625,7 +625,7 @@ def getResults(self, ids=None, type=None, uuids=None, actionid=None, simulationi
625625
626626
Args:
627627
ids (list, optional): List of ResultIDs.
628-
type (str, optional): Type of Result from
628+
restype (str, optional): Type of Result from
629629
`controlled vocabulary name <http://vocabulary.odm2.org/resulttype/>`_.
630630
uuids (list, optional): List of UUIDs string.
631631
actionid (int, optional): ActionID.
@@ -642,7 +642,7 @@ def getResults(self, ids=None, type=None, uuids=None, actionid=None, simulationi
642642
643643
Examples:
644644
>>> ReadODM2.getResults(ids=[39,40])
645-
>>> ReadODM2.getResults(type='Time series coverage')
645+
>>> ReadODM2.getResults(restype='Time series coverage')
646646
>>> ReadODM2.getResults(sfids=[65])
647647
>>> ReadODM2.getResults(uuids=['a6f114f1-5416-4606-ae10-23be32dbc202',
648648
... '5396fdf3-ceb3-46b6-aaf9-454a37278bb4'])
@@ -655,7 +655,12 @@ def getResults(self, ids=None, type=None, uuids=None, actionid=None, simulationi
655655
query = self._session.query(Results)
656656

657657
if type:
658+
import warnings
659+
warnings.warn(
660+
"The parameter 'type' is no longer be supported. Please use the restype parameter instead.")
658661
query = query.filter_by(ResultTypeCV=type)
662+
if restype:
663+
query = query.filter_by(ResultTypeCV=restype)
659664
if variableid:
660665
query = query.filter_by(VariableID=variableid)
661666
if ids:

0 commit comments

Comments
 (0)