ListStudies

Top  Previous  Next

SOAP

ListStudies( aHandle, 

             aUserGroupName, aUserName, aProjectName

             &aStudyList

             &aErrorMsg );

 

REST

/ListStudies?Handle=<value>&UserGroup=<value>&UserLogin=<value>&Project

returns StudyList, ErrorMsg

 

Description:  ListStudies() lists all the studies for the current UserGroup, User and Project.

 

aHandle The value created in the call to Login().  

aUserGroupName, aUserName, Project Are required values.

&aStudyList The list of all studies for the specified UserGroup/User/Project pair.  This will be in standard SQLObjectList XML format.

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: ListStudies( lHandle, "AK@Anchorage", "Steve", "Automatic", lStudyList,  lErrorMsg );