interface Login

Methods

mixed
getUserSettings(GetUserSettingsRequest $request, bool $timeout = false)

Get settings for a specific username/password.

mixed
getUserClients(GetUserClientsRequest $request, bool $timeout = false)

List all clients in the system for the specified username/password.

mixed
getUserClientSite(GetUserClientSiteRequest $request, bool $timeout = false)

Gets specific sitename, businesstype, industrycode info for a username/ password or clientid/siteid.

Details

at line 24
mixed getUserSettings(GetUserSettingsRequest $request, bool $timeout = false)

Get settings for a specific username/password.

Retrieves a list of settings for the username/password, including transaction type permissions and any messages to be displayed to the user . Message blocks contain 5 rows. Multiple message blocks can be returned as multiple settings.

Parameters

GetUserSettingsRequest $request
bool $timeout

Return Value

mixed

at line 38
mixed getUserClients(GetUserClientsRequest $request, bool $timeout = false)

List all clients in the system for the specified username/password.

Generates a list of all accessible client ids and the name of the client. The list represents client ids available for a particular username/ password in the user hierarchy.

Parameters

GetUserClientsRequest $request
bool $timeout

Return Value

mixed

at line 54
mixed getUserClientSite(GetUserClientSiteRequest $request, bool $timeout = false)

Gets specific sitename, businesstype, industrycode info for a username/ password or clientid/siteid.

Retrieves a list of clients and sites for the specified username/password , or a list of sites for the specified clientid, or the details on a specified clientid/siteid. The information returned shows details on the site’s setup.

Parameters

GetUserClientSiteRequest $request
bool $timeout

Return Value

mixed