GetSessionsList

get_sessions_list(public_api_client, page_number, page_size)
Expand source code
get_sessions_list(public_api_client, page_number, page_size):
"""
Description
-----------
To get the paginated list of submitted interactive sessions by user.
Args
----
public_api_client: QDC api client object.
page_number: The specific page or subset of data in the context of the larger data set.
page_size: The number of records returned in each subset of data (or “page”).
Returns
-------
object: Response contains the paginated list of session information submitted by user like session created timestamp,
session completed timestamp, session id, session submitter username, session state, etc.
None: In case of any failure.
Usages
------
page_number = 0
page_size = 20
sessions = qdc_api.get_sessions_list(public_api_client, page_number, page_size) # To get the paginated list of the submitted sessions
"""
sessions = get_sessions.sync_detailed(client=get_client_with_headers_added(public_api_client),
page_number=page_number, page_size=page_size)
if sessions.status_code == 200:
response_data = sessions.content.decode('utf-8')
print(f"Get sessions response: {response_data}")
return sessions.parsed

Description

To get the paginated list of submitted interactive sessions by user.

Arguments

  • public_api_client: QDC api client object.
  • page_number: The specific page or subset of data in the context of the larger data set.
  • page_size: The number of records returned in each subset of data (or “page”).

Returns

  • object: Response contains the paginated list of session information submitted by user like session created timestamp,
  • session completed timestamp, session id, session submitter username, session state, etc.
  • None: In case of any failure.

Usages

page_number = 0
page_size = 20
sessions = qdc_api.get_sessions_list(public_api_client, page_number, page_size) # To get the paginated list of the submitted sessions