EventsApi.md

EventsApi

All URIs are relative to https://api.clever.com/v2.0

Method	HTTP request	Description
getEvent	GET /events/{id}
getEvents	GET /events

getEvent

EventResponse getEvent(id)

Returns the specific event

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EventsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth
OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
oauth.setAccessToken("YOUR ACCESS TOKEN");

EventsApi apiInstance = new EventsApi();
String id = "id_example"; // String | 
try {
    EventResponse result = apiInstance.getEvent(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventsApi#getEvent");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String

Return type

EventResponse

Authorization

oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getEvents

EventsResponse getEvents(limit, startingAfter, endingBefore, school, recordType)

Returns a list of events

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.EventsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth
OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
oauth.setAccessToken("YOUR ACCESS TOKEN");

EventsApi apiInstance = new EventsApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
String school = "school_example"; // String | 
List<String> recordType = Arrays.asList("recordType_example"); // List<String> | 
try {
    EventsResponse result = apiInstance.getEvents(limit, startingAfter, endingBefore, school, recordType);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventsApi#getEvents");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]
school	String		[optional]
recordType	List<String>		[optional]

Return type

EventsResponse

Authorization

oauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json