This method is an extension to the areRegisteredUsers message (see the Description). This method works in the same way but implements the following additional functionality: dependent upon configuration of the Secure Document Exchange server, This method can also cause unregistered users to be created. The Request Parameters and Response are identical barring the following addition.
Additional Request Parameters
| Parameter |
Type |
Requirement |
Description |
|---|
| replyTo |
xsd:string |
optional – can be null or empty |
An optional parameter which, if used in the sendPackage message will denote the user from whom a package is to be sent on behalf of. In This method, the replyTo user’s group configuration settings are interrogated to see whether unregistered users should be created. If the replyTo user is not a registered user of the system, then the group configuration settings of the user denoted by username will be checked to see whether unregistered recipients should be created. |
Response
In essence the response can be interpreted in exactly the same way as for areRegisteredUsers i.e. NO means some users are not registered, YES means all users are registered this may mean that one or more users were also created. And ERROR means an error occurred. If you wish to know when users are created then you should call areRegisteredUsers first in order to determine which users need to be created.
- Type: xsd:string
- Possible return values:
- “YES” - All of the intended recipients are registered with the system. If the SDX server is configured to allow user creation “on the fly” and the replyTo users group has the right to create unregistered users then any unregistered users were created.
- “NO” - One or more of the intended recipients are not registered with the system. This will be followed by a semi-colon separated list of the email IDs of the unregistered users (e.g. “NO : user1@wkfs.com;user2@wkfs.com”) If create unregistered is enabled for the replyTo user and the email address is not in a valid format (name@domain.topleveldomain).
- “ERROR” - An error occurred. This will be followed by a description of the error (e.g. “ERROR : No emailIDs provided”)
