Web Services Developer's Guide → Web Services API Reference → SBM Application Web Services → Responses → UserInfo
The UserInfo type holds the name and other information about a user in SBM. The UserInfo type parameters are listed below.
Name | Type | Description |
---|---|---|
id | UserIdentifier | The login ID of the user. |
accessType | AccessType | Shows the user's product-access type. |
string | The user's primary email address. | |
emailCC | string | The user's CC email addresses. |
timezone | string | The user's time zone. |
offsetFromGMT | integer | This is the time zone's raw GMT offset. |
dstSavings | integer | The amount of time in milliseconds to be added to local standard time to get local wall clock time. |
datePreference | DatePreference | The user's date preference. |
timePreference | TimePreference | The user's time preference. |
namespaceName | string | The user's namespace name. |
phoneNumber | string | The user's phone number. |
locale | string | The user's designated locale. |
isDeleted | boolean | Indicates whether the user is marked as deleted or not. |
contact | ContactIdentifier | Holds identification information for the user's associated contact record. |
maxNotes | integer | Indicates the maximum number of notes to display on an item. |
maxChangeHistory | integer | Indicates the maximum number of change history records to display on an item. |
maxItemsPerPage | integer | Indicates the maximum number of items to display per page in search and report results. |
fieldsMask | integer | Bit mask that indicates which field sections the user would like displayed as described in the TS_USERS table in the Database Schema Reference Guide. |
notesMask | integer | Bit mask that indicates the user's preference for displaying notes as described in the TS_USERS table in the Database Schema Reference Guide. |
changeHistoryMask | integer | Bit mask that indicates the user's preference for displaying change history information as described in the TS_USERS table in the Database Schema Reference Guide. |
browserMask | integer | Bit mask that indicates the user's browser preferences as described in the TS_USERS table in the Database Schema Reference Guide. |
group | GroupIdentifier | Holds the identification information for groups to which the user belongs. One or more GroupIdentifiers are returned for each group. |
preferredSolution | SolutionIdentifier | Holds the identification information for the user's preferred application. This setting determines which application tab is selected by default when the user first enters the SBM User Workspace. |
solutionData | UserSolutionData | Contains the ordered-list of application tabs that appear for the user in the SBM User Workspace. The application identification information, home page report, and user's preferred projects are returned for each application. |
The UserInfo type provides a user account in SBM. Use GetUsers to retrieve a list of attributes for a specified user.
The timezone parameter is a programmatic ID; for example, "America/Los_Angeles". This ID is used to call up a specific real-world time zone. It corresponds to the IDs defined in the standard Olson data used by UNIX systems, and has the format continent/city or ocean/city.
The offsetFromGMT parameter is the time zone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking Daylight Saving Time into account). If DST is in effect for a given date, use the dstSavings value to adjust this offset.
The dstSavings parameter is the amount of time in milliseconds to be added to local standard time to get local wall clock time. If Daylight Saving Time is not observed in this user's timezone, this value will be 0. This value should be used only to adjust a date/time that is within the DST observation period.
The namespaceName parameter returns the name of the namespace that was generated while provisioning the customer environment. If the user does not belong to a namespace, then the default namespace name ("00000") is returned.
The following XML snippet shows the UserInfo type in the return element of the GetUsers response.
<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>
Copyright © 2007–2016 Serena Software, Inc. All rights reserved.