# Clever::DataApi All URIs are relative to *https://api.clever.com/v2.1* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} | [**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts | [**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts | [**get_course**](DataApi.md#get_course) | **GET** /courses/{id} | [**get_course_for_section**](DataApi.md#get_course_for_section) | **GET** /sections/{id}/course | [**get_courses**](DataApi.md#get_courses) | **GET** /courses | [**get_district**](DataApi.md#get_district) | **GET** /districts/{id} | [**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} | [**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins | [**get_district_for_contact**](DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district | [**get_district_for_course**](DataApi.md#get_district_for_course) | **GET** /courses/{id}/district | [**get_district_for_district_admin**](DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district | [**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district | [**get_district_for_school_admin**](DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district | [**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district | [**get_district_for_student**](DataApi.md#get_district_for_student) | **GET** /students/{id}/district | [**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district | [**get_district_for_term**](DataApi.md#get_district_for_term) | **GET** /terms/{id}/district | [**get_districts**](DataApi.md#get_districts) | **GET** /districts | [**get_school**](DataApi.md#get_school) | **GET** /schools/{id} | [**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} | [**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins | [**get_school_for_section**](DataApi.md#get_school_for_section) | **GET** /sections/{id}/school | [**get_school_for_student**](DataApi.md#get_school_for_student) | **GET** /students/{id}/school | [**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school | [**get_schools**](DataApi.md#get_schools) | **GET** /schools | [**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools | [**get_schools_for_student**](DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools | [**get_schools_for_teacher**](DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools | [**get_section**](DataApi.md#get_section) | **GET** /sections/{id} | [**get_sections**](DataApi.md#get_sections) | **GET** /sections | [**get_sections_for_course**](DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections | [**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections | [**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections | [**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections | [**get_sections_for_term**](DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections | [**get_student**](DataApi.md#get_student) | **GET** /students/{id} | [**get_students**](DataApi.md#get_students) | **GET** /students | [**get_students_for_contact**](DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students | [**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students | [**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students | [**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students | [**get_teacher**](DataApi.md#get_teacher) | **GET** /teachers/{id} | [**get_teacher_for_section**](DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher | [**get_teachers**](DataApi.md#get_teachers) | **GET** /teachers | [**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers | [**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers | [**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers | [**get_term**](DataApi.md#get_term) | **GET** /terms/{id} | [**get_term_for_section**](DataApi.md#get_term_for_section) | **GET** /sections/{id}/term | [**get_terms**](DataApi.md#get_terms) | **GET** /terms | # **get_contact** > ContactResponse get_contact(id) Returns a specific student contact ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_contact(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_contact: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**ContactResponse**](ContactResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_contacts** > ContactsResponse get_contacts(opts) Returns a list of student contacts ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_contacts(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_contacts: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**ContactsResponse**](ContactsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_contacts_for_student** > ContactsResponse get_contacts_for_student(id, opts) Returns the contacts for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_contacts_for_student(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_contacts_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**ContactsResponse**](ContactsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_course** > CourseResponse get_course(id) Returns a specific course ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_course(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_course: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**CourseResponse**](CourseResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_course_for_section** > CourseResponse get_course_for_section(id) Returns the course for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_course_for_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_course_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**CourseResponse**](CourseResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_courses** > CoursesResponse get_courses(opts) Returns a list of courses ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_courses(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_courses: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**CoursesResponse**](CoursesResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district** > DistrictResponse get_district(id) Returns a specific district ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_admin** > DistrictAdminResponse get_district_admin(id) Returns a specific district admin ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_admin(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_admin: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictAdminResponse**](DistrictAdminResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_admins** > DistrictAdminsResponse get_district_admins(opts) Returns a list of district admins ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_district_admins(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_admins: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**DistrictAdminsResponse**](DistrictAdminsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_contact** > DistrictResponse get_district_for_contact(id) Returns the district for a student contact ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_contact(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_contact: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_course** > DistrictResponse get_district_for_course(id) Returns the district for a course ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_course(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_course: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_district_admin** > DistrictResponse get_district_for_district_admin(id) Returns the district for a district admin ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_district_admin(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_district_admin: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_school** > DistrictResponse get_district_for_school(id) Returns the district for a school ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_school(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_school: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_school_admin** > DistrictResponse get_district_for_school_admin(id) Returns the district for a school admin ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_school_admin(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_school_admin: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_section** > DistrictResponse get_district_for_section(id) Returns the district for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_student** > DistrictResponse get_district_for_student(id) Returns the district for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_student(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_teacher** > DistrictResponse get_district_for_teacher(id) Returns the district for a teacher ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_teacher(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_district_for_term** > DistrictResponse get_district_for_term(id) Returns the district for a term ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_district_for_term(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_district_for_term: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**DistrictResponse**](DistrictResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_districts** > DistrictsResponse get_districts(opts) Returns a list of districts ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { count: 'count_example' # String | } begin result = api_instance.get_districts(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_districts: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **count** | **String**| | [optional] ### Return type [**DistrictsResponse**](DistrictsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school** > SchoolResponse get_school(id) Returns a specific school ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_school(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SchoolResponse**](SchoolResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school_admin** > SchoolAdminResponse get_school_admin(id) Returns a specific school admin ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_school_admin(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school_admin: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SchoolAdminResponse**](SchoolAdminResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school_admins** > SchoolAdminsResponse get_school_admins(opts) Returns a list of school admins ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_school_admins(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school_admins: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**SchoolAdminsResponse**](SchoolAdminsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school_for_section** > SchoolResponse get_school_for_section(id) Returns the school for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_school_for_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SchoolResponse**](SchoolResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school_for_student** > SchoolResponse get_school_for_student(id) Returns the primary school for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_school_for_student(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SchoolResponse**](SchoolResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_school_for_teacher** > SchoolResponse get_school_for_teacher(id) Retrieves school info for a teacher. ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_school_for_teacher(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_school_for_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SchoolResponse**](SchoolResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_schools** > SchoolsResponse get_schools(opts) Returns a list of schools ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_schools(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_schools: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**SchoolsResponse**](SchoolsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_schools_for_school_admin** > SchoolsResponse get_schools_for_school_admin(id, opts) Returns the schools for a school admin ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_schools_for_school_admin(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SchoolsResponse**](SchoolsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_schools_for_student** > SchoolsResponse get_schools_for_student(id, opts) Returns the schools for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_schools_for_student(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_schools_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SchoolsResponse**](SchoolsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_schools_for_teacher** > SchoolsResponse get_schools_for_teacher(id, opts) Returns the schools for a teacher ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_schools_for_teacher(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_schools_for_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SchoolsResponse**](SchoolsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_section** > SectionResponse get_section(id) Returns a specific section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**SectionResponse**](SectionResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections** > SectionsResponse get_sections(opts) Returns a list of sections ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_sections(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections_for_course** > SectionsResponse get_sections_for_course(id, opts) Returns the sections for a Courses ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_sections_for_course(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections_for_course: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections_for_school** > SectionsResponse get_sections_for_school(id, opts) Returns the sections for a school ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_sections_for_school(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections_for_school: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections_for_student** > SectionsResponse get_sections_for_student(id, opts) Returns the sections for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_sections_for_student(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections_for_teacher** > SectionsResponse get_sections_for_teacher(id, opts) Returns the sections for a teacher ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_sections_for_teacher(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections_for_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_sections_for_term** > SectionsResponse get_sections_for_term(id, opts) Returns the sections for a term ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_sections_for_term(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_sections_for_term: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**SectionsResponse**](SectionsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_student** > StudentResponse get_student(id) Returns a specific student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_student(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**StudentResponse**](StudentResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_students** > StudentsResponse get_students(opts) Returns a list of students ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_students(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_students: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**StudentsResponse**](StudentsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_students_for_contact** > StudentsResponse get_students_for_contact(id, opts) Returns the students for a student contact ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_students_for_contact(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_students_for_contact: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**StudentsResponse**](StudentsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_students_for_school** > StudentsResponse get_students_for_school(id, opts) Returns the students for a school ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_students_for_school(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_students_for_school: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**StudentsResponse**](StudentsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_students_for_section** > StudentsResponse get_students_for_section(id, opts) Returns the students for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_students_for_section(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_students_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**StudentsResponse**](StudentsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_students_for_teacher** > StudentsResponse get_students_for_teacher(id, opts) Returns the students for a teacher ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_students_for_teacher(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_students_for_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**StudentsResponse**](StudentsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teacher** > TeacherResponse get_teacher(id) Returns a specific teacher ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_teacher(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teacher: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**TeacherResponse**](TeacherResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teacher_for_section** > TeacherResponse get_teacher_for_section(id) Returns the primary teacher for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_teacher_for_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teacher_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**TeacherResponse**](TeacherResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teachers** > TeachersResponse get_teachers(opts) Returns a list of teachers ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_teachers(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teachers: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**TeachersResponse**](TeachersResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teachers_for_school** > TeachersResponse get_teachers_for_school(id, opts) Returns the teachers for a school ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_teachers_for_school(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teachers_for_school: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**TeachersResponse**](TeachersResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teachers_for_section** > TeachersResponse get_teachers_for_section(id, opts) Returns the teachers for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_teachers_for_section(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teachers_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**TeachersResponse**](TeachersResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_teachers_for_student** > TeachersResponse get_teachers_for_student(id, opts) Returns the teachers for a student ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example' # String | } begin result = api_instance.get_teachers_for_student(id, opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_teachers_for_student: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] ### Return type [**TeachersResponse**](TeachersResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_term** > TermResponse get_term(id) Returns a specific term ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_term(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_term: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**TermResponse**](TermResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_term_for_section** > TermResponse get_term_for_section(id) Returns the term for a section ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new id = 'id_example' # String | begin result = api_instance.get_term_for_section(id) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_term_for_section: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**TermResponse**](TermResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **get_terms** > TermsResponse get_terms(opts) Returns a list of terms ### Example ```ruby # load the gem require 'clever-ruby' # setup authorization Clever.configure do |config| # Configure OAuth2 access token for authorization: oauth config.access_token = 'YOUR ACCESS TOKEN' end api_instance = Clever::DataApi.new opts = { limit: 56, # Integer | starting_after: 'starting_after_example', # String | ending_before: 'ending_before_example', # String | count: 'count_example' # String | } begin result = api_instance.get_terms(opts) p result rescue Clever::ApiError => e puts "Exception when calling DataApi->get_terms: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| | [optional] **starting_after** | **String**| | [optional] **ending_before** | **String**| | [optional] **count** | **String**| | [optional] ### Return type [**TermsResponse**](TermsResponse.md) ### Authorization [oauth](../README.md#oauth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json