PUT /api/contracts/{ContractID}

Updates information about an app/API contract.

Authorization Roles/Permissions: Must be logged in. To complete this operation successfully, a user must be a member of the applicable team (App team member or API Admin).

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/contracts/{ContractID}

Back to top

Sample Request

The example below shows a request to update the state of the contract, which was previously in an Activated status, to a Suspended status.

Request URL

https://{hostname}/api/api/contracts/6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp

Sample request headers

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

Sample request body

{
  "ContractID" : "6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp",
  "APIVersionID" : "b9ef39d6-5eb4-45dd-9a53-d126c83935d7.acmepaymentscorp",
  "RuntimeID" : "5GeZHyOZUlk8ISehxqO2swA6.acmepaymentscorp",
  "Environment" : "Production",
  "State" : "apicontract.status.suspended",
  "ContractScope" : {
    "Restricted" : true,
    "LicenseID" : [ "0876cfb9-a308-4f24-a8b2-fc20493f0afb.acmepaymentscorp" ]
  },
  "Status" : "com.soa.apicontract.inforce"
}

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

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

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
ContractID Path string Required The unique ID for a specific contract between an app version and an API version.
Contract Body Contract Required Information about the contract, with the updated values.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the updated contract.

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
Date: Tue, 30 Sep 2014 00:00:00 GMT

Sample response body: application/json

{
  "ContractID" : "6e56a1d4-308d-4269-a4d7-b47781664921.acmepaymentscorp",
  "APIVersionID" : "b9ef39d6-5eb4-45dd-9a53-d126c83935d7.acmepaymentscorp",
  "RuntimeID" : "5GeZHyOZUlk8ISehxqO2swA6.acmepaymentscorp",
  "Environment" : "Production",
  "State" : "apicontract.status.suspended",
  "ContractScope" : {
    "Restricted" : true,
    "LicenseID" : [ "0876cfb9-a308-4f24-a8b2-fc20493f0afb.acmepaymentscorp" ]
  }
}

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
Contract Contract Contains information about a contract between an app and an API.

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
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you specified an incorrect content-type value for the request.
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