GET /api/businesses/{BusinessID}

Returns information about a business on the platform.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for information about a specific business, with all optional parameters included.

Request URL

https://{hostname}/api/businesses/fc868639-4d3a-4f19-89c9-edbb95173566.acmepaymentscorp?IncludeBusinessAPISettings=true
&IncludeBusinessAppSettings=true&IncludeBusinessGroupSettings=true&IncludeTicketSettings=true
&IncludeConnectionSettings=true&IncludeDiscussionSettings=true&IncludeReviewSettings=true
&IncludeAlertSettings=true&IncludeCommentSettings=true&IncludeUserSettings=true&IncludeBusinessSettings=true

Sample request headers

Accept: application/vnd.soa.v83+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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, text/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

application/vnd.soa.v83+json, application/vnd.soa.v83+xml

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.

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 Boolean Optional If set to true, the business's API settings are included in the results.
IncludeBusinessAppSettings Query Boolean Optional If set to true, the business's app settings are included in the results.
IncludeBusinessGroupSettings Query Boolean Optional If set to true, the business's group settings are included in the results.
IncludeTicketSettings Query Boolean Optional If set to true, the business's ticket settings are included in the results.
IncludeConnectionSettings Query Boolean Optional If set to true, the business's connection settings are included in the results.
IncludeDiscussionSettings Query Boolean Optional If set to true, the business's discussion settings are included in the results.
IncludeReviewSettings Query Boolean Optional If set to true, the business's review settings are included in the results.
IncludeAlertSettings Query Boolean Optional If set to true, the business's alert settings are included in the results.
IncludeCommentSettings Query Boolean Optional If set to true, the business's comment settings are included in the results.
IncludeUserSettings Query Boolean Optional If set to true, the business's user settings are included in the results.
IncludeBusinessSettings Query Boolean Optional If set to true, general settings for the business are included in the results.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation. The request included all optional parameters, so all settings are returned.

Sample response headers

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+json
Date: Thu, 21 Jun 2018 23:53:34 GMT

Sample response body

With all optional query parameters included.

{
  "BusinessID":"tenantbusiness.acmepaymentscorp",
  "BusinessKey":"uddi:soa.com:atmosphere:tenant:automation",
  "Name":"Tenant - automation",
  "Visibility":"Limited",
  "AvatarURL":"http://automation-acmepaymentscorp.com/api/businesses/avatar/_V_8TceffK_Nhbb1XJ5uumHg/atmo.tenant",
  "AdminGroupID":"bizadmin-tenantbusiness.acmepaymentscorp",
  "BusinessType":"atmo.tenant",
  "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":{

  },
  "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
  }
}

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, text/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

application/vnd.soa.v83+json, application/vnd.soa.v83+xml

Back to top

Response Body

Name Type Description
Business Business Contains information about 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
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404 The resource could not be found. For example, you might get this if you include 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