HQ Response

class q2_sdk.hq.models.hq_response.HqResponse(response, logger=None)

Wraps a response from HQ up as a handy object to work with

Parameters:

response (Response) – Body of HQ response

static get_hq_return_error(inner_response)

Parses HQ response and returns an error message if one exists

Parameters:

inner_response (Element) – Result Node from HQ response

property hydra_error_return_code: int | None

Retrieves the Hydra error return code from the response.

Returns:

The Hydra error return code or None if not present.

property hydra_error_return_code_description: str | None

Retrieves the Hydra error return code description from the response.

Returns:

The Hydra error return code description or None if not present.

property hydra_exception_message: str | None

Retrieves the Hydra exception message from the response.

Returns:

The Hydra exception message or None if not present.

parse_sproc_return(specific_table='Table', representation_row_class=None)

If the response from the db is sufficiently large, it is split up among multiple Table elements. As such, we return a list of these Table elements

Return type:

Union[List[TableRow], List[ObjectifiedElement]]

json()

Convert the result to a dictionary

Return type:

dict