Response [200 Ok]

Uri /api/v2/image/QDpXwH2-1!comments?start=-99&count=100
UriDescription Comments on image
EndpointType ImageComments
Locator Comment
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.03827

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /image
  • /
  • !comments

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

Parameters

POST

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/QDpXwH2-1!comments?start=-99&count=100"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Add"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST"
        ],
        "ParameterDescription": {
            "Text": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Email": "Email address of the form RECIPIENT@DOMAIN",
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Comment",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Text",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 60000
                },
                {
                    "Name": "Name",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 50
                },
                {
                    "Name": "Email",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Email",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 50
                },
                {
                    "Name": "Link",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SocialID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "ServiceID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "Rating",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 5
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "QDpXwH2-1",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "comments"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/QDpXwH2-1!comments?start=-99&count=100",
        "Locator": "Comment",
        "LocatorType": "Objects",
        "UriDescription": "Comments on image",
        "EndpointType": "ImageComments",
        "Pages": {
            "Total": 0,
            "Start": 1,
            "Count": 0,
            "RequestedCount": 100,
            "FirstPage": "/api/v2/image/QDpXwH2-1!comments?start=1&count=100",
            "LastPage": "/api/v2/image/QDpXwH2-1!comments?start=-99&count=100"
        },
        "Timing": {
            "Total": {
                "time": 0.03827,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}