POST /api/reviews
Adds a review of a resource.
Note: If you are using markdown, and will be incorporating one or more artifacts in your review, you must upload the artifacts first. Run the POST /api/boards/items/artifacts operation to upload the first artifact and the POST /api/boards/items/{BoardItemID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the review.
Authorization Roles/Permissions: Must be logged in.
This topic includes the following sections:
HTTP Method
POST
URL
https://{hostname}/api/reviews
Sample Request
The example below adds a review of an app.
Sample Request URL
https://{hostname}/api/reviews
Sample request headers
POST /api/reviews HTTP/1.1 Host: {hostname} Accept: application/json, text/javascript, */*; q=0.01 Content-Type: application/json; charset=UTF-8 X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
{ "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":"2e8ad84c-0410-44d1-87ee-b39eaba04519.acmepaymentscorp", "DescriptionMediaType":"text/markdown", "BoardItemArtifacts":{ "BoardItemArtifact":[ ] } }
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 |
Content-Type |
Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json |
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 |
---|---|---|---|---|
review | Body | Review | Required | Includes information about a review in the Akana API Platform. The ReviewSubjectID, Topic, Content, and UserID values are required in the request. |
Response
If successful, this operation returns HTTP status code 200, with the modified review object including ReviewID.
Sample Response
The sample response below shows the full review object returned, including the ReviewID.
Sample response headers
HTTP/1.1 200 OK Content-Type: application/json Date: Wed, 13 May 2015 19:54:34 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", "Created" : "2015-05-14T00:54:34.075Z", "PubDate" : "2015-05-14T00:54:34.075Z", "DescriptionMediaType" : "text/markdown", "BoardItemArtifacts" : { "BoardItemArtifact" : [ ] } }
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 |
Response Body
Name | Type | Description |
---|---|---|
review | Review | Includes information about a review in the Akana API Platform. The response object includes the ReviewID assigned by the platform. |
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.