GET /api/businesses/{BusinessID}/modelcategories

Returns information about the categories defined for model objects in the business organization.

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

URL

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

Sample Request

The example below shows a request for information about the model categories in the specified business.

Request URL #1

Requests model categories. For the response to this request, see Sample response body #1.

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

Request URL #2

Requests model categories, including deleted categories. For the response to this request, see Sample response body #2.

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/modelcategories?IncludeDeleted=true

Sample request headers

Accept: application/json
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
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.
IncludeDeleted	Query	boolean	Optional	By default, categories that have been deleted are not included. If included with value of true, all categories are returned.

Response

If successful, this operation returns HTTP status code 200, with information about the categories. In this example, there are two: the global default, and one user-defined category.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Date: Tue, 30 Apr 2019 18:48:42 GMT
Content-Type: application/json

Sample response body #1

Response to Request URL #1. Only active categories are returned.

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

Sample response body #2

Response to Request URL #2. Since the optional IncludeDeleted parameter was included in the request, deleted categories are included in the response.

{
  "ModelCategory":[
    {
      "Name":"global",
      "Description":"desc",
      "Deleted":false
    },
    {
      "Name":"Income",
      "Description":"Income transactions",
      "Deleted":false
    },
    {
      "Name":"Transaction",
      "Description":"Business transaction (all types).",
      "Deleted":true
    }
  ]
}

Response Headers

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

Header	Description
Content-Type	application/json

Response Body

Name	Type	Description
ModelCategories	ModelCategories	Contains information about the model object categories defined for model objects in the business.

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.

Related Topics