GET /api/businesses/{BusinessID}/modelcategories/{CategoryName}

Returns information about a category defined for model objects in the business.

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

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/{BusinessID}/modelcategories/{CategoryName}

Back to top

Sample Request

The example below shows a request for information about a model category named Transactions.

Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/modelcategories/Transactions

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
AtmoAuthToken_{fedmemberid} The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login.
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.
CategoryName Path string Required

The name of a category set up for model objects in the business organization

To get the model category name, you can use the GET /api/businesses/{businessID}/modelcategories operation.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the requested model object category.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Date: Tue, 30 Apr 2019 18:50:56 GMT
Content-Type: application/json

Sample response body: application/json

{
  "Name": "Transactions",
  "Description": "Business transactions (income, payments).",
  "Deleted": false
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json

Back to top

Response Body

Name Type Description
ModelCategory ModelCategory Contains information about a category defined for model objects in the business.

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.
404

The resource could not be found. For example, you might get this if you have a typo in the URL, or if the Accept header is set to a wrong value.

You would also get this response if you include an invalid CategoryName value in the URL.

500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics