Get consented agreements for customer tenant

Returns a collection of consented end customer agreements. Consented end customer agreements is either existing and thus the end customer have consented to the type of agreement, or it is empty, and thus not yet consented.

Prerequisites

  • Credentials as described in Authentication
  • A customer tenant identifier

C#

To get customer tenant agreements, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call CustomerTenants.GetAgreements() method to get customer tenant agreements by passing a token, the customer tenant id and a customer tenant agreement filter.

var id = <customer tenant identifier>;
var customerTenantAgreementFilter = new CustomerTenantAgreementFilter {AgreementTypeConsent = AgreementTypeConsent.MicrosoftCustomerAgreement};
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.CustomerTenants.GetAgreements(token, id, customerTenantAgreementFilter);

Request

Request Syntax:

Method Request URI
GET https://api.crayon.com/api/v1/customertenants/{id}/agreements?AgreementTypeConsent=1

Request Parameters:

Name Type Description
id int Identifier for customer tenant.
agreementTypeConsent int 0=MicrosoftCloudAgreement, 1=MicrosoftCustomerAgreement.

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/customertenants/{id}/agreements?AgreementTypeConsent=1"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response

If successful, this method returns a collection of CustomerTenantAgreement resource in the response body.

{
  "Items": [
      {
        "FirstName": "Firstname",
        "LastName": "Lastname",
        "PhoneNumber": "000-12345689",
        "Email": "firstname.lastname@email.com",
        "DateAgreed": "2019-10-01T00:00:00Z",
        "AgreementType": 1
      }
  ],
  "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.