GET /api/businesses/{BusinessID}/resources

Returns information about scopes for the specified business organization on the platform, in the form of an RSS channel.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the business information; a user who is logged in.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

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

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

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the scopes, in the form of an RSS channel.

Back to top

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: Fri, 07 Oct 2016 20:49:57 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Business Resources",
    "description" : "tenantbusiness.acmepaymentscorp",
    "item" : [ {
      "title" : "Bronze access",
      "description" : "Bronze access",
      "category" : [ {
        "value" : "resource",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:default-oauth-grant"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:grant-user-auth-required"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:sandbox-access-anonymous-allowed"
      } ],
      "comments" : "Bronze access",
      "guid" : {
        "value" : "74e58bdd-0c5a-47f9-b141-cbaa83e64293.acmepaymentscorp"
      }
    }, {
      "title" : "Full Access full service",
      "description" : "Full Access full service",
      "category" : [ {
        "value" : "resource",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:default-oauth-grant"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:grant-user-auth-required"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:sandbox-access-anonymous-allowed"
      } ],
      "comments" : "Full Access full service",
      "guid" : {
        "value" : "c5d9b260-da9d-4ad7-b5fe-77e8e0c49ef8.acmepaymentscorp"
      }
    }, {
      "title" : "Full Access limited bandwidth",
      "description" : "Full Access limited bandwidth",
      "category" : [ {
        "value" : "resource",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:default-oauth-grant"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:grant-user-auth-required"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:sandbox-access-anonymous-allowed"
      } ],
      "comments" : "Full Access limited bandwidth",
      "guid" : {
        "value" : "bf6c3182-ff38-4899-8862-eb1511b8f5bd.acmepaymentscorp"
      }
    }, {
      "title" : "Test access",
      "description" : "Test access",
      "category" : [ {
        "value" : "resource",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:default-oauth-grant"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com.resource:grant-user-auth-required"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com.access:sandbox-access-anonymous-allowed"
      } ],
      "comments" : "Test access",
      "guid" : {
        "value" : "d92e4800-db12-4478-8e23-5025959b4440.acmepaymentscorp"
      }
    } ]
  },
  "version" : "1.0"
}

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

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 Business Resources. Each item in the channel represents one scope, and includes the information listed below.

Name Description
title The text title of the scope. Corresponds to the Name field in the developer portal.
description Descriptive text for the scope. Corresponds to the Short Description field in the developer portal.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, representing properties of the scope. Categories include:

  • uddi:soa.com:resourcetype: value is always resource.
  • uddi:soa.com:visibility: indicates the visibility setting for the resource.
  • uddi:soa.com.resource:default-oauth-grant: indicates whether "OAuth default scope" is enabled for the resource.
  • uddi:soa.com.resource:grant-user-auth-required: indicates whether "user authorization required" is specified for the resource.
  • uddi:soa.com.access:production-access-anonymous-allowed: indicates whether anonymous access is allowed for production access.
  • uddi:soa.com.access:sandbox-access-anonymous-allowed: indicates whether anonymous access is allowed for sandbox access.
comments Additional information about the scope. Corresponds to the Full Description field in the developer portal.
GUID Unique ID for the scope; the ResourceID.

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics