Get agreement products file¶
Returns a collection of products connected to agreements in excel file.
Prerequisites¶
Credentials as described in Authentication
C#¶
To get products connected to agreement, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.
Next, prepare a filter AgreementProductFilter setting AgreementId.
Finally, call AgreementProducts.Get() method to get products of agreement by passing token and filter.
var filter = new AgreementProductFilter
{
AgreementId = <agreement id> // should be the identifier of the agreement
};
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.AgreementProducts.GetAsExcelFile(token, filter);
Request¶
Request Syntax:
Method |
Request URI |
|---|---|
POST |
https://api.crayon.com/api/v1/agreementproducts/file/xlsx |
Request Body:
Name |
Type |
Description |
|---|---|---|
agreementproductfilter |
Filter products |
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/agreementproducts/"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method downloads the excel file.
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. |
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. |