Get Comments on Screenshot Region¶

Path:	`api/json/reviewrequests/{review_request_id}/s/{screenshot_id}/comments/{width}x{height}+{x}+{y}/`

URL Parameters¶

Parameter	Type	Description
review_request_id	Integer	The ID of the review request.
screenshot_id	Integer	The ID of the screenshot.
width	Integer	The width of the region.
height	Integer	The height of the region.
x	Integer	The X location of the region.
y	Integer	The Y location of the region.

HTTP GET¶

Returns the list of comments on a region of a screenshot.

These may include draft comments made by the requesting user.

Example Request¶

GET /api/json/reviewrequests/12321/s/10/comments/20x20+5+5/

Responses¶

HTTP 200: Success¶

Field	Type	Description
comments	Array of ScreenshotComment	The list of comments.

Example Response¶

{
  stat: "ok",
  comments: [
    {
      id: 25,
      screenshot: {
        id: 10,
        caption: "",
        title: "Screenshot: test.png",
        image_url: "http://example.com/media/uploaded/images/2010/03/10/test.png",
        thumbnail_url: "http://example.com/media/uploaded/images/2010/03/10/test_400x100.png"
      },
      text: "This is a sample comment",
      timestamp: "2010-01-14 12:05:43",
      timesince: "6 days ago",
      public: 1,
      x: 5,
      y: 5,
      width: 20,
      height: 20,
      user: {
        username: "joe",
        first_name: "Joe",
        last_name: "User",
        url: "/users/joe/",
        email: "joe@example.com",
        fullname: "Joe User",
        id: 1
      }
    }
  ]
}

HTTP 401: Unauthorized¶

Error 103: Not Logged In¶

The client making the request is not logged in and the server disallows anonymous access.

See Authenticating for more information.

HTTP 404: Not Found¶

There are two possibilities for this error:

The review request with the given review_request_id does not exist on the server.
The screenshot_id is invalid or isn’t owned by the review request.