Summary

Obtains a list of available modules from the Hopewiser SOAP server.

Syntax

Modules [] modules = soap.modules(string session_id);

where for example:

modules = [
            {
              'CLASS'       => 'ah21',
              'COUNTRY'     => 'uk',
              'DESCRIPTION' => 'AH21PCIX Module - UK data',
              'MODULE_ID'   => 'ah21_uk'
            },
            {
              'CLASS'       => 'listapi',
              'COUNTRY'     => 'uk',
              'DESCRIPTION' => 'List API Module - UK data',
              'MODULE_ID'   => 'listapi_uk'
            },
            {
              'CLASS'       => 'ah21',
              'COUNTRY'     => 'aus',
              'DESCRIPTION' => 'AH21PCIX Module - AUSTRALIAN data',
              'MODULE_ID'   => 'ah21_aus'
            },
            {
              'CLASS'       => 'listapi',
              'COUNTRY'     => 'aus',
              'DESCRIPTION' => 'List API Module - AUSTRALIAN data',
              'MODULE_ID'   => 'listapi_aus'
            }
          ];

Usage

When a client application invokes the Modules call, it passes in a Session ID. Upon invocation, the Hopewiser SOAP server authenticates the Session ID and returns a Modules structure similar to that described above.

The Modules call is important as it allows a client to determine what modules (and thus datasets) are available to them and what call should be used to access them.

See the ah21 and listapi documentation for details of how to call different modules.

Samples

For a sample Modules request please click here.

For a sample Modules response please click here.