GetDataSetFiltered module

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.dataSetType(*values)

Bases: Enum

CustomerList = 'CustomerList'

UserList = 'UserList'

UserLogonList = 'UserLogonList'

GeneratedTransactions = 'GeneratedTransactions'

AuthorizedTransactions = 'AuthorizedTransactions'

FutureTransactions = 'FutureTransactions'

PastTransactions = 'PastTransactions'

OtherTransactions = 'OtherTransactions'

TransactionProcessingBatches = 'TransactionProcessingBatches'

Faxes = 'Faxes'

UserLogon_OnlineBanking = 'UserLogon_OnlineBanking'

UserLogon_VoiceBanking = 'UserLogon_VoiceBanking'

UserLogon_BackOffice = 'UserLogon_BackOffice'

UserLogon_Merchant = 'UserLogon_Merchant'

FundsVerifications = 'FundsVerifications'

AuditData = 'AuditData'

MessageInbox = 'MessageInbox'

MessageInboxNew = 'MessageInboxNew'

UserAccountList = 'UserAccountList'

AuditScoreHistoryView = 'AuditScoreHistoryView'

GeneratedTransactionSuspect = 'GeneratedTransactionSuspect'

GeneratedTransactionScored = 'GeneratedTransactionScored'

AdminUserList = 'AdminUserList'

CustomerLocate = 'CustomerLocate'

UserLogonLocate = 'UserLogonLocate'

UserLocate = 'UserLocate'

GroupLocate = 'GroupLocate'

ProspectCustomerList = 'ProspectCustomerList'

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.Operand(*values)

Bases: Enum

NE = 'NE'

EQ = 'EQ'

GE = 'GE'

LE = 'LE'

GT = 'GT'

LT = 'LT'

BeginsWith = 'BeginsWith'

EndsWith = 'EndsWith'

Contains = 'Contains'

IsNull = 'IsNull'

NotNull = 'NotNull'

IN = 'IN'

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.FilterItem(is_or_operator_not_and, operand, parens_before, parens_after, field_name=None, comparison_value=None, not_before_paren=False)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.filterItems(filter_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.SortItem(ascending_sort, field_name=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.sortItems(sort_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.ParamsObj(logger, hq_credentials, data_set_type, page_number, page_size, filter_items=None, sort_items=None)

Bases: BackOfficeAuthenticatedParamsObj

Parameters definition for GetDataSetFiltered

Parameters:

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

• data_set_type (dataSetType)

• page_number (int) – The starting point of the page

• page_size (int) – The number of results to return per page

• filter_items (Optional[filterItems]) – Check out the guide on Transactions for more info.

• sort_items (Optional[sortItems])

• hq_credentials (BackOfficeHqCredentials) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.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:

BackOfficeResponse

q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.build_json(params_obj)

q2_sdk.hq.hq_api.backoffice.GetDataSetFiltered.build_soap(params_obj)