GET user/get-by-email?email={email}&community_short_name={community_short_name}
Get the data a user by user email and the community short name
Request Information
Headers
HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.
Sample:HTTP_AUTHORIZATION: OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D", oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D", oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1462882011", oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
User email you want to get data |
string |
Required |
|
community_short_name |
Community short name you want to get data |
string |
Required |
Request Formats
application/x-www-form-urlencoded
email=johnvandervar@organization.com&community_short_name=developers
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
name |
Name |
string |
Optional |
last_name |
Last name or Family name |
string |
Optional |
|
string |
Optional |
|
password |
Password (Only for update, not for query) |
string |
Optional |
extra_data |
User extra data |
Collection of ExtraUserData |
Optional |
user_events |
User events |
Collection of UserEvent |
Optional |
aux_data |
Auxiliary data |
string |
Optional |
community_id |
Community identificator |
globally unique identifier |
Optional |
community_short_name |
Community short name |
string |
Optional |
user_short_name |
User short name |
string |
Optional |
user_id |
User identificator |
globally unique identifier |
Optional |
id_card |
User identification (passport number, dni...) |
string |
Optional |
born_date |
User born date |
date |
Optional |
country_id |
Country identificator |
globally unique identifier |
Optional |
country |
User country |
string |
Optional |
province_id |
Province identificator |
globally unique identifier |
Optional |
provice |
User province |
string |
Optional |
city |
User city |
string |
Optional |
address |
User address |
string |
Optional |
postal_code |
User postal code |
string |
Optional |
join_community_date |
Date when the member has joined to this community |
date |
Optional |
sex |
H for Male or M to Female |
string |
Optional |
preferences |
User preferences |
Collection of ThesaurusCategory |
Optional |
receive_newsletter |
True if this user must recive the community newsletter |
boolean |
Optional |
languaje |
User prefered language |
string |
Optional |
photo |
Photo of personal profile |
string |
Optional |
num_access |
Number of access user |
integer |
Optional |
last_login |
Date of last login |
date |
Optional |
Response Formats
application/json, text/json
{ "name": "John", "last_name": "Vander Var", "email": "johnvandervar@organization.com", "community_id": "1ede819e-9d0f-41e9-855b-bbebc7f08dd1", "community_short_name": "developers", "user_short_name": "john-vander-var", "user_id": "50b7615f-e32d-469d-ad93-d5829ab983ef", "born_date": "1985-02-01T00:00:00", "country_id": "98d604b4-3141-4499-bde1-c320f09ef45c", "country": "Spain", "province_id": "96f4fe28-a136-4423-ae60-36edd3261600", "city": "Madrid", "address": "456 Moreno Avenue", "join_community_date": "2016-06-12T00:00:00", "sex": "H", "receive_newsletter": false, "languaje": "es", "num_access": 0 }
Response HTTP status code
On success, the response contains 200 code.
On fail, throws a WebException with code:
- 401 Unauthorized if the OAuth signature is invalid
- 400 Bad Request if the params are invalid
- 500 Internal server error if something goes wrong...