GET /api/businesses/{BusinessID}/licenses
Returns information about the licenses for a business.
Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. Must be a Business Admin.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/businesses/{BusinessID}/licenses
Sample Request
The example below shows a request for the license information for the specified business.
Sample 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_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. |
| 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. |
Response
If successful, this operation returns HTTP status code 200, with the license information in the form of an RSS feed.
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"
}
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
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:
|
| LicensePartsDetails | Contains information about one or more license parts. |
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.