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

Modifies information about a legal document for the specified API (name or description).

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}/details

Sample Request

The example below shows a request to modify the legal agreement information.

Sample Request URL

https://{hostname}/api/apis/versions/961d2b7d-0f70-4978-b05d-c45dc333e067.acmepaymentscorp/
legals/6c3cc8b5-9f09-490b-b1ed-2fbb24255b26.acmepaymentscorp/details

Sample request headers

PUT /api/apis/versions/961d2b7d-0f70-4978-b05d-c45dc333e067.acmepaymentscorp/legals/6c3cc8b5-
9f09-490b-b1ed-2fbb24255b26.acmepaymentscorp/details 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

{
  "Name":"Sample EULA for advanced users",
  "Description":"Sample EULA for premier/advanced Platinum Tier users only."
}

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 of the legal document for which the details are being modified.
AgreementDocument	Body	AgreementDocument	Required	The revised information about the legal agreement; Name and Description string values.

Response

If successful, this operation returns HTTP status code 200, with the LegalDocumentID.

Sample Response

The sample response below shows that the operation completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 18 Jul 2014 14:29:50 GMT
Content-Type: text/plain

Sample response body

6c3cc8b5-9f09-490b-b1ed-2fbb24255b26.acmepaymentscorp

Response Headers

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

Header	Description
Content-Type	text/plain

Response Body

Header	Description
LegalDocumentID	The unique ID of the legal document that was modified.

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