Account Module - Request

The fields of the Data object supported by an Account module request are defined in alphabetical order below:

🟥 Data

The Data object encapsulates the request data for a given module, and must always be provided.

Fields: 🔹Begin, 🔹DataPath, 🔹End

Objects: None

The fields of the Data object supported by an Equal Pmt module request are defined in alphabetical order below:

🔹 Data.Begin

The Begin field specifies the desired starting account number to return information on. If the value of the Begin field exceeds the number of accounts defined in a given clients.set file, then a value of 1 will be used.

🔹 Data.DataPath

If this field is set, the SCE will look for a /data folder containing the setup files in the path specified. Thus, if the DataPath is set to /etc/sce, the SCE will look for the setup files in /etc/sce/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 DataPath with an asterisk (*). Thus, if the DataPath is set to /etc/sce/bank1/*, the SCE will look for the setup files in /etc/sce/bank1/.

If this field is not set, the SCE will attempt to located the /data folder in the default data directory path location, which can be retrieved using the Version module.

This field 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 DataPath for each grouping, you can easily separate the groups from one another instead of grouping them all together in a single directory.

🔹 Data.End

The End field specifies the desired ending account number to return information on. If the value of the End field exceeds the number of accounts defined in a given clients.set file, then the number of accounts will be used.