POST /api/apis/versions/{APIVersionID}/legals

Adds information about a new legal agreement for the specified API version.

Once this operation is complete, the legal agreement has a status of Published in the user interface, and can be activated.

For supported file types, see Legal Agreement Supported File Types.

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

Prerequisite: Before running this operation, you must upload the legal agreement using the POST /content/{path} (with application/x-www-form-urlencoded content-type) operation or the POST /content/{path} (with multipart/form-data content-type) operation in the Content service.

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

POST

URL

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

Sample Request

The example below shows a new legal agreement being activated.

Sample Request URL

https://{hostname}/api/apis/versions/ff46365a-ebac-4fd3-9cbd-f1ac20262f80.acmepaymentscorp/legals

Sample request headers

POST /api/apis/versions/ff46365a-ebac-4fd3-9cbd-f1ac20262f80.acmepaymentscorp/legals 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

{
  "ContentPath":"api/1254cc85-f5a7-4dfc-aa98-c0a2ec258dae.acmepaymentscorp/legal/api_legal_agreement_acmepaymentscorp.txt",
  "PrintContentPath":"api/1254cc85-f5a7-4dfc-aa98-c0a2ec258dae.acmepaymentscorp/legal/api_legal_agreement_acmepaymentscorp.txt",
  "Name":"Swagger API Legal Agreement acmepaymentscorp",
  "Description":"Swagger API Legal Agreement for acmepaymentscorp tenant (v1).",
  "AgreementType":"com.soa.atmosphere.legals.eula"
}

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.
AgreementDocument	Body	AgreementDocument	Required	Contains information about a platform legal agreement document. Required properties: ContentPath, PrintContentPath, Name, Description, AgreementType.

Response

If successful, this operation returns HTTP status code 200, with the LegalDocumentID for the new legal agreement.

Sample Response

The sample response below shows that the request completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Thu, 03 Jan 2019 22:50:00 GMT
Content-Type: text/plain

Sample response body

3e910268-d2d7-4201-a8e0-37e17434bc78.acmepaymentscorp

Response Headers

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

Header	Description
Content-Type	text/plain

Response Body

Name	Type	Description
LegalDocumentID	String	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.

Related Topics