GET /api/businesses/{BusinessID}/appsettings

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

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

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

Sample Request URL

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

Sample request headers

Accept: application/json
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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 app settings for the specified business.

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
Date: Wed, 06 Nov 2019 19:36:25 GMT

Sample response body: application/json

{
  "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",
  "ContractPoliciesSupport":"com.soa.feature.enabled"
}

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
BusinessAppSettings	BusinessAppSettings	Default settings to apply to all apps within the business, unless specified otherwise at a lower level.

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
406	Not Acceptable. Returned if there is a problem with the request format. For example, you would get this if you specified an incorrect media type for the Accept header.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics