CompleteSession

complete_session(public_api_client, session_id)
Expand source code
complete_session(public_api_client, session_id):
"""
Description
-----------
To end a submitted session.
Args
----
public_api_client: QDC api client object.
session_id: Session id which needs to be completed.
Returns
-------
string: State of the session id.
None: In case of any failure.
Usages
------
session_id = "1234"
complete_session = qdc_api.complete_session(public_api_client, session_id)
"""
complete = post_sessions_session_id_complete.sync_detailed(
client=_get_client_with_new_trace_header(public_api_client), session_id=session_id)
if complete.status_code == 200:
response_data = complete.content.decode('utf-8')
print(f"Complete session: {session_id} successfully, response: {response_data}")
return complete.parsed.result
Description
To end a submitted session.
Arguments
public_api_client: QDC api client object.
session_id: Session id which needs to be completed.
Returns
string: State of the session id.
None: In case of any failure.
Usages
session_id = "1234"
complete_session = qdc_api.complete_session(public_api_client, session_id)