GET /api/businesses

Returns information about businesses on the platform, as an RSS feed.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. Otherwise, the information is not returned.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/businesses

Sample Request

The example below shows a request for information about businesses on the platform.

Sample Request URL 

https://{hostname}/api/businesses

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, 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
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
Federation Query boolean Optional

Indicates whether the current implementation is a federation.

If not specified, defaults to false.

Response

If successful, this operation returns HTTP status code 200, with information about the businesses on the platform.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v83+json 

Status Code: 200 OK
Content-Type:  application/vnd.soa.v83+json
Date: Thu, 16 Mar 2017 18:25:37 GMT

Sample response body: application/vnd.soa.v83+json 

{
  "Business" : [ {
    "BusinessID" : "70284b50-fb9e-4ebf-963d-fad8c0327b43.acmepaymentscorp",
    "BusinessKey" : "uddi:soa.com:atmosphere:business:b9885c7b-0a67-11e7-950e-dfadbdf627aa",
    "Name" : "ACME Payments Corporation",
    "Description" : "ACME Payments Corporation",
    "Visibility" : "Limited",
    "AvatarURL" : "http://api.local.acmepaymentscorp.com/api/businesses/avatar/_VG4UbuRRHPiPJZT-cqY3NFQ/Company",
    "ParentBusinessID" : "tenantbusiness.acmepaymentscorp",
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "Tenant - acmepaymentscorp",
        "ID" : "tenantbusiness.acmepaymentscorp",
        "Type" : "business",
        "Avatar" : "http://api.local.acmepaymentscorp.com/api/businesses/avatar/_VG4UbuRRHPiPJZT-cqY3NFQ/atmo.tenant"
      } ]
    }
  }, {
    "BusinessID" : "tenantbusiness.acmepaymentscorp",
    "BusinessKey" : "uddi:soa.com:atmosphere:tenant:acmepaymentscorp",
    "Name" : "Tenant - acmepaymentscorp",
    "Visibility" : "Limited",
    "AvatarURL" : "http://api.local.acmepaymentscorp.com/api/businesses/avatar/_VG4UbuRRHPiPJZT-cqY3NFQ/atmo.tenant"
  }, {
    "BusinessID" : "30a5b59d-aaa5-475f-b561-672e432afa19.acmepaymentscorp",
    "BusinessKey" : "uddi:soa.com:atmosphere:business:8be88c0c-0a64-11e7-950e-dfadbdf627aa",
    "Name" : "Test Org",
    "Description" : "test",
    "Visibility" : "Limited",
    "AvatarURL" : "http://api.local.acmepaymentscorp.com/api/businesses/avatar/_VG4UbuRRHPiPJZT-cqY3NFQ/Department",
    "ParentBusinessID" : "tenantbusiness.acmepaymentscorp",
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "Tenant - acmepaymentscorp",
        "ID" : "tenantbusiness.acmepaymentscorp",
        "Type" : "business",
        "Avatar" : "http://api.local.acmepaymentscorp.com/api/businesses/avatar/_VG4UbuRRHPiPJZT-cqY3NFQ/atmo.tenant"
      } ]
    }
  } ]
}

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

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is Businesses. Each item in the channel represents a business on the platform, and includes the information listed below.

Name Description
title The text title of the business.
category[ ]

A name/value pair containing information about the business. For example:

"value" : "business",
"domain" : "uddi:soa.com:resourcetype"
GUID Unique GUID for the business (BusinessID).

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.