GET /api/reviews

Returns a list of all reviews.

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

URL

https://{hostname}/api/reviews[?ReviewSubjectID={ReviewSubjectID}]
[&RetrievingUserID={RetrievingUserID}][&ItemID={ItemID}]
[&ReviewAuthorID=ReviewAuthorID][&SortBy=SortBy][&IncludeComments=IncludeComments]
[&NumberOfComments=NumberOfComments][&start=start][&count=count]

Sample Request

Request URL #1

Returns all reviews.

https://{hostname}/api/reviews

Request URL #2

Returns all reviews written by the specified user.

https://{hostname}/api/reviews?ReviewAuthorID=d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Request Parameters

Response

If successful, this operation returns HTTP status code 200, with information about the reviews. The response is in the form of an RSS feed in JSON or XML format.

Sample Response

The sample response below shows successful completion of Request #2. The response includes all reviews written by the specified user (2 reviews).

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 05 Jun 2013 16:10:24 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "",
    "link" : "../acmepaymentscorp#/forum/reviews",
    "description" : "",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Fun game!",
      "link" : "../acmepaymentscorp#/forum/review/review24109.acmepaymentscorp/details",
      "description" : "This is a really fun game. I recommend it.",
      "category" : [ {
        "value" : "REVIEW",
        "domain" : "uddi:soa.com:resourcetype"
      } ],
      "guid" : {
        "value" : "review24109.acmepaymentscorp"
      },
      "pubDate" : "2013-06-05T16:42:07.000Z",
      "AuthoringUser" : {
        "ID" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
        "Name" : "JenniferMeadows",
        "Image" : {
          "Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png",
          "Title" : "JenniferMeadows",
          "Link" : "#/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png",
        "Link" : "../acmepaymentscorp#/user/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-06-05T16:42:07.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    }, {
      "title" : "Great learning tool",
      "link" : "../acmepaymentscorp#/forum/review/review24085.acmepaymentscorp/details",
      "description" : "Wow, this is great. So much fun. My son played for two hours straight and I know it's helping him with his spelling.",
      "category" : [ {
        "value" : "REVIEW",
        "domain" : "uddi:soa.com:resourcetype"
      } ],
      "guid" : {
        "value" : "review24085.acmepaymentscorp"
      },
      "pubDate" : "2013-06-04T22:51:14.000Z",
      "AuthoringUser" : {
        "ID" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
        "Name" : "JenniferMeadows",
        "Image" : {
          "Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png",
          "Title" : "JenniferMeadows",
          "Link" : "#/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png",
        "Link" : "../acmepaymentscorp#/user/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-06-04T22:51:14.000Z",
      "Marks" : {
        "Count" : 3,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "Learning Puzzles",
        "Guid" : "app24056.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "1.0",
        "Guid" : "gbGPCs7Uvz4VV8D0Zuvzdq6C.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Response Headers

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

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The Title field is empty, the Link field has a link to the reviews board on the platform, and the Description field is empty. The channel includes paging values: StartIndex and ItemsPerPage. Each item in the channel represents a review, and includes the information listed below.

"value" : "REVIEW",
"domain" : "uddi:soa.com:resourcetype"

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.

More information about Akana API Platform API error messages.

Related Topics