user/picture

Description

This operation retreives the large or small user picture of a given user. The user guid must be obtained either from the user list returned by the users operation or by another operation which returns a user (such as the todos).


URI

GET the user picture
http://ws.planzone.com/v1/rest/user/guid/picture

Formats

xml, json

Requires Authentication (about authentication):

yes

Requires Authorization (about authorization):

The application must have the 'read' permission granted from the Planzone.

API rate limited (about rate limiting):

true

Parameters

NameOptionalDescription
typeYESWhich image to retrieve. The possible values are small and large. The default value is small.

Request Example

The following request:

GET /v1/rest/user/ALrqAQ/picture?type=large

returns the picture image.

Response

The response content type is a image/jpg and the image binary data is contained in the body. The response also contains the following headers:

HeaderDescription
Image-IdAn image unique identifier
Image-WidthThe image width
Image-HeightThe image height

HTTP Status Codes

200 OK Operation succeeded

See also

users