GetGroupList module

Get the group list

Sample response (may differ slightly in your environment)

<?xml version="1.0"?>
<Q2API HqVersion="4.2.3.4215A" HqAssemblyVersion="4.2.6185.31252" ServerDateTime="2018-08-10T12:00:19.4293007-05:00">
  <Result>
    <ErrorCode ErrorType="Success">0</ErrorCode>
    <ErrorDescription/>
    <HydraErrorReturnCode>0</HydraErrorReturnCode>
  </Result>
  <Data>
    <DalGroupList>
      <Q2_GroupList>
        <GroupID>1</GroupID>
        <GroupDesc>Retail Users</GroupDesc>
        <DefaultUiSelectionID>2</DefaultUiSelectionID>
        <DashboardProfileID>1</DashboardProfileID>
        <SecAlertProfileID>1</SecAlertProfileID>
        <IsCommercial>false</IsCommercial>
        <DashboardProfileDescription>No Dashboard Elements</DashboardProfileDescription>
        <SecAlertProfileDescription>No Alerts - this profile should be removed after initial install</SecAlertProfileDescription>
        <EnableEmailByDefault>true</EnableEmailByDefault>
        <UiSelectionDescription>UuxQ2English</UiSelectionDescription>
        <UiSelectionLanguage>English (United States) </UiSelectionLanguage>
        <CustomerCount>185</CustomerCount>
        <UserCount>184</UserCount>
        <UserLogonCount>170</UserLogonCount>
        <IsTreasury>false</IsTreasury>
        <UserRoleCount>0</UserRoleCount>
        <ActiveUserCount>184</ActiveUserCount>
        <InactiveUserCount>0</InactiveUserCount>
        <DisabledUserCount>0</DisabledUserCount>
        <AwaitingActivationUserCount>0</AwaitingActivationUserCount>
      </Q2_GroupList>
    </DalGroupList>
  </Data>
</Q2API>

class q2_sdk.hq.hq_api.q2_api.GetGroupList.ParamsObj(logger, hq_credentials=None)[source]

Bases: Q2ApiParamsObj

Parameters definition for GetGroupList

Parameters:

logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)
hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

class q2_sdk.hq.hq_api.q2_api.GetGroupList.Q2_GroupList(ActiveUserCount, AwaitingActivationUserCount, CustomerCount, DashboardProfileDescription, DashboardProfileID, DefaultUiSelectionID, DisabledUserCount, EnableEmailByDefault, GroupDesc, GroupID, InactiveUserCount, IsCommercial, IsTreasury, SecAlertProfileDescription, SecAlertProfileID, UiSelectionDescription, UiSelectionLanguage, UserCount, UserLogonCount, UserRoleCount)[source]

Bases: object

Q2_GroupList(ActiveUserCount: lxml.objectify.IntElement, AwaitingActivationUserCount: lxml.objectify.IntElement, CustomerCount: lxml.objectify.IntElement, DashboardProfileDescription: lxml.objectify.StringElement, DashboardProfileID: lxml.objectify.IntElement, DefaultUiSelectionID: lxml.objectify.IntElement, DisabledUserCount: lxml.objectify.IntElement, EnableEmailByDefault: lxml.objectify.BoolElement, GroupDesc: lxml.objectify.StringElement, GroupID: lxml.objectify.IntElement, InactiveUserCount: lxml.objectify.IntElement, IsCommercial: lxml.objectify.BoolElement, IsTreasury: lxml.objectify.BoolElement, SecAlertProfileDescription: lxml.objectify.StringElement, SecAlertProfileID: lxml.objectify.IntElement, UiSelectionDescription: lxml.objectify.StringElement, UiSelectionLanguage: lxml.objectify.StringElement, UserCount: lxml.objectify.IntElement, UserLogonCount: lxml.objectify.IntElement, UserRoleCount: lxml.objectify.IntElement)

ActiveUserCount: IntElement

AwaitingActivationUserCount: IntElement

CustomerCount: IntElement

DashboardProfileDescription: StringElement

DashboardProfileID: IntElement

DefaultUiSelectionID: IntElement

DisabledUserCount: IntElement

EnableEmailByDefault: BoolElement

GroupDesc: StringElement

GroupID: IntElement

InactiveUserCount: IntElement

IsCommercial: BoolElement

IsTreasury: BoolElement

SecAlertProfileDescription: StringElement

SecAlertProfileID: IntElement

UiSelectionDescription: StringElement

UiSelectionLanguage: StringElement

UserCount: IntElement

UserLogonCount: IntElement

UserRoleCount: IntElement

class q2_sdk.hq.hq_api.q2_api.GetGroupList.DalGroupList(Q2_GroupList)[source]

Bases: object

DalGroupList(Q2_GroupList: Union[q2_sdk.hq.hq_api.q2_api.GetGroupList.Q2_GroupList, List[q2_sdk.hq.hq_api.q2_api.GetGroupList.Q2_GroupList]])

Q2_GroupList: Union[Q2_GroupList, List[Q2_GroupList]]

class q2_sdk.hq.hq_api.q2_api.GetGroupList.Data(DalGroupList)[source]

Bases: object

Data(DalGroupList: Union[q2_sdk.hq.hq_api.q2_api.GetGroupList.DalGroupList, List[q2_sdk.hq.hq_api.q2_api.GetGroupList.DalGroupList]])

DalGroupList: Union[DalGroupList, List[DalGroupList]]

class q2_sdk.hq.hq_api.q2_api.GetGroupList.ResultNode[source]: Bases: object

class q2_sdk.hq.hq_api.q2_api.GetGroupList.HqResponse(raw_response)[source]

Bases: HqResponse

Parameters:: response – Body of HQ response

async q2_sdk.hq.hq_api.q2_api.GetGroupList.execute(params_obj, use_json=False, **kwargs)[source]

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.GetGroupList.get_soap(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:: HqResponse

async q2_sdk.hq.hq_api.q2_api.GetGroupList.get_json(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:: HqResponse

q2_sdk.hq.hq_api.q2_api.GetGroupList.build_json(params_obj)[source]

q2_sdk.hq.hq_api.q2_api.GetGroupList.build_soap(params_obj)[source]