GET /api/businesses/{BusinessID}/settings

Returns information about the configurable settings for a business on the platform. The optional parameters determine which settings are returned; without those, the operation returns an empty results set.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/businesses/{BusinessID}/settings[?][IncludeBusinessAPISettings=boolean]
[&IncludeBusinessAppSettings=boolean][&IncludeBusinessGroupSettings=boolean]
[&IncludeTicketSettings=boolean][&IncludeConnectionSettings=boolean][&IncludeSecuritySettings=boolean]
[&IncludeUserSettings=boolean][&IncludeDiscussionSettings=boolean]
[&IncludeReviewSettings=boolean][&IncludeAlertSettings=boolean][&IncludeCommentSettings=boolean]
[&IncludeBusinessSettings=boolean]

Sample Request

The example below shows a request for the settings for the specified business. In this example, all optional parameters were included.

Sample Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/settings?IncludeBusinessAPISettings=true
&IncludeBusinessAppSettings=true&IncludeBusinessGroupSettings=true&IncludeTicketSettings=true
&IncludeConnectionSettings=true&IncludeSecuritySettings=true&IncludeUserSettings=true
&IncludeDiscussionSettings=true&IncludeReviewSettings=true&IncludeAlertSettings=true
&IncludeCommentSettings=true&IncludeCommentSettings=true&IncludeBusinessSettings=true

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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.
IncludeBusinessAPISettings	Query	string	Optional*	If set to true, the business's API settings are included in the results.
IncludeBusinessAppSettings	Query	string	Optional*	If set to true, the business's app settings are included in the results.
IncludeBusinessGroupSettings	Query	string	Optional*	If set to true, the business's group settings are included in the results.
IncludeTicketSettings	Query	string	Optional*	If set to true, the business's ticket settings are included in the results.
IncludeConnectionSettings	Query	string	Optional*	If set to true, the business's connection settings are included in the results.
IncludeSecuritySettings	Query	string	Optional*	If set to true, the business's security settings are included in the results.
IncludeUserSettings	Query	string	Optional*	If set to true, the business's user settings are included in the results.
IncludeDiscussionSettings	Query	string	Optional*	If set to true, the business's discussion settings are included in the results.
IncludeReviewSettings	Query	string	Optional*	If set to true, the business's review settings are included in the results.
IncludeAlertSettings	Query	string	Optional*	If set to true, the business's alert settings are included in the results.
IncludeCommentSettings	Query	string	Optional*	If set to true, the business's comment settings are included in the results.
IncludeBusinessSettings	Query	string	Optional*	If set to true, general settings for the business are included in the results.
IncludeBusinessCategories	Query	Boolean	Optional*	If set to true, model object categories for the business are included in the results.

*Note: If no query parameters are included, no results are returned.

Response

If successful, this operation returns HTTP status code 200, with information about the requested business settings.

Sample Response

The sample response below shows successful completion of this operation. In the first (application/json) example, all optional parameters were included, as shown in the sample request above. In the second (application/xml) example, only the app settings were included.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 21 Jun 2018 23:56:16 GMT

Sample response body

