DELETE /api/discussions/{DiscussionID}/comments/{CommentID}/marks/{UserID}
Removes the specified user's mark from a comment that the user has previously marked.
Authorization Roles/Permissions: Must be logged in. Registered site user.
This topic includes the following sections:
HTTP Method
DELETE
URL
https://{hostname}/api/discussions/{DiscussionID}/comments/{commentID}/marks/{UserID}
Sample Request
The example below shows a request to remove a mark from the specified discussion comment.
Sample Request URL
https://{hostname}/api/discussions/contract_request23623.acmepaymentscorp/comments/comment25802.acmepaymentscorp/marks/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp
Sample request headers
DELETE /api/discussions/contract_request23623.acmepaymentscorp/comments/comment25802.acmepaymentscorp/marks/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
None.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*. |
| Content-Type | Any format (*/*) |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| DiscussionID | Path | string | Required | The unique ID for a specific discussion. |
| CommentID | Path | string | Required | The unique ID for a specific comment. |
| UserID | Path | string | Required |
The unique ID for a specific user. It is the ID of the user unmarking the comment. |
Response
If successful, this operation returns HTTP status code 200, with the updated count of the number of marks on the specified comment.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers
HTTP/1.1 200 OK Content-Type: text/plain Date: Tue, 23 Jul 2013 14:30:29 GMT
Sample response body
2
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | text/plain |
Response Body
| Name | Type | Description |
|---|---|---|
| Response | string | The updated count of the number of marks on the specified comment, after the user's mark has been removed. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.