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.

API legal agreements can be HTML or text files.

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} or POST /content/upload operation in the Content service.

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

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

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

Back to top

Sample Request

The example below shows a new legal agreement being added.

Request URL

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

Sample request headers

POST /api/apis/versions/apiversion500.acmepaymentscorp/legals HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "ContentPath":"api/api200.acmepaymentscorp/legal/myapi_new_legalagreement.html",
  "PrintContentPath":"api/api200.acmepaymentscorp/legal/myapi_new_legalagreement.html",
  "Name":"Legal Agreement 2.0",
  "Description":"Updated Version of Legal Agreement for version 2.0",
  "AgreementType":"com.soa.atmosphere.legals.eula"
}

Back to top

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

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

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.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows that the request completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 27 Jun 2014 14:59:21 GMT
Content-Type: text/plain

Sample response body

aedc4a5a-c38d-4e06-8127-1a4e051b5ca0.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

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.

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