NewUser

Description

The NewUser type contains one or more new or existing users and errors for user records that were not successfully returned. The NewUser type parameters are listed below.

Parameters

Name	Type	Description
userHolder	UserHolder	The userInfo type holds the complete information that describes a user.
isNew	boolean	Specifies whether the user is new (true) or if it is an existing account that was updated (false).
temporaryPassword	string	Indicates the temporary password that has been established for the user.

Usage

The NewUser type holds detailed information for a new or existing user and his or her preferences, as well as the user's temporary password . If any errors occrr during the call, they are returned in the status element in the order in which they were processed.

XML

The following XML snippet shows NewUser in the return element of the CreateUsers response. Note that an error message is returned in this example (inside the message element). In this example, three users were created; however, the second user (Johnny_Doe) was not properly identified (no login ID was specified). Therefore, an error was returned for the second user, though the service continued to run and created the third user (Jane_Doe).

<ae:CreateUsersResponse>
   <ae:return>
      <ae:userHolder>
         <ae:user>
            <ae:id xsi:type="ae:UserIdentifier">
               <ae:displayName>John_Doe</ae:displayName>
               <ae:id>47</ae:id>
               <ae:uuid>893de970-fafa-4907-84d3-50e7b82fcaaa</ae:uuid>
               <ae:loginId>J_Doe</ae:loginId>
            </ae:id>
            <ae:accessType>ACCESS-USER</ae:accessType>
            <ae:email>johndoe@companyName.com</ae:email>
            <ae:emailCC/>
            <ae:timezone/>
            <ae:offsetFromGMT>-25200000</ae:offsetFromGMT>
            <ae:dstSavings>3600000</ae:dstSavings>
            <ae:datePreference>DATE-FORMAT-FROM-LOCALE</ae:datePreference>
            <ae:timePreference>TIME-FORMAT-12HOUR</ae:timePreference>
            <ae:namespaceName>00000</ae:namespaceName>
            <ae:phoneNumber/>
            <ae:locale>en_US</ae:locale>
            <ae:isDeleted>false</ae:isDeleted>
            <ae:maxNotes>10</ae:maxNotes>
            <ae:maxChangeHistory>10</ae:maxChangeHistory>
            <ae:maxItemsPerPage>20</ae:maxItemsPerPage>
            <ae:fieldsMask>1</ae:fieldsMask>
            <ae:notesMask>4</ae:notesMask>
            <ae:changeHistoryMask>4</ae:changeHistoryMask>
            <ae:browserMask>1052724</ae:browserMask>
            <ae:preferredSolution xsi:type="ae:SolutionIdentifier">
               <ae:id>-1</ae:id>
            </ae:preferredSolution>
         </ae:user>
      </ae:userHolder>
      <ae:isNew>true</ae:isNew>
      <ae:temporaryPassword>WSNP</ae:temporaryPassword>
   </ae:return>
   <ae:return>
      <ae:userHolder>
         <ae:status>
            <ae:status>IS-ERROR</ae:status>
            <ae:message>Create user requires a user login id.</ae:message>
         </ae:status>
      </ae:userHolder>
      <ae:isNew>false</ae:isNew>
   </ae:return>
   <ae:return>
      <ae:userHolder>
         <ae:user>
            <ae:id xsi:type="ae:UserIdentifier">
               <ae:displayName>Jane_Doe</ae:displayName>
               <ae:id>48</ae:id>
               <ae:uuid>5ddbd7a7-bae0-467d-9e71-9390f0932541</ae:uuid>
               <ae:loginId>Ja_Doe</ae:loginId>
            </ae:id>
            <ae:accessType>ACCESS-USER</ae:accessType>
            <ae:email>jadoe@companyName.com</ae:email>
            <ae:emailCC/>
            <ae:timezone/>
            <ae:offsetFromGMT>-25200000</ae:offsetFromGMT>
            <ae:dstSavings>3600000</ae:dstSavings>
            <ae:datePreference>DATE-FORMAT-FROM-LOCALE</ae:datePreference>
            <ae:timePreference>TIME-FORMAT-12HOUR</ae:timePreference>
            <ae:namespaceName>00000</ae:namespaceName>
            <ae:phoneNumber/>
            <ae:locale>en_US</ae:locale>
            <ae:isDeleted>false</ae:isDeleted>
            <ae:maxNotes>10</ae:maxNotes>
            <ae:maxChangeHistory>10</ae:maxChangeHistory>
            <ae:maxItemsPerPage>20</ae:maxItemsPerPage>
            <ae:fieldsMask>1</ae:fieldsMask>
            <ae:notesMask>4</ae:notesMask>
            <ae:changeHistoryMask>4</ae:changeHistoryMask>
            <ae:browserMask>1052724</ae:browserMask>
            <ae:preferredSolution xsi:type="ae:SolutionIdentifier">
               <ae:id>-1</ae:id>
            </ae:preferredSolution>
         </ae:user>
      </ae:userHolder>
      <ae:isNew>true</ae:isNew>
      <ae:temporaryPassword>VWWR</ae:temporaryPassword>
   </ae:return>
</ae:CreateUsersResponse>