Response [200 Ok]

Uri /api/v2/album/XRLFjG!comments?start=1&count=100
UriDescription Comments on album
EndpointType AlbumComments
Locator Comment
LocatorType Objects

Comment [1 of 1] - Ron Roussell
/api/v2/comment/7293660

Uri /api/v2/comment/7293660
UriDescription Comment by ID
Comment Monica, Your photos are excellent. You have achieved and shown in wonderful detail and sensitivity the sights associated with this trip. Can't want to book our sixth trip. I have find out where some of these photos were takes so we can experience the same. Any restaurant tips for Venice?
Date 2013-12-22T15:36:05+00:00
Name Ron Roussell
ProfileImageURL empty string
ProfileURL empty string
Rating 5
Status Approved

Pages

Count 1
FirstPage /api/v2/album/XRLFjG!comments?start=1&count=100
LastPage /api/v2/album/XRLFjG!comments?start=1&count=100
RequestedCount 100
Start 1
Total 1

Timing

Total

cycles 1
objects 0
time 0.04508

Config

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

Options

Path

  • /api
  • /v2
  • /album
  • /
  • !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/album/XRLFjG!comments?start=1&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": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "XRLFjG",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "comments"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!comments"
        }
    },
    "Response": {
        "Uri": "/api/v2/album/XRLFjG!comments?start=1&count=100",
        "Locator": "Comment",
        "LocatorType": "Objects",
        "Comment": [
            {
                "Comment": "Monica, Your photos are excellent. You have achieved and shown in wonderful detail and sensitivity the sights associated with this trip.  Can't want to book our sixth trip.  I have find out where some of these photos were takes so we can experience the same.  Any restaurant tips for Venice?",
                "Name": "Ron Roussell",
                "Rating": 5,
                "Status": "Approved",
                "Date": "2013-12-22T15:36:05+00:00",
                "ProfileURL": "",
                "ProfileImageURL": "",
                "Uri": "/api/v2/comment/7293660",
                "UriDescription": "Comment by ID"
            }
        ],
        "UriDescription": "Comments on album",
        "EndpointType": "AlbumComments",
        "Pages": {
            "Total": 1,
            "Start": 1,
            "Count": 1,
            "RequestedCount": 100,
            "FirstPage": "/api/v2/album/XRLFjG!comments?start=1&count=100",
            "LastPage": "/api/v2/album/XRLFjG!comments?start=1&count=100"
        },
        "Timing": {
            "Total": {
                "time": 0.04508,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}