PUT /api/businesses/{BusinessID}/connectionsettings

Updates the configurable connection settings for a business on the platform.

Note: When you change a setting, it might take up to five minutes for the change to take effect.

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

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

Sample Request

The example below shows a request to update the settings for Sandbox and Live implementations. In the Sandbox implementation, the comments workflow is reset to the system default.

Sample Request URL

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

Sample request headers

Content-Type: application/json
Accept: application/vnd.soa.v72+json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "WorkflowSetting":[
    {
      "WorkflowDefinitionKey":"workflow:definition:apicontract:v72",
      "Environment":"Production",
      "ConnectionCommentWorkflowDefKey":"workflow:definition:comment"
    },
    {
      "WorkflowDefinitionKey":"workflow:definition:apicontract:v72",
      "Environment":"Sandbox",
      "ConnectionCommentWorkflowDefKey":""
    }
  ]
}

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
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
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.
ConnectionSettings	Body	ConnectionSettings	Required	Contains information about a business's settings in relation to connections (app/API contracts).

Response

If successful, this operation returns HTTP status code 200, with the updated settings.

Sample Response #1

The sample response below shows the results from the sample request. Sandbox comment workflow is reset. to system default (no value supplied).

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+json
Expires: Fri, 06 Feb 2015 20:22:13 GMT

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

{
  "WorkflowSetting" : [ {
    "WorkflowDefinitionKey" : "workflow:definition:apicontract:v72",
    "Environment" : "Production",
    "ConnectionCommentWorkflowDefKey" : "workflow:definition:comment"
  }, {
    "WorkflowDefinitionKey" : "workflow:definition:apicontract:v72",
    "Environment" : "Sandbox"
  } ]
}

Sample Response #2

The sample response below includes values for all settings.

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Fri, 06 Feb 2015 20:24:58 GMT

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectionSettings 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">
  <WorkflowSetting>
    <WorkflowDefinitionKey>workflow:definition:apicontract:v72</WorkflowDefinitionKey>
    <Environment>Production</Environment>
    <ConnectionCommentWorkflowDefKey>workflow:definition:comment</ConnectionCommentWorkflowDefKey>
  </WorkflowSetting>
  <WorkflowSetting>
    <WorkflowDefinitionKey>workflow:definition:apicontract:v72</WorkflowDefinitionKey>
    <Environment>Sandbox</Environment>
    <ConnectionCommentWorkflowDefKey>workflow:definition:comment</ConnectionCommentWorkflowDefKey>
  </WorkflowSetting>
</ConnectionSettings>

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

Response Body

Name	Type	Description
ConnectionSettings	ConnectionSettings	Contains information about a business's settings in relation to connections (app/API contracts).

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