GET /api/businesses/{BusinessID}/reviewsettings

Returns information about the configurable settings for a review on the platform.

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/businesses/{BusinessID}/reviewsettings

Sample Request

The example below shows a request for the review settings for the specified business.

Sample Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/reviewsettings

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.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
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
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.

Response

If successful, this operation returns HTTP status code 200, with the review settings.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Wed, 14 May 2015 19:00:00 GMT

Sample response body: application/json

{
  "ReviewWorkflowDefKey" : "workflow:definition:review",
  "AutoPublish" : false
  "MarkdownSupport" : "com.soa.feature.enabled"
  "ExternalLinkSupport" : "com.soa.feature.disabled"
}

Response Headers

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

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

Response Body

Name	Type	Description
BusinessReviewSettings	BusinessReviewSettings	Contains information about default settings to apply to all reviews within the business.

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
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics