GET /api/apps/versions/{AppVersionID}/contracts/environments?APIVersionID={APIVersionID}

Returns a summary of the environments available for the specified app version to request a contract with the specified API version.

You can use this operation to check what environments are available for the API version before initiating a contract request. In some cases the possible environments (Sandbox or Production) might be limited by a custom workflow.

Authorization Roles/Permissions: Must be logged in. Must be a user authorized to modify the specific app; an app team member.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apps/versions/{AppVersionID}/contracts/environments

Sample Request

The example below shows a request for the available connection environments for the specified API version if it were to initiate a contract with the specified API version.

Sample Request URL

https://{hostname}/api/apps/versions/cQ78EIfm3u59xjoMjN3ny4PI.acmepaymentscorp/contracts/environments?
APIVersionID=a4cc9f79-e8ff-4b06-ad70-2c1a08139776.acmepaymentscorp

Sample request headers

Accept: application/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, 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
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
AppVersionID	Path	string	Required	The unique ID for a specific app version.
APIVersionID	Query	string	Required	The unique ID for a specific API version.

Response

If successful, this operation returns HTTP status code 200, with a summary of the environments available for an app/API contract.

Sample Response

The sample response below shows successful completion of this operation. Sandbox and Live implementations are available.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Fri, 25 Apr 2014 14:27:29 GMT

Sample response body: application/json

{
  "AppVersionEnvironment" : [ {
    "EnvironmentID" : "Sandbox",
    "Environment" : "Sandbox"
  }, {
    "EnvironmentID" : "Production",
    "Environment" : "Production"
  } ]
}

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
AppVersionEnvironments	AppVersionEnvironments	Contains information about the environments available for the app version to request a contract with the API version.

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.
400	Returned if the client sends invalid parameters or body content. For example, you might get this response if there is an invalid AppVersionID in the request URL.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics