GET /api/legals/{LegalDocumentID}

Returns a summary of information about a specified legal agreement document on the platform.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for information about the specified legal document.

Request URL

https://{hostname}/api/legals/signupagrmtv1.acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept

application/json

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the specified legal document.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json

Sample response body

{
  "DocumentID" : "signupagrmtv1.acmepaymentscorp",
  "Name" : "acmepaymentscorp Signup Agreement v1",
  "Description" : "acmepaymentscorp Developer Agreement",
  "AgreementType" : "com.soa.atmosphere.legals.signup",
  "ContentPath" : "/home/landing/developeragreement_acmepaymentscorp.html?version=1",
  "Active" : true,
  "PrintContentPath" : "/home/landing/developeragreement_acmepaymentscorp.pdf?version=1",
  "DocumentState" : "com.soa.status.active",
  "FileName" : "developeragreement_acmepaymentscorp.html"
}

Back to top

Response Headers

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

Header Description
Content-Type

application/json

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

Response Body

Name Type Description
AgreementDocument AgreementDocument Contains information about a platform legal agreement document.

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
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics