PUT /api/licenses/{LicenseID}/legals/{LegalDocumentID}/state

Updates the state of a legal document associated with a license on the platform.

Authorization Roles/Permissions: Must be logged in. Must be an authorized administrator: Business Admin

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/licenses/{LicenseID}/legals/{LegalDocumentID}/state

Sample Request

The example below shows a request to change the state of the specified license to Inactive.

Sample Request URL

https://{hostname}/api/licenses/5591b032-1a1c-4dc0-a941-ee5d5323e337.acmepaymentscorp

Sample request headers

PUT /api/licenses/5591b032-1a1c-4dc0-a941-ee5d5323e337.acmepaymentscorp/state HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Active":false
}

Request Headers

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

Header	Description
Accept	text/plain
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
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
LicenseID	Path	string	Required	The unique ID for a specific license.
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.

Response

If successful, this operation returns HTTP status code 200, with the unique ID of the license that was changed.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 29 Apr 2016 15:27:28 GMT
Content-Type: text/plain

Sample response body

5591b032-1a1c-4dc0-a941-ee5d5323e337.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
LicenseID	string	The unique ID for a specific license. It is the ID for the license that was changed.

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