PUT /api/apis/versions/{APIVersionID}/legals/{LegalDocumentID}/state

Modifies the State of a legal document associated with a specified API version.

The initial state of a legal document is Draft. Once an API Administrator has activated the document, it can be switched between two states, active and inactive, as needed.

For more information about managing legal agreements for your API, see Managing Legal Agreements on the Platform.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/apis/versions/{APIVersionID}/legals/{LegalDocumentID}/state

Sample Request

The example below shows a document being inactivated.

Sample Request URL 

https://{hostname}/api/apis/versions/apiversion500.acmepaymentscorp/legals/api200eula2.acmepaymentscorp/state

Sample request headers 

PUT /api/apis/versions/apiversion500.acmepaymentscorp/legals/api200eula2.acmepaymentscorp/state HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body 

{
  "DocumentState":"com.soa.status.inactive"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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
APIVersionID Path string Required The unique ID for a specific API version.
LegalDocumentID Path string Required The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform.
AgreementDocument Body AgreementDocument Required

Information about the legal agreement being modified. Only the State parameter is required. Valid values:

  • com.soa.status.active
  • com.soa.status.inactive

Response

If successful, this operation returns HTTP status code 200, with the LegalDocumentID of the legal document for which the state was modified.

Sample Response

The sample response below shows successful completion of the operation.

Sample response headers 

HTTP/1.1 200 OK
Date: Mon, 04 Feb 2013 21:23:39 GMT
Content-Type: text/plain

Sample response body 

api200eula2.acmepaymentscorp

Response Headers

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

Header Description
Content-Type text/plain

Response Body

Name Description
LegalDocumentID The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform.

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.