User Information

A single request can obtain almost all the information about the logged in user, including rights and preferences. Administrators can update this information using Syncd's web interface, but not via the API.

Request

GET /info/user.xml

Optional parameters

Use the following optional parameters to control which information is included in the response:

include=[all,
         rights,
         preferences]

For instance, the following request will get all available information about the user:

GET /info/user.xml?include=all

Response

 1 Status: 200 OK
 2 
 3 <user>
 4   <id type="integer">25</id>
 5   <name>walter</name>
 6   <first-name>Walter</first-name>
 7   <last-name>Smith</last-name>
 8   <active type="boolean">true</active>
 9   <code>WS</code>
10   <email>walter@thelazymouse.com</email>
11   <url>http://intranet/employees/ws</url>
12   <!-- if include=[all || rights] -->
13   <rights>
14     <admin type="boolean">true</admin>
15     <billing-contact type="boolean">true</billing-contact>
16     <user-group-manager type="boolean">true</user-group-manager>
17     <!-- manager-for-job-type-id references the top level job type
18             that this user can manage (all levels below this can 
19             also be managed) --> 
20     <manager-for-job-type-id type="integer">7</manager-for-job-type-id>
21     <activity-manager type="boolean">true</activity-manager>
22     <billing-rate-manager type="boolean">true</billing-rate-manager>
23     <expense-category-manager type="boolean">true</expense-category-manager>
24     <payment-method-manager type="boolean">true</payment-method-manager>
25     <view-billing-rates type="boolean">true</view-billing-rates>
26     <view-management-reports type="boolean">true</view-management-reports>
27   </rights>
28   <!-- end -->
29   <!-- if include=[all || preferences] -->
30   <preferences>
31     <!-- am-pm: true - 12 hour (am/pm) time notation
32                 false - 24 hour time notation -->
33     <am-pm type="boolean">true</am-pm>
34     <!-- first-day-of-week: 0 - Sunday
35                             1 - Monday
36                             2 - Tuesday
37                             3 - Wednesday
38                             4 - Thursday
39                             5 - Friday
40                             6 - Saturday -->
41     <first-day-of-week type="integer">1</first-day-of-week>
42     <!-- date-format: 0 - YYYY/MM/DD
43                       1 - YYYY-MM-DD
44                       2 - YYYY.MM.DD
45                       3 - DD/MM/YYYY
46                       4 - DD-MM-YYYY
47                       5 - DD.MM.YYYY
48                       6 - MM/DD/YYYY
49                       7 - MM-DD-YYYY
50                       8 - MM.DD.YYYY -->
51     <date-format type="integer">0</date-format>
52     <!-- duration-format: 0 - Hours . hundredths (e.g. 1.50 hrs)
53                           1 - Hours . tenths (e.g. 1.5 hrs)
54                           2 - Hours : minutes (e.g. 1:30 hrs) -->
55     <duration-format type="integer">2</duration-format>
56     <!-- numeric-format: 0 - 1,000.00
57                          1 - 1.000,00
58                          2 - 1 000.00
59                          3 - 1 000,00
60                          4 - 1000.00
61                          5 - 1000,00 -->
62     <numeric-format type="integer">0</numeric-format>
63   </preferences>
64   <!-- end -->
65 </user>

Continue to Users

Follow Syncd on Twitter Subscribe to the Syncd News