GET /api/apis/versions/{APIVersionID}/settings

Returns a list of settings for the specified API version.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/settings

Back to top

Sample Request

The example below shows a request for the settings of a specific API version.

Request URL

https://{hostname}/api/apis/versions/apiversion20693.acmepaymentscorp/settings

Sample request headers

Accept: application/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, 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

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.

Back to top

Response

If successful, this operation returns HTTP status code 200, with a summary of the settings for the API version.

Back to top

Sample Response

The sample response below shows the settings for the requested API version.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 01 May 2013 21:59:46 GMT

Sample response body: application/json

{
  "SandboxEndpointSupport" : "com.soa.feature.enabled",
  "ProductionEndpointSupport" : "com.soa.feature.enabled",
  "SandboxAutoApprovalSupport" : "com.soa.feature.enabled",
  "ProductionAutoApprovalSupport" : "com.soa.feature.enabled",
  "BoardSupport" : "com.soa.feature.enabled",
  "RatingsSupport" : "com.soa.feature.enabled",
  "ReviewsSupport" : "com.soa.feature.enabled",
  "PrivateAPIGroupTypeSupport" : "com.soa.feature.disabled",
  "PrivateAPIIndependentGroupSupport" : "com.soa.feature.enabled"
}

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<APIVersionSettings xmlns="http://soa.com/xsd/api/1.0">
  <SandboxEndpointSupport>com.soa.feature.enabled</SandboxEndpointSupport>
  <ProductionEndpointSupport>com.soa.feature.enabled</ProductionEndpointSupport>
  <SandboxAutoApprovalSupport>com.soa.feature.enabled</SandboxAutoApprovalSupport>
  <ProductionAutoApprovalSupport>com.soa.feature.enabled</ProductionAutoApprovalSupport>
  <BoardSupport>com.soa.feature.enabled</BoardSupport>
  <RatingsSupport>com.soa.feature.enabled</RatingsSupport>
  <ReviewsSupport>com.soa.feature.enabled</ReviewsSupport>
  <PrivateAPIGroupTypeSupport>com.soa.feature.disabled</PrivateAPIGroupTypeSupport>
  <PrivateAPIIndependentGroupSupport>com.soa.feature.enabled</PrivateAPIIndependentGroupSupport>
</APIVersionSettings>

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
APIVersionSettings APIVersionSettings Contains information about the settings for the API version; for each feature, whether it is enabled or disabled.

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