DELETE /api/reviews/{ReviewID}/marks/{UserID}
Removes the specified user's mark from a review that the user has previously marked.
Authorization Roles/Permissions: Must be logged in.
This topic includes the following sections:
HTTP Method
DELETE
URL
https://{hostname}/api/reviews/{ReviewID}/marks/{UserID}
Sample Request
The example below shows a request to delete the specified user's mark from the specified review.
Sample Request URL
https://{hostname}/api/reviews/review10491.acmepaymentscorp/marks/3b0b496a-ccf9-46f5-9919-0d1b77f7348f.acmepaymentscorp
Sample request headers
DELETE /api/reviews/review10491.acmepaymentscorp/marks/3b0b496a-ccf9-46f5-9919-0d1b77f7348f.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
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
Header | Description |
---|---|
Accept | text/plain, application/vnd.soa.v71+json, application/vnd.soa.v72+json |
Content-Type | */* |
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 |
---|---|---|---|---|
ReviewID | Path | string | Required | The unique ID for a specific review. |
UserID | Body | string | Required | The unique ID for a specific user. |
Response
If successful, this operation returns HTTP status code 200, and the user's mark is removed from the review.
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: Thu, 08 May 2014 00:29:00 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, application/vnd.soa.v71+json, application/vnd.soa.v72+json |
Response Body
Name | Type | Description |
---|---|---|
Response | string | The new count of marks on the specified review, after the unmarking operation is complete. |
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. |
405 | Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb. |
500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.