Get agreement reports
=====================================

Returns collection of agreement reports for specific product container.

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

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

C#
^^

Get the instance of **CrayonApiClient** and then get the client token using the instance. This client token will be passed when getting the agreement reports.

Finally, call **AgreementReport.GetAsync()** method to fetch agreement reports by passing the token and ProductContainerId.

.. code-block:: c#
	:emphasize-lines: 15
	
	int productContainerId = 0;

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

	var result = client.AgreementReport.GetAsync(token, productContainerId);

Request
^^^^^^^

Request Syntax:

+---------+-----------------------------------------------------------------------+
| Method  | Request URI                                                           |
+=========+=======================================================================+
| POST    | *https://api.crayon.com/api/v1/agrementreports/{productContainerId}*  |
+---------+-----------------------------------------------------------------------+

Request Parameters:

+----------------------------+----------------------------------------------+-----------------------------------------------+
| Name                       | Type                                         | Description                                   |
+============================+==============================================+===============================================+
| productContainerId         | int                                          | product container id                          |
+----------------------------+----------------------------------------------+-----------------------------------------------+

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/agreementreports/{productContainerId}/"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >

Response
^^^^^^^^
If successful, this method returns collection of agreement reports as a :doc:`/resources/AgreementReport` resource in the response body.

Response Body:

.. literalinclude:: /resources/_static/AgreementReports.json
		:language: json

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.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 502 Bad Gateway                | The server acting as a gateway or proxy received an incorrect response from the upstream server it accessed in attempting to fulfill the request. This is a non-retryable error condition.                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+