GET /api/dropbox/pictures/{pictureId}

Returns a picture that was uploaded to the Dropbox for a resource.

Authorization Roles/Permissions: This operation applies to all users.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/dropbox/pictures/{pictureId}

Back to top

Sample Request

The example below shows a request for a specific avatar.

Request URL

https://{hostname}/api/dropbox/pictures/1542

Sample request headers

GET /api/dropbox/pictures/1542?size=512 HTTP/1.1
Host: {hostname}
Accept: image/png,image/*;q=0.8,*/*;q=0.5
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept image/jpeg

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
PictureID Path long Required The Dropbox ID for the picture.
size Query integer Required The size, in pixels, for the width or height of the avatar image (the image should always be square). We recommend a size of 75 pixels.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the requested image.

Back to top

Sample Response

The sample response below shows successful completing of the request.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 21 Jun 2013 18:39:04 GMT
Content-Type: image/jpeg

Sample response body

The response body is the image.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type image/jpeg

Back to top

Response Body

Name Type Description
Response image The avatar associated with the resource; generally a JPG file

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics