POST /api/businesses/{BusinessID}/resources

Adds a scope on the platform.

Authorization Roles/Permissions: Must have Add permission for the resource. Business Admin.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to add a scope.

Request URL

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

Sample request headers

POST /api/businesses/tenantbusiness.acmepaymentscorp/resources HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "ResourceID":"",
  "Name":"Bronze access",
  "ShortDescription":"Bronze access",
  "LongDescription":"Bronze access",
  "Visibility":"Public",
  "SandboxAnonymousAccessAllowed":"false",
  "ProductionAnonymousAccessAllowed":"false",
  "ResourcePath":"",
  "OAuthGrantDefaultResource":"true",
  "OAuthGrantUserAuthorizationRequired":"true",
  "ParentResourceID":"",
  "BusinessID":"tenantbusiness.acmepaymentscorp"
}

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

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or 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.

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.
Resource Body Resource Required

Contains information about a resource, such as a scope, defined for a business organization.

The unique ID is the Name field.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the scope that was added.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Fri, 07 Oct 2016 20:22:18 GMT
Content-Type: application/json

Sample response body: application/json

{
  "ResourceID" : "74e58bdd-0c5a-47f9-b141-cbaa83e64293.acmepaymentscorp",
  "Name" : "Access to READ operations",
  "ShortDescription" : "Access to READ operations",
  "LongDescription" : "Access to READ operations",
  "Visibility" : "Public",
  "SandboxAnonymousAccessAllowed" : false,
  "ProductionAnonymousAccessAllowed" : false,
  "ResourcePath" : "",
  "OAuthGrantDefaultResource" : true,
  "OAuthGrantUserAuthorizationRequired" : true,
  "BusinessID" : "tenantbusiness.acmepaymentscorp"
}

Back to top

Sample response headers: application/xml

HTTP/1.1 200 OK
Date: Fri, 07 Oct 2016 20:33:57 GMT
Content-Type: application/xml

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resource xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns3="http://soa.com/xsd/legals/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0">
  <ResourceID>e7e0ceb0-162c-4964-a31e-1ddd6580755c.acmepaymentscorp</ResourceID>
  <Name>Full access</Name>
  <ShortDescription>Full access</ShortDescription>
  <LongDescription>Full access</LongDescription>
  <Visibility>Public</Visibility>
  <SandboxAnonymousAccessAllowed>false</SandboxAnonymousAccessAllowed>
  <ProductionAnonymousAccessAllowed>false</ProductionAnonymousAccessAllowed>
  <ResourcePath></ResourcePath>
  <OAuthGrantDefaultResource>true</OAuthGrantDefaultResource>
  <OAuthGrantUserAuthorizationRequired>true</OAuthGrantUserAuthorizationRequired>
  <BusinessID>tenantbusiness.acmepaymentscorp</BusinessID>
</Resource>

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

Name Type Description
Resource Resource Contains information about a resource, such as a scope, defined for a business organization.

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