ExecuteStoredProcedureQueued module

Execute a stored procedure, queuing it if current session isn’t in the user context.

class q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.DataType

Bases: object

BigInt = 'BigInt'

Binary = 'Binary'

Bit = 'Bit'

Char = 'Char'

DateTime = 'DateTime'

Decimal = 'Decimal'

Float = 'Float'

Image = 'Image'

Int = 'Int'

Money = 'Money'

NChar = 'NChar'

NText = 'NText'

NVarChar = 'NVarChar'

Real = 'Real'

UniqueIdentifier = 'UniqueIdentifier'

SmallDateTime = 'SmallDateTime'

SmallInt = 'SmallInt'

SmallMoney = 'SmallMoney'

Text = 'Text'

Timestamp = 'Timestamp'

TinyInt = 'TinyInt'

VarBinary = 'VarBinary'

VarChar = 'VarChar'

Variant = 'Variant'

Xml = 'Xml'

Udt = 'Udt'

Structured = 'Structured'

Date = 'Date'

Time = 'Time'

DateTime2 = 'DateTime2'

DateTimeOffset = 'DateTimeOffset'

class q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.SqlParam(data_type, name=None, value=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.SqlParameters(sql_param=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.ParamsObj(logger, hq_credentials, user_id, stored_proc_short_name=None, sql_parameters=None)

Bases: WedgeOnlineBankingParamsObj

Parameters definition for ExecuteStoredProcedureQueued

Parameters:

• logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

• hq_credentials (HqCredentials) – HqCredentials instance with an hq_url and auth_token

• user_id (int) – Q2_User.UserID

• stored_proc_short_name (Optional[str]) – StoredProcShortName column entry in the Q2_ApiStoredProc table

• sql_parameters (Optional[SqlParameters]) – List of parameters to pass to the database

async q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.execute(params_obj, use_json=False, **kwargs)

This is the default way to submit the request to HQ. In theory, both json and soap payloads are equally accepted by HQ, though several variables may affect that (HQ version, Q2SDK implementation bugs, etc). This should not affect anything about the way your code deals with the data. In fact, the only difference to consuming extensions is the logging. Basically, call this with default parameters unless you find a compelling reason not to.

Parameters:

• params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint

• use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

HqResponse

async q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.get_soap(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.get_json(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.build_json(params_obj)

q2_sdk.hq.hq_api.wedge_online_banking.ExecuteStoredProcedureQueued.build_soap(params_obj)