DataApi.md

DataApi

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

Method	HTTP request	Description
getContact	GET /contacts/{id}
getContacts	GET /contacts
getContactsForStudent	GET /students/{id}/contacts
getCourse	GET /courses/{id}
getCourseForSection	GET /sections/{id}/course
getCourses	GET /courses
getDistrict	GET /districts/{id}
getDistrictAdmin	GET /district_admins/{id}
getDistrictAdmins	GET /district_admins
getDistrictForContact	GET /contacts/{id}/district
getDistrictForCourse	GET /courses/{id}/district
getDistrictForDistrictAdmin	GET /district_admins/{id}/district
getDistrictForSchool	GET /schools/{id}/district
getDistrictForSchoolAdmin	GET /school_admins/{id}/district
getDistrictForSection	GET /sections/{id}/district
getDistrictForStudent	GET /students/{id}/district
getDistrictForTeacher	GET /teachers/{id}/district
getDistrictForTerm	GET /terms/{id}/district
getDistricts	GET /districts
getSchool	GET /schools/{id}
getSchoolAdmin	GET /school_admins/{id}
getSchoolAdmins	GET /school_admins
getSchoolForSection	GET /sections/{id}/school
getSchoolForStudent	GET /students/{id}/school
getSchoolForTeacher	GET /teachers/{id}/school
getSchools	GET /schools
getSchoolsForSchoolAdmin	GET /school_admins/{id}/schools
getSchoolsForStudent	GET /students/{id}/schools
getSchoolsForTeacher	GET /teachers/{id}/schools
getSection	GET /sections/{id}
getSections	GET /sections
getSectionsForCourse	GET /courses/{id}/sections
getSectionsForSchool	GET /schools/{id}/sections
getSectionsForStudent	GET /students/{id}/sections
getSectionsForTeacher	GET /teachers/{id}/sections
getSectionsForTerm	GET /terms/{id}/sections
getStudent	GET /students/{id}
getStudents	GET /students
getStudentsForContact	GET /contacts/{id}/students
getStudentsForSchool	GET /schools/{id}/students
getStudentsForSection	GET /sections/{id}/students
getStudentsForTeacher	GET /teachers/{id}/students
getTeacher	GET /teachers/{id}
getTeacherForSection	GET /sections/{id}/teacher
getTeachers	GET /teachers
getTeachersForSchool	GET /schools/{id}/teachers
getTeachersForSection	GET /sections/{id}/teachers
getTeachersForStudent	GET /students/{id}/teachers
getTerm	GET /terms/{id}
getTermForSection	GET /sections/{id}/term
getTerms	GET /terms

getContact

ContactResponse getContact(id)

Returns a specific student contact

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

ContactResponse

Authorization

oauth

HTTP request headers

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

getContacts

ContactsResponse getContacts(limit, startingAfter, endingBefore)