{
  "BusinessAPISettings":{
    "PublicAPISupport":"com.soa.feature.enabled",
    "PublicAPISandboxEndpointSupport":"com.soa.feature.enabled",
    "PublicAPIProductionEndpointSupport":"com.soa.feature.enabled",
    "PublicAPISandboxAutoApprovalSupport":"com.soa.feature.enabled",
    "PublicAPIProductionAutoApprovalSupport":"com.soa.feature.enabled",
    "PublicAPIBoardSupport":"com.soa.feature.enabled",
    "PublicAPIRatingsSupport":"com.soa.feature.enabled",
    "PublicAPIReviewsSupport":"com.soa.feature.enabled",
    "PrivateAPISupport":"com.soa.feature.enabled",
    "PrivateAPISandboxEndpointSupport":"com.soa.feature.enabled",
    "PrivateAPIProductionEndpointSupport":"com.soa.feature.enabled",
    "PrivateAPISandboxAutoApprovalSupport":"com.soa.feature.enabled",
    "PrivateAPIProductionAutoApprovalSupport":"com.soa.feature.enabled",
    "PrivateAPIGroupTypeSupport":"com.soa.feature.disabled",
    "PrivateAPIIndependentGroupSupport":"com.soa.feature.enabled",
    "PrivateAPIBoardSupport":"com.soa.feature.enabled",
    "PrivateAPIRatingsSupport":"com.soa.feature.enabled",
    "PrivateAPIReviewsSupport":"com.soa.feature.enabled",
    "PublicAPIResourceLevelPermissionsSupport":"com.soa.feature.enabled",
    "PrivateAPIResourceLevelPermissionsSupport":"com.soa.feature.enabled",
    "APIWithNewServiceSupport":"com.soa.feature.enabled",
    "APIWithExistingServiceSupport":"com.soa.feature.disabled",
    "APIWithAnonymousAccessSupport":"com.soa.feature.enabled",
    "APIPromotionSupport":"com.soa.feature.enabled",
    "ValidateUniqueContextPath":"com.soa.feature.enabled"
  },
  "BusinessAppSettings":{
    "PublicAppSupport":"com.soa.feature.enabled",
    "PublicAppBoardSupport":"com.soa.feature.enabled",
    "PublicAppRatingsSupport":"com.soa.feature.enabled",
    "PublicAppReviewsSupport":"com.soa.feature.enabled",
    "PrivateAppSupport":"com.soa.feature.enabled",
    "PrivateAppBoardSupport":"com.soa.feature.enabled",
    "PrivateAppRatingsSupport":"com.soa.feature.enabled",
    "PrivateAppReviewsSupport":"com.soa.feature.enabled",
    "UserDefinedIdentitySupport":"com.soa.feature.enabled.for.siteadmins",
    "SimultaneousSandboxProductAccessSupport":"com.soa.feature.enabled",
    "ReturnPlainTextSharedSecret":"com.soa.feature.enabled",
    "RegisteredUsersAppSupport":"com.soa.feature.enabled",
    "RegisteredUsersAppRatingsSupport":"com.soa.feature.enabled",
    "RegisteredUsersAppReviewsSupport":"com.soa.feature.enabled",
    "AppPromotionSupport":"com.soa.feature.disabled"
  },
  "BusinessGroupSettings":{
    "GroupSupport":"com.soa.feature.enabled",
    "PublicGroupSupport":"com.soa.feature.enabled",
    "PublicGroupBoardSupport":"com.soa.feature.enabled",
    "PublicGroupRatingsSupport":"com.soa.feature.enabled",
    "PublicGroupReviewsSupport":"com.soa.feature.enabled",
    "PrivateGroupSupport":"com.soa.feature.enabled",
    "PrivateGroupBoardSupport":"com.soa.feature.enabled",
    "PrivateGroupRatingsSupport":"com.soa.feature.enabled",
    "PrivateGroupReviewsSupport":"com.soa.feature.enabled"
  },
  "BusinessUserSettings":{
    "NewsUpdateNotification":"com.soa.feature.enabled",
    "EnforceChallengesSetupOnLogin":"com.soa.feature.disabled",
    "SelfSignup":"com.soa.feature.enabled",
    "InviteUnregisteredUsers":"com.soa.feature.enabled",
    "ResetValidCodeHours":48,
    "SignupUserValidDays":7,
    "AddedUserValidDays":30,
    "InvitedUserValidDays":7
  },
  "TicketSettings":{
    "TicketSupport":"com.soa.feature.enabled",
    "Visibility":"com.soa.visibility.apivisibility",
    "MarkdownSupport":"com.soa.feature.enabled",
    "ExternalLinkSupport":"com.soa.feature.disabled"
  },
  "AlertSettings":{
    "AutoPublish":false,
    "MarkdownSupport":"com.soa.feature.enabled",
    "ExternalLinkSupport":"com.soa.feature.disabled"
  },
  "ConnectionSettings":{
  },
  "BusinessSecuritySettings":{
    "ReadRequestCSRFSupport":"com.soa.feature.disabled",
    "WriteRequestCSRFSupport":"com.soa.feature.disabled",
    "AllowUserEnum":"com.soa.feature.enabled",
    "EncryptChallengeAnswers":"com.soa.feature.disabled",
    "ChallengeCount":3,
    "UserModifyEmail":"com.soa.feature.enabled",
    "AuthTokenCookieDomain":"com.soa.auth.token.cookie.domain.hostname",
    "CaptchaSupport":"com.soa.feature.disabled",
    "ExternalDocSupport":"com.soa.feature.enabled"
  },
  "BusinessReviewSettings":{
    "AutoPublish":false,
    "MarkdownSupport":"com.soa.feature.enabled",
    "ExternalLinkSupport":"com.soa.feature.disabled"
  },
  "BusinessDiscussionSettings":{
    "AutoPublish":false,
    "MarkdownSupport":"com.soa.feature.enabled",
    "ExternalLinkSupport":"com.soa.feature.disabled"
  },
  "CommentSettings":{
    "AutoPublish":false,
    "MarkdownSupport":"com.soa.feature.enabled",
    "ExternalLinkSupport":"com.soa.feature.disabled"
  },
  "Settings":{
    "MaxFileSizeForUpload":4
  }
}

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
BusinessSettings	BusinessSettings	Contains information about the settings for a business on 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
404	The resource could not be found. For example, you might get this response if you send an invalid BusinessID in the request.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.