Syncd API
Users
All users can view their own data through the User Information interface. Only Administrators, Job Managers and Activity Managers can view data about other users, and only Administrators can view other users' rights.
Administrators can update this information using Syncd's web interface, but not via the API.
Show
Request
GET /users/#{user-id}.xml
Optional parameters
Administrators can specify include=rights
to include user rights. For example:
GET /users/#{user-id}.xml?include=rights
Response
Status: 200 OK <user> <id type="integer">26</id> <name>Natasha</name> <first-name>Natasha</first-name> <last-name>Lenin</last-name> <active type="boolean">true</active> <code>nl</code> <email>natasha@artworksisnotarealcompany.com</email> <url/> <!-- if include=timestamps --> <created-at type="datetime">2007-03-30T20:49:05Z</created-at> <updated-at type="datetime">2010-03-11T08:09:23Z</updated-at> <!-- end --> <!-- if include=rights --> <rights> <admin type="boolean">false</admin> <billing-contact type="boolean">false</billing-contact> <user-group-manager type="boolean">false</user-group-manager> <manager-for-job-type-id type="integer" nil="true"/> <activity-manager type="boolean">false</activity-manager> <billing-rate-manager type="boolean">true</billing-rate-manager> <expense-category-manager type="boolean">true</expense-category-manager> <payment-method-manager type="boolean">true</payment-method-manager> <view-billing-rates type="boolean">true</view-billing-rates> <view-management-reports type="boolean">false</view-management-reports> <!-- if include=timestamps --> <updated-at type="datetime">2007-12-20T06:55:23Z</updated-at> <!-- end --> </rights> <!-- end --> </user>
List
Request
All users:
GET /users.xml
All active users:
GET /users/active.xml
All inactive users:
GET /users/inactive.xml
Optional parameters
Specify start
and end
to request a specific range of items. Specify include=rights
to include user rights. For example:
GET /users.xml?start=1&end=2&include=rights,timestamps
Response
Status: 200 OK <users type="array"> <user> ... </user> ... </users>