Users¶

Fetch a single user¶

GET /user/[user_id]/

You can also get the current authenticated user with

GET /me/

This resource will give you some summarized information as unread_messages and pending_friend_requests.

Arguments

full: You can provide “full=1” to get also stats information about your users.

Example Response

{
  "date_joined": "2012-05-01T11:37:52.467275",
  "first_name": "Dustin",
  "id": 1,
  "last_name": "McQuay",
  "preferences": "/api/v1/preferences/1/",
  "profile": "/api/v1/profile/1/",
  "resource_uri": "/api/v1/user/1/",
  "profile_image_225_url": "...",
  "profile_image_48_url": "...",
  "pending_friend_requests": 0,
  "unread_messages": 0
}

Fetch multiple users¶

GET /user/

friends_with: Return only users who are friends with this user (user_id)

Response

A list of user objects which are formatted just like the Example Response for fetching a single user.

Search users by name¶

GET /user/search/

Arguments

q: The name to match against in the search

Response

TBD - Must include profile pic URL, name and location.

Search for friends¶

This method is similar to Search users by name, but it only searches for friends instead of all users.

GET /user/search/friends/

Arguments

q: The name to match against in the search

user_id: The user whom friends belongs to. [OPTIONAL]

order_by: You can order the results by ‘most_active’ users.[OPTIONAL]

The q argument is mandatory, and you have to include the name or part of the name to search for. The user_id is optional. If you don’t provide one, the logged in user will be used instead.

Update a user¶

PATCH /user/[user_id]/

Arguments - A partial user object, such as...

{
    "first_name": "John",
    "last_name": "Doe"
}

Response

202 if successful. No response body. You are only permitted to update data for the current logged in user. If you try to update another user, you’ll get a 401 UNAUTHORIZED response.

Change profile picture¶

This resource is exposed in order to change the profile picture of the current logged in user. [PRE PROCESSING NOTES]

POST /user/picture/

Arguments

The entire content of the request (i.e. the request body) must contain the content of the image that you want to upload. You just need to open the file, read the contents, and place them in the request body.

There are some headers you might need to send. Some are optionals, other are required.:

Content-MD5 (OPTIONAL): Is the result of aplying MD5 digest on the content you’re sending. Based on http://www.ietf.org/rfc/rfc1864.txt It’s important to note that this method is highly used in a wide variety of APIs, being a well known case Amazon S3. If you have doubt on how implement this, you can browse some opensource library for S3 and you can find a good example. Content-Type (REQUIRED): This is the content type of the picture you’re sending. Right now the only content types supported are: “image/jpeg” and “image/png”

Change password¶

To change the current logged in user’s password you need to:

POST /user/password/

Arguments:

old_password: The current user password.

new_password: The new password desired by the user.

The system checks that user’s current password matches the one provided by “old_password”. If that’s ok we change the password and return this response:

204 NO CONTENT

If the password provided by “old_password” doesn’t match we provide this response:

400 BAD REQUEST

{
  "error": {
    "code": "100",
    "message": "Email or password incorrect. The password specified doesn't match."
  }
}