GET /api/businesses/{BusinessID}/settings

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

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

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]

Back to top

Sample Request

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

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.

Back to top

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

Back to top

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.

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

Back to top

Response

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

Back to top

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: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Fri, 29 May 2015 16:40:55 GMT

Sample response body: application/json

{
  "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.enabled",
    "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.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"
  },
  "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.enabled",
    "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.enabled",
    "AllowUserEnum" : "com.soa.feature.enabled",
    "EncryptChallengeAnswers" : "com.soa.feature.enabled",
    "ChallengeCount" : 3,
    "UserModifyEmail" : "com.soa.feature.disabled"
  },
  "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"
  }
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Fri, 29 May 2015 16:42:52 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BusinessSettings xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/legals/1.0" xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0">
  <BusinessAPISettings>
    <PublicAPISupport>com.soa.feature.enabled</PublicAPISupport>
    <PublicAPISandboxEndpointSupport>com.soa.feature.enabled</PublicAPISandboxEndpointSupport>
    <PublicAPIProductionEndpointSupport>com.soa.feature.enabled</PublicAPIProductionEndpointSupport>
    <PublicAPISandboxAutoApprovalSupport>com.soa.feature.enabled</PublicAPISandboxAutoApprovalSupport>
    <PublicAPIProductionAutoApprovalSupport>com.soa.feature.enabled</PublicAPIProductionAutoApprovalSupport>
    <PublicAPIBoardSupport>com.soa.feature.enabled</PublicAPIBoardSupport>
    <PublicAPIRatingsSupport>com.soa.feature.enabled</PublicAPIRatingsSupport>
    <PublicAPIReviewsSupport>com.soa.feature.enabled</PublicAPIReviewsSupport>
    <PrivateAPISupport>com.soa.feature.enabled</PrivateAPISupport>
    <PrivateAPISandboxEndpointSupport>com.soa.feature.enabled</PrivateAPISandboxEndpointSupport>
    <PrivateAPIProductionEndpointSupport>com.soa.feature.enabled</PrivateAPIProductionEndpointSupport>
    <PrivateAPISandboxAutoApprovalSupport>com.soa.feature.enabled</PrivateAPISandboxAutoApprovalSupport>
    <PrivateAPIProductionAutoApprovalSupport>com.soa.feature.enabled</PrivateAPIProductionAutoApprovalSupport>
    <PrivateAPIGroupTypeSupport>com.soa.feature.enabled</PrivateAPIGroupTypeSupport>
    <PrivateAPIIndependentGroupSupport>com.soa.feature.enabled</PrivateAPIIndependentGroupSupport>
    <PrivateAPIBoardSupport>com.soa.feature.enabled</PrivateAPIBoardSupport>
    <PrivateAPIRatingsSupport>com.soa.feature.enabled</PrivateAPIRatingsSupport>
    <PrivateAPIReviewsSupport>com.soa.feature.enabled</PrivateAPIReviewsSupport>
    <PublicAPIResourceLevelPermissionsSupport>com.soa.feature.enabled</PublicAPIResourceLevelPermissionsSupport>
    <PrivateAPIResourceLevelPermissionsSupport>com.soa.feature.enabled</PrivateAPIResourceLevelPermissionsSupport>
    <APIWithNewServiceSupport>com.soa.feature.enabled</APIWithNewServiceSupport>
    <APIWithExistingServiceSupport>com.soa.feature.enabled</APIWithExistingServiceSupport>
  </BusinessAPISettings>
  <BusinessAppSettings>
    <PublicAppSupport>com.soa.feature.enabled</PublicAppSupport>
    <PublicAppBoardSupport>com.soa.feature.enabled</PublicAppBoardSupport>
    <PublicAppRatingsSupport>com.soa.feature.enabled</PublicAppRatingsSupport>
    <PublicAppReviewsSupport>com.soa.feature.enabled</PublicAppReviewsSupport>
    <PrivateAppSupport>com.soa.feature.enabled</PrivateAppSupport>
    <PrivateAppBoardSupport>com.soa.feature.enabled</PrivateAppBoardSupport>
    <PrivateAppRatingsSupport>com.soa.feature.enabled</PrivateAppRatingsSupport>
    <PrivateAppReviewsSupport>com.soa.feature.enabled</PrivateAppReviewsSupport>
    <UserDefinedIdentitySupport>com.soa.feature.enabled.for.siteadmins</UserDefinedIdentitySupport>
    <SimultaneousSandboxProductAccessSupport>com.soa.feature.enabled</SimultaneousSandboxProductAccessSupport>
    <ReturnPlainTextSharedSecret>com.soa.feature.enabled</ReturnPlainTextSharedSecret>
  </BusinessAppSettings>
  <BusinessGroupSettings>
    <GroupSupport>com.soa.feature.enabled</GroupSupport>
    <PublicGroupSupport>com.soa.feature.enabled</PublicGroupSupport>
    <PublicGroupBoardSupport>com.soa.feature.enabled</PublicGroupBoardSupport>
    <PublicGroupRatingsSupport>com.soa.feature.enabled</PublicGroupRatingsSupport>
    <PublicGroupReviewsSupport>com.soa.feature.enabled</PublicGroupReviewsSupport>
    <PrivateGroupSupport>com.soa.feature.enabled</PrivateGroupSupport>
    <PrivateGroupBoardSupport>com.soa.feature.enabled</PrivateGroupBoardSupport>
    <PrivateGroupRatingsSupport>com.soa.feature.enabled</PrivateGroupRatingsSupport>
    <PrivateGroupReviewsSupport>com.soa.feature.enabled</PrivateGroupReviewsSupport>
  </BusinessGroupSettings>
  <BusinessUserSettings>
    <NewsUpdateNotification>com.soa.feature.enabled</NewsUpdateNotification>
    <EnforceChallengesSetupOnLogin>com.soa.feature.enabled</EnforceChallengesSetupOnLogin>
    <SelfSignup>com.soa.feature.enabled</SelfSignup>
    <InviteUnregisteredUsers>com.soa.feature.enabled</InviteUnregisteredUsers>
    <ResetValidCodeHours>48</ResetValidCodeHours>
    <SignupUserValidDays>7</SignupUserValidDays>
    <AddedUserValidDays>30</AddedUserValidDays>
    <InvitedUserValidDays>7</InvitedUserValidDays>
  </BusinessUserSettings>
  <TicketSettings>
    <TicketSupport>com.soa.feature.enabled</TicketSupport>
    <Visibility>com.soa.visibility.apivisibility</Visibility>
    <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
    <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
  </TicketSettings>
  <AlertSettings>
    <AutoPublish>false</AutoPublish>
    <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
    <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
  </AlertSettings>
  <ConnectionSettings />
  <BusinessSecuritySettings>
    <ReadRequestCSRFSupport>com.soa.feature.disabled</ReadRequestCSRFSupport>
    <WriteRequestCSRFSupport>com.soa.feature.enabled</WriteRequestCSRFSupport>
    <AllowUserEnum>com.soa.feature.enabled</AllowUserEnum>
    <EncryptChallengeAnswers>com.soa.feature.enabled</EncryptChallengeAnswers>
    <ChallengeCount>3</ChallengeCount>
    <UserModifyEmail>com.soa.feature.disabled</UserModifyEmail>
  </BusinessSecuritySettings>
  <BusinessReviewSettings>
    <AutoPublish>false</AutoPublish>
    <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
    <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
  </BusinessReviewSettings>
  <BusinessDiscussionSettings>
    <AutoPublish>false</AutoPublish>
    <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
    <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
  </BusinessDiscussionSettings>
  <CommentSettings>
    <AutoPublish>false</AutoPublish>
    <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
    <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
  </CommentSettings>
</BusinessSettings>

Back to top

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

Back to top

Response Body

Name Type Description
BusinessSettings BusinessSettings Contains information about the settings for a business on the 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
400 Bad request: Returned if the client sends invalid parameters or body content. 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.

Back to top

Related Topics