isRegisteredUserEx

This method extends isRegisteredUser in that allows for automatic creation of users. Unregistered users are created only if the webservice user belongs to a group where “Create Unregistered Users” is enabled. Additionally This method allows for passing an additional if this username known as the replyTo user. This user must have “Create Unregistered Users” enabled for his group.

Parameters

Parameter Type Requirement Description
username xsd:string mandatory – cannot be null or empty The username of the registered user who will send a package
password xsd:string mandatory – cannot be null or empty The password of the registered user who will send a package
encodedPassword xsd:boolean optional – can be null (indicates false) Indicates whether the password parameter is MD5 encoded
emailID xsd:string mandatory – cannot be null or empty The email address of the intended recipient
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.
userInfo A UserInfo complex type (see Complex Type, below) optional – may be null or an empty Additional user information which is applied to the new user if it created. Populating this type with data may be used to suppress the user profile update page when a user logs in.

Response

  • Type: xsd:string
  • Possible return values:
    • “YES” - the intended recipient is registered with the system
    • “NO” - the intended recipient is not registered with the system
    • “ERROR” - an error occurred. This will be followed by a description of the error (e.g. “ERROR : Empty emailID”)

Complex Type

Parameter Type Requirement Description
birthDay xsd:string optional – may be null or empty  
birthMonth xsd:string optional – may be null or empty  
City xsd:string optional – may be null or empty  
Company xsd:string optional – may be null or empty  
contactLine xsd:string optional – may be null or empty  
contactNPA xsd:string optional – may be null or empty  
contactNxx xsd:string optional – may be null or empty  
Country xsd:string optional – may be null or empty  
Department xsd:string optional – may be null or empty  
emailAlias1 xsd:string optional – may be null or empty  
emailAlias2 xsd:string optional – may be null or empty  
emailAlias3 xsd:string optional – may be null or empty  
emailAlias4 xsd:string optional – may be null or empty  
emailAlias5 xsd:string optional – may be null or empty  
employerName xsd:string optional – may be null or empty  
faxPhone xsd:string optional – may be null or empty  
firstName xsd:string optional – may be null or empty  
forceSetAdditional xsd:string optional – may be null or empty. This value defaults to false Description: If this flag is set to false then the User Profile update page which can appear on login is suppressed.  
homePhone xsd:string optional – may be null or empty  
lastName xsd:string optional – may be null or empty  
middleName xsd:string optional – may be null or empty  
operatingSystem xsd:string optional – may be null or empty  
otherPhone xsd:string optional – may be null or empty  
State xsd:string optional – may be null or empty  
streetAddress1 xsd:string optional – may be null or empty  
streetAddress2 xsd:string optional – may be null or empty  
Title xsd:string optional – may be null or empty  
titlePosition xsd:string optional – may be null or empty  
workPhone xsd:string optional – may be null or empty  
zipCode xsd:string optional – may be null or empty  
WKFS