Planzone Web Kit
Connexion
Pages les plus lues
3498
3347
3288
Pages les plus récentes
27/10/10
27/10/10
27/10/10
27/10/10
27/10/10
users
Cette page a été publiée 27/10/10 par Stephane Carrez.
Description
This operation lists the users that the application can access. Filters allow to return:
- Users which have a given status (online, offline, active, invited, inactive)
- Users which are member of a given Planzone
- Users which are member of a given project
URI
GET lists the users
http://ws.planzone.com/v1/rest/users
Formats
xml, jsonRequires Authentication (about authentication):
yesRequires Authorization (about authorization):
The application must have the 'read' permission granted from the Planzone.
API rate limited (about rate limiting):
trueParameters
| Name | Optional | Description |
|---|---|---|
| planzone | YES | List the users which belong to a specific Planzone. The parameter defines a list of planzone GUID separated by a comma (,). The default is to list the users from any Planzone that the user can access. |
| project | YES | List the users which are team member of a specific project. The parameter defines a list of project GUID separated by a comma (,). |
| status | YES | Filters the user on their status. Valid values are: active, invited, inactive, all. The default is active. |
The project parameter is mandatory (this restriction will be suppressed in the future)
Request Example
The following request:
GET /v1/rest/users?status=active
lists the users which are active.
Response
The response contains a user XML element which describes the user.
<users>
<user id="ALC23" status="active">
<first_name>John</first_name>
<last_name>Smith</last_name>
<email>js@gmail.com</email>
<phone>01 02 03 04 05 06</phone>
<company>Private Store and Markets</company>
<country>FRA</country>
<title>Director Sales EMEA</title>
<name>John Smith</name>
</user>
<user id="BL23" status="inactive" invited="true">
<email>jj@gmail.com</email>
<name>John</name>
</user>
</users>
HTTP Status Codes
| 200 | OK | Operation succeeded |
See also
planzones
user
user/picture
user XML element