Get agreement reports

Returns collection of agreement reports for specific product container.

Prerequisites

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.

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 AgreementReport resource in the response body.

Response Body:

{
    "Items": [
        {
            "ProductContainer": {
                "Id": 9999,
                "Name": "Product A"
            },
            "Agreement": {
                "AgreementNumber": "AGREEMENT-001",
                "CommitmentLevel": 10.0,
                "IsCustomCommitment": true,
                "Id": 1001,
                "Name": "Agreement 001"
            },
            "Status": 0,
            "HasValidAgreementTerm": true
        },
        {
            "ProductContainer": {
                "Id": 1000,
                "Name": "Product B"
            },
            "Agreement": {
                "AgreementNumber": "AGREEMENT-002",
                "CommitmentLevel": 20.0,
                "IsCustomCommitment": true,
                "Id": 1002,
                "Name": "Agreement 002"
            },
            "Status": 0,
            "HasValidAgreementTerm": true
        },
        {
            "ProductContainer": {
                "Id": 1001,
                "Name": "Product C"
            },
            "Agreement": {
                "AgreementNumber": "AGREEMENT-003",
                "CommitmentLevel": 15.0,
                "IsCustomCommitment": true,
                "Id": 1003,
                "Name": "Agreement 003"
            },
            "Status": 0,
            "HasValidAgreementTerm": true
        }
    ],
    "TotalHits": 3
}

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.