PUT /api/licenses/{LicenseID}

Updates information about 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}

Sample Request

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

Sample Request URL

https://{hostname}/api/licenses/83fe122b-640a-4592-b502-a92aae22cb74.acmepaymentscorp

Sample request headers

PUT http://{hostname}/api/licenses/83fe122b-640a-4592-b502-a92aae22cb74.acmepaymentscorp HTTP/1.0
Host: {hostname}
Accept: application/json
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header Description
Accept 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
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.
License POST License Required Contains information about a specific API license.

Response

If successful, this operation returns HTTP status code 200, with information about the updated license.

Sample Response

The sample response below shows successful completion of this operation. The modified name is sent, and

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Tue, 16 Jun 2015 19:14:26 GMT
Content-Type: application/json

Sample response body: application/json

{
  "LicenseID" : "83fe122b-640a-4592-b502-a92aae22cb74.acmepaymentscorp",
  "Name" : "Bronze Access",
  "Description" : "Read-only access at no charge. Both environments, public, approval required.",
  "Visibility" : "Public",
  "SandboxAccessAutoApproved" : false,
  "ProductionAccessAutoApproved" : false,
  "LicenseParts" : {
    "LicensePart" : [ {
      "Name" : "5c1aeec7-0f79-4487-b8f9-70ab77bdda23",
      "ResourceID" : [ "b3bf7906-ed51-471a-a70b-b6ac1b23185b.acmepaymentscorp" ],
      "PolicyKey" : [ ]
    } ]
  },
  "BusinessID" : "tenantbusiness.acmepaymentscorp",
  "Active" : true,
  "Environment" : [ "Sandbox", "Production" ],
  "AgreementDetails" : {
    "AgreementDocument" : [ ]
  }
}

Response Headers

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

Header Description
Content-Type 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

Response Body

Name Type Description
License License Contains information about a specific API license.

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.