WebUserType

The WebUserType is a complex type (see Schema below) in xWeb that allows an application to access information about a Web User. The WebUserType is used in several xWeb web methods.

Namespaces

When passing a WebUserType as a parameter to xWeb web methods, be sure to set the namespace properly.

Important! Parameters that fail to specify proper namespaces will not be interpreted correctly and will result in method faults.

Properties

CurrentKey (string). The Customer Key of the User.

Individual

ind_token (Token). Some methods will set a Token that can be used by various Single Sign On methods. See WEBWebUserLoginAndRememberMe and others.

Customer

• cst_recno (string). Customer record number (not the same as cst_id which may have a different format).
• cst_web_login (string). Customer's username/login if different from <Email.eml_address>.
• cst_new_password. Used to set password. Data is not returned by Get methods.
• cst_new_password_confirm. See above.

Email

eml_address (string). User's primary email address. Used for logging in unless <Email.cst_web_login> is set.

Business_Address

Business_Phone

Business_Phone_XRef

cph_extension (string). Phone extension, if any.

Business Fax

Sample

<CurrentKey />
<Individual>
<ind_cst_key />
<ind_first_name />
<ind_mid_name />
<ind_last_name />
<ind_full_name_cp />
<ind_token />
</Individual>
<Customer>
<cst_recno />
<cst_web_login />
<cst_new_password />
<cst_new_password_confirm />
</Customer>
<Email>
<eml_address />
</Email>
<Business_Address>
<adr_city />
<adr_state />
<adr_post_code />
<adr_country />
</Business_Address>
<Business_Phone>
<phn_number />
</Business_Phone>
<Business_Phone_XRef>
<cph_extension />
</Business_Phone_XRef>
<Business_Fax>
<fax_number />
</Business_Fax>
<Business_Fax_XRef>
<cfx_extension />
</Business_Fax_XRef>

Schema

Here is the Schema for WebUserType:

<s:element name="WebUser" type="tns:WebUserType"/>
<s:complexType name="WebUserType">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CurrentKey" nillable="true" type="tns:av_key_Type">
<s:annotation>
<s:documentation>Primary Key.The current key is the record key for the object. This field must be set whenever updating an existing database record.</s:documentation>
</s:annotation>
</s:element>
<s:element name="Individual" type="tns:WebUser_Individual_DataObjectType"/>
<s:element name="Customer" type="tns:WebUser_Customer_DataObjectType"/>
<s:element name="Email" type="tns:WebUser_Email_DataObjectType"/>
<s:element name="Business_Address" type="tns:WebUser_Business_Address_DataObjectType"/>
<s:element name="Business_Phone" type="tns:WebUser_Business_Phone_DataObjectType"/>
<s:element name="Business_Phone_XRef" type="tns:WebUser_Business_Phone_XRef_DataObjectType"/>
<s:element name="Business_Fax" type="tns:WebUser_Business_Fax_DataObjectType"/>
<s:element name="Business_Fax_XRef" type="tns:WebUser_Business_Fax_XRef_DataObjectType"/>
</s:sequence>
</s:complexType>

Sample

Sample WebUserType containing data:

<CurrentKey>3524e2aa-03ef-4a4a-ace2-71aab9530f6e</CurrentKey>
<Individual>
<ind_cst_key>3524e2aa-03ef-4a4a-ace2-71aab9530f6e</ind_cst_key>
<ind_first_name>Michael</ind_first_name>
<ind_mid_name>E</ind_mid_name>
<ind_last_name>Acuff</ind_last_name>
<ind_full_name_cp>Dr Michael E Acuff</ind_full_name_cp>
</Individual>
<Customer>
<cst_recno>85992</cst_recno>
</Customer>
<Email>
<eml_address>jsmithzzz@zzz.com</eml_address>
</Email>
<Business_Address>
<adr_city>Orlando</adr_city>
<adr_state>FL</adr_state>
<adr_post_code>32792</adr_post_code>
<adr_country>UNITED STATES</adr_country>
</Business_Address>
<Business_Phone>
<phn_number>7776665555</phn_number>
</Business_Phone>
<Business_Phone_XRef>
<cph_extension>1000</cph_extension>
</Business_Phone_XRef>
<Business_Fax>
<fax_number>9996661234</fax_number>
</Business_Fax>