Response [200 Ok]
| Uri | /api/v2/comment |
|---|---|
| UriDescription | Base URI for comment-related operations |
| EndpointType | CommentBase |
Uris
Comment
/api/v2/comment/:commentid
| Uri | /api/v2/comment/:commentid |
|---|---|
| UriDescription | Comment by ID |
| EndpointType | Comment |
| Locator | Comment |
| LocatorType | Object |
CommentLookupType
/api/v2/comment!lookuptype
| Uri | /api/v2/comment!lookuptype |
|---|---|
| UriDescription | Lookup comments by type |
| EndpointType | CommentLookupType |
| Locator | Comment |
| LocatorType | Objects |
Request
| Uri | /api/v2/comment |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/comment"
},
"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"
]
},
"Response": {
"Uri": "/api/v2/comment",
"Uris": {
"Comment": {
"Uri": "/api/v2/comment/:commentid",
"Locator": "Comment",
"LocatorType": "Object",
"UriDescription": "Comment by ID",
"EndpointType": "Comment"
},
"CommentLookupType": {
"Uri": "/api/v2/comment!lookuptype",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Lookup comments by type",
"EndpointType": "CommentLookupType"
}
},
"UriDescription": "Base URI for comment-related operations",
"EndpointType": "CommentBase",
"Timing": {
"Total": {
"time": 0.02111,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}