Generate License-based Usage Report
===================================

Create CSP NCE License-based subscriptions custom CSV export file and make it available in Cloud-iQ portal and API.

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/authentication`

C#
^^

To create Microsoft NCE licence based export file, first instantiate **LicenseBasedReportRequest**.

Next, get the instance of **CrayonApiClient** and then get the client token using the instance. This client token will be passed when creating a file.

Finally, call **ExportQueue.Create()** method to generate export file by passing the token and the instance of **LicenseBasedReportRequest**.

.. code-block:: c#
	:emphasize-lines: 11
	
	var exportFileRequest = new LicenseBasedReportRequest
	{
		CustomerAccountId = <customer account ID>,
		TimeRange = new TimeRangeViewModel
		{
			From = <from date>,
            To = <to date>
		},
        CloudAccountId = null,
        InvoiceProfileId = null
	};

	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	var result = client.Exports.Create(token, exportFileRequest);


Request
^^^^^^^

Request Syntax:

+---------+--------------------------------------------------------------------+
| Method  | Request URI                                                        |
+=========+====================================================================+
| POST    | *https://api.crayon.com/api/v1/exports/generate-license-report/*   |
+---------+--------------------------------------------------------------------+

Request Body:

+--------------------------+----------------------------------------------+------------------------------------------------+
| Name                     | Type                                         | Description                                    |
+==========================+==============================================+================================================+
| Export file request      | :doc:`/resources/LicenseBasedReportRequest`  | The license based request to create a file     |
+--------------------------+----------------------------------------------+------------------------------------------------+

LicenseBasedReportRequest Properties:

+-------------------------+------------------------------------------+----------------+
| Name                    | Type                                     | Required       |
+=========================+==========================================+================+
| CustomerAccountId       | int                                      | Yes            |
+-------------------------+------------------------------------------+----------------+
| TimeRange               | TimeRange                                | Yes            |
+-------------------------+------------------------------------------+----------------+
| CloudAccountId          | int                                      | No             |
+-------------------------+------------------------------------------+----------------+
| InvoiceProfileId        | int                                      | No             |
+-------------------------+------------------------------------------+----------------+

TimeRange Properties:

+---------------+--------------------+------------+
| Name          | Type               | Required   |
+===============+====================+============+
| From          | string             | Yes        |
+---------------+--------------------+------------+
| To            | string             | Yes        |
+---------------+--------------------+------------+


Request Headers:

The following HTTP request headers are supported

+------------------+----------------+-----------------------------------------------------------------+
| Header           | Type           | Description                                                     |
+==================+================+=================================================================+
| Authorization    | string         | Required. The authorization token in the form Bearer <token>.   |
+------------------+----------------+----------------------------------------------+------------------+
| Accept           | string         | Specifies the request and response type, "application/json".    |
+------------------+----------------+----------------------------------------------+------------------+
| Content-Type     | string         | Specifies the media type of the resource, "application/json".   |
+------------------+----------------+----------------------------------------------+------------------+

Request Example:

::

	POST $"https://api.crayon.com/api/v1/exports/generate-license-report/"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >

Request Body:

.. literalinclude:: /scenarios/_static/LicenseBasedReportRequest.json
		:language: json

Response
^^^^^^^^
If successful, this method sends required payload to Azure Service Bus for generating license-based NCE Usage report with HTTP status code.

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error Codes                    | Description                                                                                                                                                                                                                                                                               |
+================================+===========================================================================================================================================================================================================================================================================================+
| 200 Ok                         | The request has succeeded.                                                                                                                                                                                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400 Bad Request                | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.   |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401 Unauthorized               | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+