Syncd API Guide

A developers' guide to accessing Syncd programmatically.

Search API Guide

API Basics

Users and Groups

Jobs

Time Tracking

Expense Tracking

Billing Rates

User Group Memberships

Only User Group Managers can view, create and delete user group memberships.

Show

Request

GET /user-group-memberships/#{user-group-membership-id}.xml

Optional parameters

The following optional parameters can be used to include extra data:

include=[users,
         user_groups]

Response

 1 Status: 200 OK
 2 
 3 <user-group-membership>
 4   <id type="integer">#{user-group-membership-id}</id>
 5   <!-- if include=users -->
 6   <user>
 7     ...
 8   </user>
 9   <!-- else -->
10   <user-id type="integer">#{user-id}</user-id>
11   <!-- end -->
12   <!-- if include=user_groups -->
13   <user-group>
14     ...
15   </user-group>
16   <!-- else -->
17   <user-group-id type="integer">#{user-group-id}</user-group-id>
18   <!-- end -->
19   <!-- if include=timestamps -->
20   <created-at type="datetime">2008-01-08T03:47:52Z</created-at>
21   <updated-at type="datetime">2008-01-08T03:47:52Z</updated-at>
22   <!-- end -->
23 </user-group-membership>

List

Request

All user group memberships:

GET /user-group-memberships.xml

Memberships for a particular user:

GET /users/#{user-id}/user-group-memberships.xml

Memberships for a particular user group:

GET /user_groups/#{user-group-id}/user-group-memberships.xml

Optional parameters

Specify start and end to request a specific range of items. For example:

GET /user-group-memberships.xml?start=1&end=4

The following optional parameters can be used to include extra data:

include=[users,
         user_groups]

For example:

GET /user-group-memberships.xml?include=users,user_groups

Response

1 Status: 200 OK
2 
3 <user-group-memberships type="array">
4   <user-group-membership>
5     ...
6   </user-group-membership>
7   ...
8 </user-group-memberships>

Create

Request

POST /user-group-memberships.xml

Include the following data with your request:

1 <user-group-membership>
2   <user-id>#{user-id}</user-id>
3   <user-group-id>#{user-group-id}</user-group-id>
4 </user-group-membership>

Response

 1 Status: 201 Created
 2 
 3 <user-group-membership>
 4   <id type="integer">#{new-user-group-membership-id}</id>
 5   <user-id type="integer">25</user-id>
 6   <user-group-id type="integer">14</user-group-id>
 7   <!-- if include=timestamps -->
 8   <created-at type="datetime">2008-01-08T03:47:52Z</created-at>
 9   <updated-at type="datetime">2008-01-08T03:47:52Z</updated-at>
10   <!-- end -->
11 </user-group-membership>

Delete

Request

DELETE /user-group-memberships/#{user-group-membership-id}.xml

Response

Status: 200 OK

Continue to Job Types