GET /api/reviews/{ReviewID}

Returns the specified review.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/reviews/{ReviewID}

Back to top

Sample Request

The example below shows a request for the specified review.

Request URL

https://{hostname}/api/reviews/review10833.acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
ReviewID Path string Required The unique ID for a specific review.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the review in JSON format.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 13 May 2015 20:04:54 GMT

Sample response body

{
  "ReviewID" : "review10833.acmepaymentscorp",
  "ReviewSubjectID" : "ArmSuVQl2Qz4fgqkW7Oyrb8o.acmepaymentscorp",
  "Topic" : "Great learning tool",
  "Content" : "Wow, this is great. So much fun. My son played for **two hours straight** and I know it's helping him with his spelling.",
  "UserID" : "c11635de-8403-4567-a26d-8824517bdde1.acmepaymentscorp",
  "UserName" : "adminacmepaymentscorp",
  "Created" : "2015-05-14T00:54:34Z",
  "Comments" : 0,
  "Marks" : 0,
  "Visibility" : "Public",
  "Published" : true,
  "DescriptionMediaType" : "text/markdown",
  "BoardItemArtifacts" : {
    "BoardItemArtifact" : [ ]
  }
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Back to top

Response Body

Name Type Description
review Review Includes information about a review in the Akana API Platform.

Back to top

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. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics