GET /api/businesses/{BusinessID}/licenses

Returns information about the licenses for a business.

Authorization Roles/Permissions: Must have Read permission for the resource. Must be a Business Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the license information for the specified business.

Request URL

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

Sample request headers

GET http://{hsotname}/api/businesses/tenantbusiness.acmepaymentscorp/licenses?_=1434477045404 HTTP/1.0
Host: {hsotname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_{tenant}: {TokenID}

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.
IncludeInactive Path boolean Optional Indicates whether inactive licenses should be included in the results. Default: true. To exclude inactive licenses, use this parameter with a value of false.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the license information in the form of an RSS feed.

Back to top

Sample Response

The sample response below shows successful completion of this operation. There are three licenses.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 16 Jun 2015 18:03:58 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Business Licenses",
    "description" : "tenantbusiness.acmepaymentscorp",
    "item" : [ {
      "title" : "Beta",
      "description" : "Access for beta testing, private.",
      "category" : [ {
        "value" : "Active",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "Limited",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:sandbox-access-anonymous-allowed"
      } ],
      "guid" : {
        "value" : "898d6758-0a1f-4850-944d-360483272225.acmepaymentscorp"
      },
      "LicensePartsDetails" : {
        "LicensePartDetails" : [ {
          "Name" : "462e18f9-2a7f-42dc-9609-aee2203f0f16",
          "Resource" : [ {
            "ResourceID" : "9eb212a0-a3f4-467b-9ad7-f5c1d1d79c5d.acmepaymentscorp",
            "Name" : "BetaScope",
            "ShortDescription" : "Access to beta operations.",
            "LongDescription" : "Access to beta operations for testing (private)",
            "Visibility" : "Limited",
            "SandboxAnonymousAccessAllowed" : false,
            "ProductionAnonymousAccessAllowed" : false,
            "ResourcePath" : "",
            "OAuthGrantDefaultResource" : true,
            "OAuthGrantUserAuthorizationRequired" : true,
            "BusinessID" : "tenantbusiness.acmepaymentscorp"
          } ]
        } ]
      }
    }, {
      "title" : "Bronze",
      "description" : "Read-only access at no charge. Both environments, public, approval required.",
      "category" : [ {
        "value" : "Active",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:sandbox-access-anonymous-allowed"
      } ],
      "guid" : {
        "value" : "83fe122b-640a-4592-b502-a92aae22cb74.acmepaymentscorp"
      },
      "LicensePartsDetails" : {
        "LicensePartDetails" : [ {
          "Name" : "0e718264-5864-48bd-b3c3-7ff7f879e171",
          "Resource" : [ {
            "ResourceID" : "b3bf7906-ed51-471a-a70b-b6ac1b23185b.acmepaymentscorp",
            "Name" : "ReadOnlyScope",
            "ShortDescription" : "Read-only operations.",
            "LongDescription" : "Read-only operations. Public visibility",
            "Visibility" : "Public",
            "SandboxAnonymousAccessAllowed" : false,
            "ProductionAnonymousAccessAllowed" : false,
            "ResourcePath" : "",
            "OAuthGrantDefaultResource" : true,
            "OAuthGrantUserAuthorizationRequired" : true,
            "BusinessID" : "tenantbusiness.acmepaymentscorp"
          } ]
        } ]
      }
    }, {
      "title" : "Gold",
      "description" : "Full access, monthly fee.",
      "category" : [ {
        "value" : "Active",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:production-access-anonymous-allowed"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:access:sandbox-access-anonymous-allowed"
      } ],
      "guid" : {
        "value" : "d6d35c0f-6a88-49ff-943f-3e2549d1b06c.acmepaymentscorp"
      },
      "LicensePartsDetails" : {
        "LicensePartDetails" : [ {
          "Name" : "09b3d3fb-fc8e-415c-84e2-c8d5f83943f7",
          "Resource" : [ {
            "ResourceID" : "e954361a-e1fd-4fb1-b110-7ff3386a08d3.acmepaymentscorp",
            "Name" : "FullScope",
            "ShortDescription" : "Full access to all operations.",
            "LongDescription" : "Full access to all operations.",
            "Visibility" : "Public",
            "SandboxAnonymousAccessAllowed" : false,
            "ProductionAnonymousAccessAllowed" : false,
            "ResourcePath" : "",
            "OAuthGrantDefaultResource" : true,
            "OAuthGrantUserAuthorizationRequired" : true,
            "BusinessID" : "tenantbusiness.acmepaymentscorp"
          } ]
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Date: Tue, 16 Jun 2015 18:44:43 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/rss/1.0" xmlns:ns4="http://soa.com/xsd/user/1.0" 
xmlns:ns5="http://soa.com/xsd/comment/1.0" xmlns:ns6="http://soa.com/xsd/board/1.0" xmlns:ns7="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns8="http://soa.com/xsd/dnmodel/1.0" xmlns:ns9="http://soa.com/xsd/resource/1.0" xmlns:ns10="http://soa.com/xsd/legals/1.0" 
xmlns:ns11="http://soa.com/xsd/fault/1.0" xmlns:ns12="http://soa.com/xsd/api/1.0" xmlns:ns13="http://soa.com/xsd/alert/1.0" 
xmlns:ns14="http://soa.com/xsd/contract/1.0" xmlns:ns15="http://soa.com/xsd/ticket/1.0" xmlns:ns16="http://soa.com/xsd/app/1.0" 
xmlns:ns17="http://soa.com/xsd/discussion/1.0" xmlns:ns18="http://soa.com/xsd/review/1.0" xmlns:ns19="http://soa.com/xsd/search/1.0" 
xmlns:ns20="http://soa.com/xsd/workflow/1.0" xmlns:ns21="http://soa.com/xsd/client/services/1.0" version="1.0">
  <channel>
    <title>Business Licenses</title>
    <description>tenantbusiness.acmepaymentscorp</description>
    <item>
      <title>Beta</title>
      <description>Access for beta testing, private.</description>
      <category domain="uddi:soa.com:state">Active</category>
      <category domain="uddi:soa.com:visibility">Limited</category>
      <category domain="uddi:soa.com:access:production-access-anonymous-allowed">false</category>
      <category domain="uddi:soa.com:access:sandbox-access-anonymous-allowed">false</category>
      <guid>898d6758-0a1f-4850-944d-360483272225.acmepaymentscorp</guid>
      <ns2:LicensePartsDetails>
        <ns2:LicensePartDetails>
          <ns2:Name>462e18f9-2a7f-42dc-9609-aee2203f0f16</ns2:Name>
          <ns2:Resource>
            <ns2:ResourceID>9eb212a0-a3f4-467b-9ad7-f5c1d1d79c5d.acmepaymentscorp</ns2:ResourceID>
            <ns2:Name>BetaScope</ns2:Name>
            <ns2:ShortDescription>Access to beta operations.</ns2:ShortDescription>
            <ns2:LongDescription>Access to beta operations for testing (private)</ns2:LongDescription>
            <ns2:Visibility>Limited</ns2:Visibility>
            <ns2:SandboxAnonymousAccessAllowed>false</ns2:SandboxAnonymousAccessAllowed>
            <ns2:ProductionAnonymousAccessAllowed>false</ns2:ProductionAnonymousAccessAllowed>
            <ns2:ResourcePath></ns2:ResourcePath>
            <ns2:OAuthGrantDefaultResource>true</ns2:OAuthGrantDefaultResource>
            <ns2:OAuthGrantUserAuthorizationRequired>true</ns2:OAuthGrantUserAuthorizationRequired>
            <ns2:BusinessID>tenantbusiness.acmepaymentscorp</ns2:BusinessID>
          </ns2:Resource>
        </ns2:LicensePartDetails>
      </ns2:LicensePartsDetails>
    </item>
    <item>
      <title>Bronze</title>
      <description>Read-only access at no charge. Both environments, public, approval required.</description>
      <category domain="uddi:soa.com:state">Active</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <category domain="uddi:soa.com:access:production-access-anonymous-allowed">false</category>
      <category domain="uddi:soa.com:access:sandbox-access-anonymous-allowed">false</category>
      <guid>83fe122b-640a-4592-b502-a92aae22cb74.acmepaymentscorp</guid>
      <ns2:LicensePartsDetails>
        <ns2:LicensePartDetails>
          <ns2:Name>0e718264-5864-48bd-b3c3-7ff7f879e171</ns2:Name>
          <ns2:Resource>
            <ns2:ResourceID>b3bf7906-ed51-471a-a70b-b6ac1b23185b.acmepaymentscorp</ns2:ResourceID>
            <ns2:Name>ReadOnlyScope</ns2:Name>
            <ns2:ShortDescription>Read-only operations.</ns2:ShortDescription>
            <ns2:LongDescription>Read-only operations. Public visibility</ns2:LongDescription>
            <ns2:Visibility>Public</ns2:Visibility>
            <ns2:SandboxAnonymousAccessAllowed>false</ns2:SandboxAnonymousAccessAllowed>
            <ns2:ProductionAnonymousAccessAllowed>false</ns2:ProductionAnonymousAccessAllowed>
            <ns2:ResourcePath></ns2:ResourcePath>
            <ns2:OAuthGrantDefaultResource>true</ns2:OAuthGrantDefaultResource>
            <ns2:OAuthGrantUserAuthorizationRequired>true</ns2:OAuthGrantUserAuthorizationRequired>
            <ns2:BusinessID>tenantbusiness.acmepaymentscorp</ns2:BusinessID>
          </ns2:Resource>
        </ns2:LicensePartDetails>
      </ns2:LicensePartsDetails>
    </item>
    <item>
      <title>Gold</title>
      <description>Full access, monthly fee.</description>
      <category domain="uddi:soa.com:state">Active</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <category domain="uddi:soa.com:access:production-access-anonymous-allowed">false</category>
      <category domain="uddi:soa.com:access:sandbox-access-anonymous-allowed">false</category>
      <guid>d6d35c0f-6a88-49ff-943f-3e2549d1b06c.acmepaymentscorp</guid>
      <ns2:LicensePartsDetails>
        <ns2:LicensePartDetails>
          <ns2:Name>09b3d3fb-fc8e-415c-84e2-c8d5f83943f7</ns2:Name>
          <ns2:Resource>
            <ns2:ResourceID>e954361a-e1fd-4fb1-b110-7ff3386a08d3.acmepaymentscorp</ns2:ResourceID>
            <ns2:Name>FullScope</ns2:Name>
            <ns2:ShortDescription>Full access to all operations.</ns2:ShortDescription>
            <ns2:LongDescription>Full access to all operations.</ns2:LongDescription>
            <ns2:Visibility>Public</ns2:Visibility>
            <ns2:SandboxAnonymousAccessAllowed>false</ns2:SandboxAnonymousAccessAllowed>
            <ns2:ProductionAnonymousAccessAllowed>false</ns2:ProductionAnonymousAccessAllowed>
            <ns2:ResourcePath></ns2:ResourcePath>
            <ns2:OAuthGrantDefaultResource>true</ns2:OAuthGrantDefaultResource>
            <ns2:OAuthGrantUserAuthorizationRequired>true</ns2:OAuthGrantUserAuthorizationRequired>
            <ns2:BusinessID>tenantbusiness.acmepaymentscorp</ns2:BusinessID>
          </ns2:Resource>
        </ns2:LicensePartDetails>
      </ns2:LicensePartsDetails>
    </item>
    <item>
  </channel>
</rss>

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 Licenses, and the description is the Business ID. Each item in the channel represents one license definition, and includes the information listed below.

Name Description
Title Title of the license.
Description Description of the license.
Category

Sets of name/value pairs containing values associated with the license:

  • uddi:soa.com:state: the state of the license. For values, see License State Values.
  • uddi:soa.com:visibility: the visibility of the license. For values, see Visibility for Licenses and Scopes.
  • uddi:soa.com:access:production-access-anonymous-allowed: indicates whether anonymous access is allowed for the Live implementation (Boolean).
  • uddi:soa.com:access:sandbox-access-anonymous-allowed: indicates whether anonymous access is allowed for the Sandbox implementation (Boolean).
LicensePartsDetails Contains information about one or more license parts.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics