GET /api/businesses/types
Returns a list of the business (organization) types available on the platform.
Authorization Roles/Permissions: Must be logged in. Must be an authorized administrator: Business Admin, Site Admin, or other authorized user.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/businesses/types[?IncludeAvatars=true]
Sample Request
The example below shows a request for information about the business organization types on the platform.
Sample Request URL
https://{hostname}/api/businesses/types
Sample request headers
Accept: application/vnd.soa.v83+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 or application/vnd.soa.v83+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 |
---|---|---|---|---|
IncludeAvatars | Query | string | Optional | If included with a value of true, returns avatars for the business organization types (if avatars are set up). |
Response
If successful, this operation returns HTTP status code 200, with information about the business organization types.
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" } ] }
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 |
Response Body
Name | Type | Description |
---|---|---|
BusinessTypes | BusinessTypes | Contains information about business organization types on the platform. |
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.