GET /api/businesses/{BusinessID}/ticketsettings

Returns information about the configurable ticket settings for a business on the platform.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the ticket settings for the specified business.

Request URL

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

Sample request headers

Accept: application/json

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, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the ticket settings for the specified business.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Tue, 12 May 2015 12:07:45 GMT

Sample response body: application/json

{
  "TicketSupport" : "com.soa.feature.enabled",
  "TicketWorkflowDefKey" : "workflow:definition:ticket",
  "TicketCommentWorkflowDefKey" : "workflow:definition:comment",
  "Visibility" : "com.soa.visibility.apivisibility"
  "MarkdownSupport" : "com.soa.feature.enabled"
  "ExternalLinkSupport" : "com.soa.feature.disabled"
}

Back to top

Sample response headers: application/vnd.soa.v72+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Sat, Tue, 12 May 2015 12:08:55 GMT

Sample response body: application/vnd.soa.v72+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TicketSettings xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/legals/1.0" xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0">
  <TicketSupport>com.soa.feature.enabled</TicketSupport>
  <TicketWorkflowDefKey>workflow:definition:ticket</TicketWorkflowDefKey>
  <TicketCommentWorkflowDefKey>workflow:definition:comment</TicketCommentWorkflowDefKey>
  <Visibility>com.soa.visibility.apivisibility</Visibility>
  <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
  <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
</TicketSettings>

Back to top

Response Headers

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

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
TicketSettings TicketSettings Contains information about a business's settings in relation to tickets.

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
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics