Comment on Post

Method: deleted list

Authorization is required. Deleted post comments can be undeleted until they are purged.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/list/{groupId}/deleted?offset={offset}&pageSize={pageSize}

Parameters

propertyvaluedescription
groupId guid The bookmarks group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Dolore deserunt fugiat duis sunt elit mollit anim aute ut id irure veniam ut.",
  "timestamp": "2014-03-03T23:20:23Z",
  "object": {
    "offset": 0,
    "comments": [
      {
        "id": 1,
        "type": "comment",
        "createdOn": "2014-03-03T23:20:23Z",
        "author": {
          "id": "23724cbb-52ae-4d0c-bade-d0ec9ff23a76",
          "alias": "cillum sunt",
          "extendedAlias": "consequat irure fugiat ex non",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "deletedOn": "2014-03-03T23:20:23Z",
        "deletedBy": {
          "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
          "alias": "proident est",
          "extendedAlias": "Lorem eiusmod sint aliquip do",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "approvedOn": "2014-03-03T23:20:23Z",
        "isApproved": true,
        "post": {
          "id": "b639563b-d3bc-4bc9-94fc-6414977daae3",
          "title": "Non ex excepteur aliquip deserunt aliquip velit ut.",
          "slug": "Home",
          "url": "/Home/posts/123"
        },
        "content": "Tempor excepteur veniam non nostrud veniam cillum cupidatat excepteur do commodo adipisicing ipsum.",
        "url": "/Home/posts/123#234",
        "rating": 2,
        "isAnonymous": true,
        "parentCommentId": 0,
        "spamReports": 0,
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: delete

Authorization is required. Deleted post comments can be undeleted until they are purged.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/{commentId}

Parameters

propertyvaluedescription
commentId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Ut non aliqua ullamco qui ex excepteur ipsum deserunt proident duis.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "id": 1,
    "type": "comment",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "approvedOn": "2014-03-03T23:20:23Z",
    "isApproved": false,
    "post": {
      "id": "30985b49-bbf6-4cfc-8dde-28ae37f35ea7",
      "title": "Lorem mollit aute ea sit quis eu.",
      "slug": "Home",
      "url": "/Home/posts/123"
    },
    "content": "Adipisicing eiusmod ex mollit sint voluptate sunt nulla enim culpa minim veniam et.",
    "url": "/Home/posts/123#234",
    "rating": 4,
    "votes": 2,
    "isAnonymous": false,
    "parentCommentId": 0,
    "spamReports": 6,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted

Method: undelete

Authorization is required. Deleted post comments can be undeleted until they are purged.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/{commentId}/undelete

Parameters

propertyvaluedescription
commentId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Ut non aliqua ullamco qui ex excepteur ipsum deserunt proident duis.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "id": 1,
    "type": "comment",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "approvedOn": "2014-03-03T23:20:23Z",
    "isApproved": false,
    "post": {
      "id": "30985b49-bbf6-4cfc-8dde-28ae37f35ea7",
      "title": "Lorem mollit aute ea sit quis eu.",
      "slug": "Home",
      "url": "/Home/posts/123"
    },
    "content": "Adipisicing eiusmod ex mollit sint voluptate sunt nulla enim culpa minim veniam et.",
    "url": "/Home/posts/123#234",
    "rating": 4,
    "votes": 2,
    "isAnonymous": false,
    "parentCommentId": 0,
    "spamReports": 6,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
object object The undeleted object

Method: purge

Authorization is required. Deleted post comments can be undeleted until they are purged. With this method you can purge comment by comment. It is not enforcing the rule of having the comment deleted for more than 1 month.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/{commentId}/purge

Parameters

propertyvaluedescription
commentId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Ut non aliqua ullamco qui ex excepteur ipsum deserunt proident duis.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "id": 1,
    "type": "comment",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "approvedOn": "2014-03-03T23:20:23Z",
    "isApproved": false,
    "post": {
      "id": "30985b49-bbf6-4cfc-8dde-28ae37f35ea7",
      "title": "Lorem mollit aute ea sit quis eu.",
      "slug": "Home",
      "url": "/Home/posts/123"
    },
    "content": "Adipisicing eiusmod ex mollit sint voluptate sunt nulla enim culpa minim veniam et.",
    "url": "/Home/posts/123#234",
    "rating": 4,
    "votes": 2,
    "isAnonymous": false,
    "parentCommentId": 0,
    "spamReports": 6,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
object object The purged object

Method: purge all

Authorization is required. Deleted post comments can be undeleted until they are purged. With this method you will purge all deleted comment, except the ones that are deleted in the last 1 month.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/purge-deleted/group/{groupId}

Parameters

propertyvaluedescription
groupId guid In which group to purge all eligible deleted comments

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

  "object": {
    "type": "result",
    "count": 234,
    "accessWarnings": []
  }

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

countintegerHow many comments were purged.

propertyvaluedescription

Method: unapproved list

Authorization is required. Based on permission settings, comments posted by certain user roles, may require approval before become public. This method will return all unapproved ones

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/list/{groupId}/unapproved?offset={offset}&pageSize={pageSize}

Parameters

propertyvaluedescription
groupId guid The bookmarks group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Dolore deserunt fugiat duis sunt elit mollit anim aute ut id irure veniam ut.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "comments": [
      {
        "id": 1,
        "type": "comment",
        "createdOn": "2014-03-03T23:20:23Z",
        "author": {
          "id": "23724cbb-52ae-4d0c-bade-d0ec9ff23a76",
          "alias": "cillum sunt",
          "extendedAlias": "consequat irure fugiat ex non",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "approvedOn": "2014-03-03T23:20:23Z",
        "isApproved": true,
        "post": {
          "id": "b639563b-d3bc-4bc9-94fc-6414977daae3",
          "title": "Non ex excepteur aliquip deserunt aliquip velit ut.",
          "slug": "Home",
          "url": "/Home/posts/123"
        },
        "content": "Tempor excepteur veniam non nostrud veniam cillum cupidatat excepteur do commodo adipisicing ipsum. Voluptate duis aliqua minim mollit eiusmod et irure elit excepteur et qui. ",
        "url": "/Home/posts/123#234",
        "rating": 2,
        "votes": 2,
        "isAnonymous": true,
        "parentCommentId": 0,
        "spamReports": 0,
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: approve

Authorization is required. Based on permission settings, comments posted by certain user roles, may require approval before become public. This method will approve such unapproved ones.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/{commentId}/approve

Parameters

propertyvaluedescription
commentId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Ut non aliqua ullamco qui ex excepteur ipsum deserunt proident duis.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "id": 1,
    "type": "comment",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "approvedOn": "2014-03-03T23:20:23Z",
    "isApproved": true,
    "post": {
      "id": "30985b49-bbf6-4cfc-8dde-28ae37f35ea7",
      "title": "Lorem mollit aute ea sit quis eu.",
      "slug": "Home",
      "url": "/Home/posts/123"
    },
    "content": "Adipisicing eiusmod ex mollit sint voluptate sunt nulla enim culpa minim veniam et.",
    "url": "/Home/posts/123#234",
    "rating": 4,
    "votes": 2,
    "isAnonymous": false,
    "parentCommentId": 0,
    "spamReports": 6,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
object object The approved object

Method: delete unapproved

Authorization is required. Deleted all unapproved comments. You can later undelete or purge them.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/list/{groupId}/unapproved

Parameters

propertyvaluedescription
groupId guid Unapproved comments of which group to delete.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [],
  "object": {
    "type": "result",
    "count": 234,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
count integer How many comments were deleted.

Method: Spam reports list

Authorization is required. Regular users can report comments as spam. This method will return all comments with such reports.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/list/{groupId}/spam-reports?offset={offset}&pageSize={pageSize}

Parameters

propertyvaluedescription
groupId guid The bookmarks group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Sint nisi nostrud qui aliquip ipsum culpa quis ipsum nostrud deserunt Lorem.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "comments": [
      {
        "id": 1,
        "type": "commentSpamReport",
        "createdOn": "2014-03-03T23:20:23Z",
        "author": {
          "id": "48be3765-c8c9-4bff-9e16-e3f8c6fac671",
          "alias": "est qui",
          "extendedAlias": "elit enim sunt Lorem aute",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "approvedOn": "2014-03-03T23:20:23Z",
        "isApproved": false,
        "post": {
          "id": "010db12e-7ae0-45f9-84a1-1b45e3b9a6ae",
          "title": "Occaecat qui consequat sint ut dolore nisi.",
          "slug": "Home",
          "url": "/Home/posts/123"
        },
        "content": "Voluptate ut enim elit officia ullamco voluptate cillum ullamco elit adipisicing excepteur irure proident.",
        "url": "/Home/posts/123#1",
        "reports": [
          {
            "createdOn": "2014-03-03T23:20:23Z",
            "author": {
              "id": "6118fd04-1143-4bed-bfa1-04ca88704ea9",
              "alias": "exercitation aliquip",
              "extendedAlias": "proident ad ipsum amet est",
              "slug": "Home",
              "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
              "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
            }
          },
          {
            "createdOn": "2014-03-03T23:20:23Z",
            "author": {
              "id": "901cca15-c78e-4786-9d37-99e5fa9b2d40",
              "alias": "ad elit",
              "extendedAlias": "deserunt magna id occaecat laborum",
              "slug": "Home",
              "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
              "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
            }
          },
          {
            "createdOn": "2014-03-03T23:20:23Z",
            "author": {
              "id": "c01c7504-8517-486a-a843-244ce2f25dbd",
              "alias": "sunt sunt",
              "extendedAlias": "occaecat proident ad aute aute",
              "slug": "Home",
              "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
              "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
            }
          },
          {
            "createdOn": "2014-03-03T23:20:23Z",
            "author": {
              "id": "6646c923-27e1-4cc4-aaad-bd1145d3effc",
              "alias": "officia commodo",
              "extendedAlias": "et ad ex incididunt excepteur",
              "slug": "Home",
              "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
              "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
            }
          },
          {
            "createdOn": "2014-03-03T23:20:23Z",
            "author": {
              "id": "65f14e32-0919-48b1-81f4-1652c73ca49a",
              "alias": "cillum culpa",
              "extendedAlias": "aliquip enim ex occaecat adipisicing",
              "slug": "Home",
              "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
              "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
            }
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: Spam reports delete

Authorization is required. This method will delete all spam reports for a selected post comment.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/comment/post/{commentId}/spam-reports

Parameters

propertyvaluedescription
commentId integer In id of the comment which spam reports you want to delete

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [ ],
  "object": {
    "id": 1,
    "type": "commentSpamReport",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "48be3765-c8c9-4bff-9e16-e3f8c6fac671",
      "alias": "est qui",
      "extendedAlias": "elit enim sunt Lorem aute",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "approvedOn": "2014-03-03T23:20:23Z",
    "isApproved": false,
    "post": {
      "id": "010db12e-7ae0-45f9-84a1-1b45e3b9a6ae",
      "title": "Occaecat qui consequat sint ut dolore nisi.",
      "slug": "Home",
      "url": "/Home/posts/123"
    },
    "content": "Voluptate ut enim elit officia ullamco voluptate cillum ullamco elit adipisicing excepteur irure proident. ",
    "url": "/Home/posts/123#1",
    "reports": [],
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.