GET /api/businesses/types/{typeName}

Returns information about a specific type of business organization 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

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for information about the specified business organization type.

Request URL

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

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.

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
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
typeName Path string Required The type of business organization to be returned.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation. In this example, there is no avatar set up for the business type, so AvatarURL is not included in the response.

Sample response headers: application/json

Status Code: 200 OK 
Content-Type: application/vnd.soa.v83+json
Date: Tue, 30 Aug 2016 18:48:35 GMT

Sample response body: application/json

{
  "Name" : "Department"
}

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
BusinessType BusinessType Contains information about a type of business organization defined 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. 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.

Back to top

Related Topics