Account List - Request
Please see the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.
| Element | Attributes |
|---|---|
<inAccount> | 🔹AccountEnd, 🔹AccountStart, 🔹DataDirPath |
🟥 <inACCOUNT>
| Element Type | Data Type |
|---|---|
| Parent | - |
Attributes:
🔹AccountEnd,🔹AccountStart,🔹DataDirPath
This is the root element of the XML account request, and is required. This
element is empty, and thus contains neither data nor child elements. The
following attributes of the <inACCOUNT> element are defined:
🔹 AccountEnd
| Data Type | Values | Default |
|---|---|---|
| Integer | [1...9999] | 9999 |
Attribute which allows the user to specify an account number other than the
default to terminate the account list. If left unspecified, or if a value is
provided which exceeds the number of accounts in the clients.set file, then
the last account number will be used.
🔹 AccountStart
| Data Type | Values | Default |
|---|---|---|
| Integer | [1...9999] | 9999 |
This optional attribute allows the user to specify a starting account number.
The default value of 1 will return an account list starting with the first
account. If the account start value exceeds the number of accounts available,
then the start value will be set to 1.
🔹 DataDirPath
| Data Type | Values | Default |
|---|---|---|
| Text | See below | See below |
If this attribute is set, the SCE will look for a data folder containing the
setup files in the path specified. Thus, if the DataDirPath is set to
C:\SCEX\, the SCE will look for the setup files in C:\SCEX\data.
If the calling application wishes to specify the data directory path in its
entirety (e.g. the calling app does not want the SCE to append \data to the
provided path), then simply terminate the specified DataDirPath with an
asterisk (*). Thus, if the DataDirPath is set to C:\SCEX\bank1\*, the SCE
will look for the setup files in C:\SCEX\bank1\.
If this attribute is not set, the SCE will attempt to locate the data folder in
the default data directory path location, which can be retrieved using the
<inVERSION> module query, and set via the SCE API.
This attribute is useful if you wish to use only a single installation of the
SCE, but have many different setup file groupings. By specifying a different
DataDirPath for each grouping, you can easily separate the groups from one
another instead of grouping them all together in a single directory.