User

Information about a user is implemented in the User object. The attributes of the User object are:

Attribute	Description
companyId	A string of maximum length 10 containing the unique identifier of the company the user belongs to.
email	A string of maximum length 50 containing the email address of the user.
firstName	A string of maximum length 30 containing the first name of the user.
forcePwdReset	A boolean value indicating if the user must change their password at the next login attempt.
id	A string of maximum length 10 that indicates the unique identifier for the user.
lastName	A string of maximum length 30 containing the last name of the user.
lockedOut	A boolean value indicating if the user is locked out.
obeyDst	A boolean value indicating if the user obeys daylight saving time.
pagerEmail	A string of maximum length 50 containing the pager email address of the user.
qspInstance	A character value representing the instance of the Portal the user belongs to. Valid values are: "1" - Qualcomm "2" - Shaw "3" - CNR
role	A Role object containing information about the user's role.
timeZone	A TimeZone object containing information about the user's timezone settings.

Here is how the User Information object is defined within the WSDL

<complexType name="User">

<sequence>

<element name="companyId" nillable="true" type="xsd:string"/>

<element name="email" nillable="true" type="xsd:string"/>

<element name="firstName" nillable="true" type="xsd:string"/>

<element name="forcePwdReset" type="xsd:boolean"/>

<element name="id" nillable="true" type="xsd:string"/>

<element name="lastName" nillable="true" type="xsd:string"/>

<element name="lockedOut" type="xsd:boolean"/>

<element name="obeyDst" type="xsd:boolean"/>

<element name="pagerEmail" nillable="true" type="xsd:string"/>

<element name="qspInstance" nillable="true" type="xsd:string"/>

<element name="role" nillable="true" type="tns2:Role"/>

<element name="timeZone" nillable="true" type="tns2:TimeZone"/>

</sequence>

</complexType>

Here is some sample XML that shows what the User Information object will look like in XML

<user>

<companyId>MYCOMPANY</companyId>

<email>romanowski@mycompany.com</email>

<firstName>Nick</firstName>

<forcePwdReset>0</forcePwdReset>

<id>ROMANOWSKI</id>

<lastName>Romanowski</lastName>

<lockedOut>false</lockedOut>

<obeyDst>false</obeyDst>

<pagerEmail>nick@mycompany.com</pagerEmail>

<qspInstance>1</QSPinstance>

<role>

<description>Administrator</description>

<name>Admin</name>

</role>

<timeZone>

<dstLongName>Pacific Daylight Saving Time</dstLongName>

<dstShortName>PDT</dstShortName>

<gmtOffset>GMT-08:00</gmtOffset>

<name>Pacific Time</name>

<stdLongName>Pacific Standard Time</stdLongName>

<stdShortName>PST</stdShortName>

</timeZone>

</user>