GET /api/businesses/types

Returns a list of the business (organization) types available on the platform.

Authorization Roles/Permissions: Must be an authorized administrator: Business Admin, Site Admin, or other authorized user.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/types[?IncludeAvatars=true]

Back to top

Sample Request

The example below shows a request for information about the business organization types on the platform.

Request URL

https://{hostname}/api/businesses/types

Sample request headers

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
IncludeAvatars Query string Optional If included with a value of true, returns avatars for the business organization types (if avatars are set up).

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the business organization types.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v83+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+json
Date: Tue, 30 Aug 2016 15:19:13 GMT

Sample response body: application/vnd.soa.v83+json

{
  "BusinessType" : [ {
    "Name" : "Company"
  }, {
    "Name" : "Department"
  }, {
    "Name" : "Project"
  }, {
    "Name" : "Application"
  }, {
    "Name" : "Partner"
  } ]
}

Back to top

Response Headers

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

Header Description
Content-Type application/json, application/vnd.soa.v83+json

Back to top

Response Body

Name Type Description
BusinessTypes BusinessTypes Contains information about business organization types on the platform.

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