UserHolder

Description

The UserHolder type contains the UserInfo response and any errors for user records that were not successfully returned. The UserHolder type parameters are listed below.
Parameters

Name	Type	Description
user	UserInfo	The userInfo type holds the complete information that describes a user.
status	Status	Holds status information for any messages or failures that are encountered.
Usage

The UserHolder type holds detailed information for a user and his or her preferences. If any errors occur during the call, they are returned in the status element in the order in which they were processed.
XML

The following XML snippet shows UserHolder in the <ae:user> return element of the GetUsers response. Note that an error message is returned in this example (inside the message element). In this example, three users were requested using the GetUsers call; however, the second user (Kathy) was not properly identified. Therefore, an error was returned for the second user, though the service continued to run and returned the third user (Laura).
<ae:GetUsersResponse>
   <ae:return>
      <ae:user>
         <ae:id xsi:type="ae:UserIdentifier">
            <ae:displayName>John Support Manager</ae:displayName>
            <ae:id>21</ae:id>
            <ae:uuid>08784a43-970f-4d28-9a6e-c301077ca653</ae:uuid>
            <ae:loginId>john</ae:loginId>
         </ae:id>
         <ae:accessType>ACCESS-USER</ae:accessType>
         <ae:email>john@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:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>Everyone</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>ade39c21-e7b2-4dcb-a231-d3d872671b59</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>IDM View Only</ae:displayName>
            <ae:id>5</ae:id>
            <ae:uuid>af38532d-e79c-495f-a3e6-f4bf784cc492</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>IM Technician</ae:displayName>
            <ae:id>6</ae:id>
            <ae:uuid>902a1300-6ae1-44d7-b46a-e420babe8497</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>IM Manager</ae:displayName>
            <ae:id>7</ae:id>
            <ae:uuid>b70af5de-6642-4228-b9bb-d0da59bb6909</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>IM Administrator</ae:displayName>
            <ae:id>8</ae:id>
            <ae:uuid>b77b6e9d-e75a-4841-be1b-9c358affb797</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>CR Approval Board Members</ae:displayName>
            <ae:id>13</ae:id>
            <ae:uuid>ea167b8c-e9ea-4196-9727-dfd2f10fd751</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>CR Submitters</ae:displayName>
            <ae:id>11</ae:id>
            <ae:uuid>cf83a358-d7fb-4b96-8f98-ed532c66cd0a</ae:uuid>
         </ae:group>
         <ae:fieldsMask>1</ae:fieldsMask>
         <ae:notesMask>4</ae:notesMask>
         <ae:changeHistoryMask>4</ae:changeHistoryMask>
         <ae:browserMask>13635632</ae:browserMask>
         <ae:preferredSolution xsi:type="ae:SolutionIdentifier">
            <ae:displayName>Incident Management</ae:displayName>
            <ae:id>2</ae:id>
            <ae:uuid>c6f06a70-4d06-42a4-a3a9-50b2120dca41</ae:uuid>
            <ae:uniqueName>INCIDENT_MANAGEMENT</ae:uniqueName>
            <ae:tabName>Incident Mgmt</ae:tabName>
         </ae:preferredSolution>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Incident Management</ae:displayName>
               <ae:id>2</ae:id>
               <ae:uuid>c6f06a70-4d06-42a4-a3a9-50b2120dca41</ae:uuid>
               <ae:uniqueName>INCIDENT_MANAGEMENT</ae:uniqueName>
               <ae:tabName>Incident Mgmt</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>Trend Of Incidents Closed On Initial Call</ae:displayName>
               <ae:id>38</ae:id>
               <ae:uuid>f8a5ce79-4b40-45cf-9f6d-735d060e90de</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Change Request Management</ae:displayName>
               <ae:id>3</ae:id>
               <ae:uuid>0ea28a74-6dde-406f-b19a-4c45aec40294</ae:uuid>
               <ae:uniqueName>CHANGE_REQUEST_MANAGEMENT</ae:uniqueName>
               <ae:tabName>Change Requests</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>Built-In: All Active Items I Own</ae:displayName>
               <ae:id>-6</ae:id>
               <ae:uuid>-6</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Issue Defect Management</ae:displayName>
               <ae:id>1</ae:id>
               <ae:uuid>cea0a86c-5d74-4e12-b8d6-9d6b90186f1e</ae:uuid>
               <ae:uniqueName>ISSUE_DEFECT_MANAGEMENT</ae:uniqueName>
               <ae:tabName>IDM</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>Built-In: All Active Items I Own</ae:displayName>
               <ae:id>-6</ae:id>
               <ae:uuid>-6</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
      </ae:user>
   </ae:return>
   <ae:return>
      <ae:status>
         <ae:status>IS-ERROR</ae:status>
         <ae:message>Invalid user Kath.</ae:message>
      </ae:status>
   </ae:return>
   <ae:return>
      <ae:user>
         <ae:id xsi:type="ae:UserIdentifier">
            <ae:displayName>Laura Engineer</ae:displayName>
            <ae:id>5</ae:id>
            <ae:uuid>e0538593-21aa-4ca5-a229-473563c21470</ae:uuid>
            <ae:loginId>laura</ae:loginId>
         </ae:id>
         <ae:accessType>ACCESS-USER</ae:accessType>
         <ae:email>laura@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:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>Everyone</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>ade39c21-e7b2-4dcb-a231-d3d872671b59</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>IDM Team</ae:displayName>
            <ae:id>2</ae:id>
            <ae:uuid>634aed4a-bc98-49d3-86f0-6095c2f7b9b6</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>CR Technical Analysts</ae:displayName>
            <ae:id>12</ae:id>
            <ae:uuid>661c1c5b-2e1d-4ad1-9d43-60a3dad6f931</ae:uuid>
         </ae:group>
         <ae:group xsi:type="ae:GroupIdentifier">
            <ae:displayName>CR Submitters</ae:displayName>
            <ae:id>11</ae:id>
            <ae:uuid>cf83a358-d7fb-4b96-8f98-ed532c66cd0a</ae:uuid>
         </ae:group>
         <ae:fieldsMask>1</ae:fieldsMask>
         <ae:notesMask>4</ae:notesMask>
         <ae:changeHistoryMask>4</ae:changeHistoryMask>
         <ae:browserMask>13635632</ae:browserMask>
         <ae:preferredSolution xsi:type="ae:SolutionIdentifier">
            <ae:displayName>Issue Defect Management</ae:displayName>
            <ae:id>1</ae:id>
            <ae:uuid>cea0a86c-5d74-4e12-b8d6-9d6b90186f1e</ae:uuid>
            <ae:uniqueName>ISSUE_DEFECT_MANAGEMENT</ae:uniqueName>
            <ae:tabName>IDM</ae:tabName>
         </ae:preferredSolution>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Issue Defect Management</ae:displayName>
               <ae:id>1</ae:id>
               <ae:uuid>cea0a86c-5d74-4e12-b8d6-9d6b90186f1e</ae:uuid>
               <ae:uniqueName>ISSUE_DEFECT_MANAGEMENT</ae:uniqueName>
               <ae:tabName>IDM</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>My In Box</ae:displayName>
               <ae:id>54</ae:id>
               <ae:uuid>034982d7-822e-421e-88cf-1fe2cb436785</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Incident Management</ae:displayName>
               <ae:id>2</ae:id>
               <ae:uuid>c6f06a70-4d06-42a4-a3a9-50b2120dca41</ae:uuid>
               <ae:uniqueName>INCIDENT_MANAGEMENT</ae:uniqueName>
               <ae:tabName>Incident Mgmt</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>Built-In: All Items I Submitted</ae:displayName>
               <ae:id>-11</ae:id>
               <ae:uuid>-11</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
         <ae:solutionData>
            <ae:solution xsi:type="ae:SolutionIdentifier">
               <ae:displayName>Change Request Management</ae:displayName>
               <ae:id>3</ae:id>
               <ae:uuid>0ea28a74-6dde-406f-b19a-4c45aec40294</ae:uuid>
               <ae:uniqueName>CHANGE_REQUEST_MANAGEMENT</ae:uniqueName>
               <ae:tabName>Change Requests</ae:tabName>
            </ae:solution>
            <ae:homeReport xsi:type="ae:ReportIdentifier">
               <ae:displayName>Built-In: All Items I Submitted</ae:displayName>
               <ae:id>-11</ae:id>
               <ae:uuid>-11</ae:uuid>
            </ae:homeReport>
         </ae:solutionData>
      </ae:user>
   </ae:return>
</ae:GetUsersResponse>