GetUserAccountListOptionalMasking module

Get a users account list, DesiredHydraProductCodes is pipe delimited list 2 char values of HydraProductTypeCode+HydraProductCode, with * allowed in HydraProductCode (D*|L*|C* for all deposit, loan and credit accounts)

class q2_sdk.hq.hq_api.q2_api.GetUserAccountListOptionalMasking.ParamsObj(logger, online_user_name, desired_rights_bit_flag, desired_rights_is_explicit, desired_hydra_product_codes, apply_account_list_rights_limit_bitflag_mask, hq_credentials=None)

Bases: Q2ApiParamsObj

Parameters definition for GetUserAccountListOptionalMasking

Parameters:

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

• online_user_name (str) – Logon name of an online user

• desired_rights_bit_flag (int) – 0: No rights, 7: View, Deposit, and Withdraw Rights

• desired_rights_is_explicit (bool) – True: Only show accounts with rights that match desired_rights_bit_flag exactly. False: Show accounts with at least desired_rights_big_flag

• desired_hydra_product_codes (str) – Pipe delimited list of 2 char values representing HydraProductTypeCode+HydraProductCode, with * allowed in HydraProductCode (D*|L*|C* for all deposit, loan and credit accounts)

• apply_account_list_rights_limit_bitflag_mask (bool)

• hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.q2_api.GetUserAccountListOptionalMasking.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.q2_api.GetUserAccountListOptionalMasking.get_soap(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.GetUserAccountListOptionalMasking.get_json(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.q2_api.GetUserAccountListOptionalMasking.build_json(params_obj)

q2_sdk.hq.hq_api.q2_api.GetUserAccountListOptionalMasking.build_soap(params_obj)