Returns a list of student contacts

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    ContactsResponse result = apiInstance.getContacts(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getContacts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

ContactsResponse

Authorization

oauth

HTTP request headers

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

getContactsForStudent

ContactsResponse getContactsForStudent(id, limit, startingAfter, endingBefore)

Returns the contacts for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    ContactsResponse result = apiInstance.getContactsForStudent(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getContactsForStudent");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

ContactsResponse

Authorization

oauth

HTTP request headers

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

getCourse

CourseResponse getCourse(id)

Returns a specific course

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

CourseResponse

Authorization

oauth

HTTP request headers

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

getCourseForSection

CourseResponse getCourseForSection(id)

Returns the course for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

CourseResponse

Authorization

oauth

HTTP request headers

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

getCourses

CoursesResponse getCourses(limit, startingAfter, endingBefore)

Returns a list of courses

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    CoursesResponse result = apiInstance.getCourses(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getCourses");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

CoursesResponse

Authorization

oauth

HTTP request headers

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

getDistrict

DistrictResponse getDistrict(id)

Returns a specific district

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictAdmin

DistrictAdminResponse getDistrictAdmin(id)

Returns a specific district admin

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictAdminResponse

Authorization

oauth

HTTP request headers

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

getDistrictAdmins

DistrictAdminsResponse getDistrictAdmins(limit, startingAfter, endingBefore)

Returns a list of district admins

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    DistrictAdminsResponse result = apiInstance.getDistrictAdmins(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getDistrictAdmins");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

DistrictAdminsResponse

Authorization

oauth

HTTP request headers

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

getDistrictForContact

DistrictResponse getDistrictForContact(id)

Returns the district for a student contact

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForCourse

DistrictResponse getDistrictForCourse(id)

Returns the district for a course

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForDistrictAdmin

DistrictResponse getDistrictForDistrictAdmin(id)

Returns the district for a district admin

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForSchool

DistrictResponse getDistrictForSchool(id)

Returns the district for a school

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForSchoolAdmin

DistrictResponse getDistrictForSchoolAdmin(id)

Returns the district for a school admin

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForSection

DistrictResponse getDistrictForSection(id)

Returns the district for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForStudent

DistrictResponse getDistrictForStudent(id)

Returns the district for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForTeacher

DistrictResponse getDistrictForTeacher(id)

Returns the district for a teacher

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistrictForTerm

DistrictResponse getDistrictForTerm(id)

Returns the district for a term

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

getDistricts

DistrictsResponse getDistricts()

Returns a list of districts

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
try {
    DistrictsResponse result = apiInstance.getDistricts();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getDistricts");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

DistrictsResponse

Authorization

oauth

HTTP request headers

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

getSchool

SchoolResponse getSchool(id)

Returns a specific school

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

getSchoolAdmin

SchoolAdminResponse getSchoolAdmin(id)

Returns a specific school admin

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SchoolAdminResponse

Authorization

oauth

HTTP request headers

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

getSchoolAdmins

SchoolAdminsResponse getSchoolAdmins(limit, startingAfter, endingBefore)

Returns a list of school admins

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SchoolAdminsResponse result = apiInstance.getSchoolAdmins(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSchoolAdmins");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SchoolAdminsResponse

Authorization

oauth

HTTP request headers

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

getSchoolForSection

SchoolResponse getSchoolForSection(id)

Returns the school for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

getSchoolForStudent

SchoolResponse getSchoolForStudent(id)

Returns the primary school for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

getSchoolForTeacher

SchoolResponse getSchoolForTeacher(id)

Retrieves school info for a teacher.

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

getSchools

SchoolsResponse getSchools(limit, startingAfter, endingBefore)

Returns a list of schools

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SchoolsResponse result = apiInstance.getSchools(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSchools");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

getSchoolsForSchoolAdmin

SchoolsResponse getSchoolsForSchoolAdmin(id, limit, startingAfter, endingBefore)

Returns the schools for a school admin

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SchoolsResponse result = apiInstance.getSchoolsForSchoolAdmin(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSchoolsForSchoolAdmin");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

getSchoolsForStudent

SchoolsResponse getSchoolsForStudent(id, limit, startingAfter, endingBefore)

Returns the schools for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SchoolsResponse result = apiInstance.getSchoolsForStudent(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSchoolsForStudent");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

getSchoolsForTeacher

SchoolsResponse getSchoolsForTeacher(id, limit, startingAfter, endingBefore)

Returns the schools for a teacher

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SchoolsResponse result = apiInstance.getSchoolsForTeacher(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSchoolsForTeacher");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

getSection

SectionResponse getSection(id)

Returns a specific section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

SectionResponse

Authorization

oauth

HTTP request headers

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

getSections

SectionsResponse getSections(limit, startingAfter, endingBefore)

Returns a list of sections

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSections(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSections");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getSectionsForCourse

SectionsResponse getSectionsForCourse(id, limit, startingAfter, endingBefore)

Returns the sections for a Courses

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSectionsForCourse(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSectionsForCourse");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getSectionsForSchool

SectionsResponse getSectionsForSchool(id, limit, startingAfter, endingBefore)

Returns the sections for a school

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSectionsForSchool(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSectionsForSchool");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getSectionsForStudent

SectionsResponse getSectionsForStudent(id, limit, startingAfter, endingBefore)

Returns the sections for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSectionsForStudent(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSectionsForStudent");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getSectionsForTeacher

SectionsResponse getSectionsForTeacher(id, limit, startingAfter, endingBefore)

Returns the sections for a teacher

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSectionsForTeacher(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSectionsForTeacher");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getSectionsForTerm

SectionsResponse getSectionsForTerm(id, limit, startingAfter, endingBefore)

Returns the sections for a term

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    SectionsResponse result = apiInstance.getSectionsForTerm(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getSectionsForTerm");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

getStudent

StudentResponse getStudent(id)

Returns a specific student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

StudentResponse

Authorization

oauth

HTTP request headers

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

getStudents

StudentsResponse getStudents(limit, startingAfter, endingBefore)

Returns a list of students

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    StudentsResponse result = apiInstance.getStudents(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getStudents");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

getStudentsForContact

StudentsResponse getStudentsForContact(id, limit, startingAfter, endingBefore)

Returns the students for a student contact

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    StudentsResponse result = apiInstance.getStudentsForContact(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getStudentsForContact");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

getStudentsForSchool

StudentsResponse getStudentsForSchool(id, limit, startingAfter, endingBefore)

Returns the students for a school

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    StudentsResponse result = apiInstance.getStudentsForSchool(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getStudentsForSchool");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

getStudentsForSection

StudentsResponse getStudentsForSection(id, limit, startingAfter, endingBefore)

Returns the students for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    StudentsResponse result = apiInstance.getStudentsForSection(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getStudentsForSection");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

getStudentsForTeacher

StudentsResponse getStudentsForTeacher(id, limit, startingAfter, endingBefore)

Returns the students for a teacher

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    StudentsResponse result = apiInstance.getStudentsForTeacher(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getStudentsForTeacher");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

getTeacher

TeacherResponse getTeacher(id)

Returns a specific teacher

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

TeacherResponse

Authorization

oauth

HTTP request headers

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

getTeacherForSection

TeacherResponse getTeacherForSection(id)

Returns the primary teacher for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

TeacherResponse

Authorization

oauth

HTTP request headers

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

getTeachers

TeachersResponse getTeachers(limit, startingAfter, endingBefore)

Returns a list of teachers

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    TeachersResponse result = apiInstance.getTeachers(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getTeachers");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

getTeachersForSchool

TeachersResponse getTeachersForSchool(id, limit, startingAfter, endingBefore)

Returns the teachers for a school

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    TeachersResponse result = apiInstance.getTeachersForSchool(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getTeachersForSchool");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

getTeachersForSection

TeachersResponse getTeachersForSection(id, limit, startingAfter, endingBefore)

Returns the teachers for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    TeachersResponse result = apiInstance.getTeachersForSection(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getTeachersForSection");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

getTeachersForStudent

TeachersResponse getTeachersForStudent(id, limit, startingAfter, endingBefore)

Returns the teachers for a student

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
String id = "id_example"; // String | 
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    TeachersResponse result = apiInstance.getTeachersForStudent(id, limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getTeachersForStudent");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

getTerm

TermResponse getTerm(id)

Returns a specific term

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

TermResponse

Authorization

oauth

HTTP request headers

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

getTermForSection

TermResponse getTermForSection(id)

Returns the term for a section

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

TermResponse

Authorization

oauth

HTTP request headers

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

getTerms

TermsResponse getTerms(limit, startingAfter, endingBefore)

Returns a list of terms

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.DataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DataApi apiInstance = new DataApi();
Integer limit = 56; // Integer | 
String startingAfter = "startingAfter_example"; // String | 
String endingBefore = "endingBefore_example"; // String | 
try {
    TermsResponse result = apiInstance.getTerms(limit, startingAfter, endingBefore);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DataApi#getTerms");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer		[optional]
startingAfter	String		[optional]
endingBefore	String		[optional]

Return type

TermsResponse

Authorization

oauth

HTTP request headers

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