Check-in License to the Local License Server

This API allows check in of a license back to a visible AutoPass License Server which has an appropriate product license pool. The API is asynchronous and has two stages:

  1. Check-in request
  2. Get check-in status

Check In License

This API initiates the checkout license operation.

Body:

checkinParameters - The configuration of the check in operation; it includes the product ID, and also which license has been checked out from the pool.

Return value:

None.

Request

JSON

URL http://ip:port/shunra/api/license/checkin
HTTP Method POST
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body
{
    "productKey":"43"
}

XML

URL http://ip:port/shunra/api/license/checkin
HTTP Method POST
HTTP Headers

Content-Type: application/xml

Accept: application/xml

Authorization: See Web Services Authentication.

Body
<checkoutParameters>
    <productKey>66</productKey>
</checkoutParameters>

 

Response

JSON

HTTP Response Code 200 - OK
HTTP Headers

Date: Thu, 15 Mar 2012 15:55:38 GMT

Accept-Ranges: bytes

HTTP Body None

Check In Status

This API validates the current status of the license currently being checked in.

Parameters:

productkey - The ID of the Network Virtualization product for which the license check in is going to occur.

Return Value:

LicenseModificationStatus - the status and the error description (if an error occurred during the license check in).

The possible statuses are:

// a job still has not been started
Idle(0),

// a job started
Started(1),

// a job finished
Finished(2),

// a job failed
Failed(3);

Request

URL http://ip:port/shunra/api/license/checkin/{productid}
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

Response

JSON

HTTP Response Code 200 - OK
HTTP Headers

Date: Thu, 15 Mar 2014 15:36:11 GMT

Content-Type: application/json; charset=UTF-8

Accept-Ranges: bytes

HTTP Body
{
    "statusDescription": null,
    "licenseStatus": "Finished"
}

XML

HTTP Response Code 200 - OK
HTTP Headers

Date: Thu, 15 Mar 2014 15:36:11 GMT

Content-Type: application/xml; charset=UTF-8

Accept-Ranges: bytes

HTTP Body
<licenseModificationStatus>
    <licenseStatus>Finished</licenseStatus>
</licenseModificationStatus>