PUT /api/legals/{LegalDocumentID}

Updates information about the platform legal agreement. You can use this operation to change or deactivate the existing legal agreement.

If you are not sure of the LegalDocumentID for the existing legal agreement, you can retrieve it using the GET /api/legals operation with this parameter: ?AgreementType=com.soa.atmosphere.legals.signup.

Note: To change the platform legal agreement, upload a new file and then assign it using this operation. The LegalDocumentID remains the same. To remove a platform legal agreement, use this operation to change the DocumentState property to com.soa.status.inactive.

Supported Versions: 8.3 and later

Authorization Roles/Permissions: Site Admin

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/legals/{LegalDocumentID}

Back to top

Sample Request

The examples below shows requests to update the platform legal agreement.

Request URL

https://{hostname}/api/legals/ab54495f-3553-47bf-8a35-fa1fe98d2993.acmepaymentscorp

Sample request headers

Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body #1: Makes a different document the legal agreement

{
  "Name" : "Platform User Agreement",
  "Description" : "User Signup Agreement",
  "AgreementType" : "com.soa.atmosphere.legals.signup",
  "ContentPath" : "/home/landing/platform_eula.txt",
  "Active" : true,
  "PrintContentPath" : "/home/landing/platform_eula.txt",
  "DocumentState" : "com.soa.status.active",
  "FileName" : "platform_eula.txt"
}

Sample request body #2: Deactivates the legal agreement, so that users no longer have to accept it.

{
  "Name" : "Platform User Agreement",
  "Description" : "User Signup Agreement",
  "AgreementType" : "com.soa.atmosphere.legals.signup",
  "ContentPath" : "/home/landing/platform_eula.txt",
  "Active" : true,
  "PrintContentPath" : "/home/landing/platform_eula.txt",
  "DocumentState" : "com.soa.status.inactive",
  "FileName" : "platform_eula.txt"
}

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 of the following media types is valid for the Accept header:

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

Request Parameters

Parameter Parm Type Data Type Required Description
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 Contains information about a platform legal agreement document.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no other response.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Date: Mon, 03 Oct 2016 21:41:21 GMT

Sample response body

Not applicable.

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

Not applicable.

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