Get agreements¶
Returns a collection of agreements
Prerequisites¶
- Credentials as described in Authentication
C#¶
To get agreements, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.
Then call Agreements.Get() method to get agreements by passing token.
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.Agreements.Get(token);
Request¶
Request Syntax:
Method | Request URI |
---|---|
GET | https://api.crayon.com/api/v1/agreements/ |
Request Parameters:
Name | Type | Required |
---|---|---|
organizationId | int | No |
publisherId | int | No |
publisherIds | List<int> | No |
agreementIds | List<int> | No |
page | int | No |
pageSize | int | No |
search | string | No |
isTrial | bool | No |
status | AgreementStatus | No |
agreementTypes | List<AgreementType> | No |
searchDate | DateTimeOffset | No |
priceListIds | List<int> | No |
salesPriceCurrency | string | No |
termRequired | bool | No |
endDateFrom | DateTimeOffset | No |
endDateTo | DateTimeOffset | No |
searchDate | DateTimeOffset | No |
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:
GET $"https://api.crayon.com/api/v1/agreements/"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a collection of agreements in the response body.
{
"Items": [
{
"Id": 1,
"Organization": {
"Id": 3869,
"Name": "My company AB"
},
"Name": "My agreement",
"SalesPriceCurrencyCode": "EUR",
"StartDate": "2009-12-22T19:21:04.8964818Z",
"EndDate": "2018-12-22T19:21:04.8964818Z",
"Disabled": false,
"Publisher": {
"Id": 2,
"Name": "Microsoft"
},
"Program": {
"Id": 3,
"Name": "SPLA"
},
"Number": "111111",
"CustomerNumber": "123456",
"MasterAgreement": "654321",
"HasTerms": false
}
],
"TotalHits": 1
}
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. |