DataApi.md

clever.DataApi

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

Method	HTTP request	Description
get_contact	GET /contacts/{id}
get_contacts	GET /contacts
get_contacts_for_student	GET /students/{id}/contacts
get_course	GET /courses/{id}
get_course_for_section	GET /sections/{id}/course
get_courses	GET /courses
get_district	GET /districts/{id}
get_district_admin	GET /district_admins/{id}
get_district_admins	GET /district_admins
get_district_for_contact	GET /contacts/{id}/district
get_district_for_course	GET /courses/{id}/district
get_district_for_district_admin	GET /district_admins/{id}/district
get_district_for_school	GET /schools/{id}/district
get_district_for_school_admin	GET /school_admins/{id}/district
get_district_for_section	GET /sections/{id}/district
get_district_for_student	GET /students/{id}/district
get_district_for_teacher	GET /teachers/{id}/district
get_district_for_term	GET /terms/{id}/district
get_districts	GET /districts
get_school	GET /schools/{id}
get_school_admin	GET /school_admins/{id}
get_school_admins	GET /school_admins
get_school_for_section	GET /sections/{id}/school
get_school_for_student	GET /students/{id}/school
get_school_for_teacher	GET /teachers/{id}/school
get_schools	GET /schools
get_schools_for_school_admin	GET /school_admins/{id}/schools
get_schools_for_student	GET /students/{id}/schools
get_schools_for_teacher	GET /teachers/{id}/schools
get_section	GET /sections/{id}
get_sections	GET /sections
get_sections_for_course	GET /courses/{id}/sections
get_sections_for_school	GET /schools/{id}/sections
get_sections_for_student	GET /students/{id}/sections
get_sections_for_teacher	GET /teachers/{id}/sections
get_sections_for_term	GET /terms/{id}/sections
get_student	GET /students/{id}
get_students	GET /students
get_students_for_contact	GET /contacts/{id}/students
get_students_for_school	GET /schools/{id}/students
get_students_for_section	GET /sections/{id}/students
get_students_for_teacher	GET /teachers/{id}/students
get_teacher	GET /teachers/{id}
get_teacher_for_section	GET /sections/{id}/teacher
get_teachers	GET /teachers
get_teachers_for_school	GET /schools/{id}/teachers
get_teachers_for_section	GET /sections/{id}/teachers
get_teachers_for_student	GET /students/{id}/teachers
get_term	GET /terms/{id}
get_term_for_section	GET /sections/{id}/term
get_terms	GET /terms

get_contact

ContactResponse get_contact(id)

Returns a specific student contact

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_contact(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_contact: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ContactResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contacts

ContactsResponse get_contacts(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of student contacts

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_contacts(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_contacts: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

ContactsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contacts_for_student

ContactsResponse get_contacts_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the contacts for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_contacts_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_contacts_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

ContactsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_course

CourseResponse get_course(id)

Returns a specific course

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_course(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_course: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

CourseResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_course_for_section

CourseResponse get_course_for_section(id)

Returns the course for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_course_for_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_course_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

CourseResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_courses

CoursesResponse get_courses(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of courses

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_courses(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_courses: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

CoursesResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district

DistrictResponse get_district(id)

Returns a specific district

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_admin

DistrictAdminResponse get_district_admin(id)

Returns a specific district admin

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_admin(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_admin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictAdminResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_admins

DistrictAdminsResponse get_district_admins(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of district admins

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_district_admins(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_admins: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

DistrictAdminsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_contact

DistrictResponse get_district_for_contact(id)

Returns the district for a student contact

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_contact(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_contact: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_course

DistrictResponse get_district_for_course(id)

Returns the district for a course

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_course(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_course: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_district_admin

DistrictResponse get_district_for_district_admin(id)

Returns the district for a district admin

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_district_admin(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_district_admin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_school

DistrictResponse get_district_for_school(id)

Returns the district for a school

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_school(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_school: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_school_admin

DistrictResponse get_district_for_school_admin(id)

Returns the district for a school admin

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_school_admin(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_school_admin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_section

DistrictResponse get_district_for_section(id)

Returns the district for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_student

DistrictResponse get_district_for_student(id)

Returns the district for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_student(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_teacher

DistrictResponse get_district_for_teacher(id)

Returns the district for a teacher

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_teacher(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_district_for_term

DistrictResponse get_district_for_term(id)

Returns the district for a term

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_district_for_term(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_district_for_term: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

DistrictResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_districts

DistrictsResponse get_districts()

Returns a list of districts

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))

try: 
    api_response = api_instance.get_districts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_districts: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DistrictsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school

SchoolResponse get_school(id)

Returns a specific school

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_school(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school_admin

SchoolAdminResponse get_school_admin(id)

Returns a specific school admin

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_school_admin(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school_admin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SchoolAdminResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school_admins

SchoolAdminsResponse get_school_admins(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of school admins

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_school_admins(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school_admins: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SchoolAdminsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school_for_section

SchoolResponse get_school_for_section(id)

Returns the school for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_school_for_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school_for_student

SchoolResponse get_school_for_student(id)

Returns the primary school for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_school_for_student(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_school_for_teacher

SchoolResponse get_school_for_teacher(id)

Retrieves school info for a teacher.

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_school_for_teacher(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_school_for_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SchoolResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_schools

SchoolsResponse get_schools(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of schools

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_schools(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_schools: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_schools_for_school_admin

SchoolsResponse get_schools_for_school_admin(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the schools for a school admin

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_schools_for_school_admin(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_schools_for_school_admin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_schools_for_student

SchoolsResponse get_schools_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the schools for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_schools_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_schools_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_schools_for_teacher

SchoolsResponse get_schools_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the schools for a teacher

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_schools_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_schools_for_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SchoolsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_section

SectionResponse get_section(id)

Returns a specific section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SectionResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections

SectionsResponse get_sections(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of sections

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections_for_course

SectionsResponse get_sections_for_course(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the sections for a Courses

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections_for_course(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections_for_course: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections_for_school

SectionsResponse get_sections_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the sections for a school

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections_for_school: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections_for_student

SectionsResponse get_sections_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the sections for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections_for_teacher

SectionsResponse get_sections_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the sections for a teacher

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections_for_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sections_for_term

SectionsResponse get_sections_for_term(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the sections for a term

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_sections_for_term(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_sections_for_term: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

SectionsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_student

StudentResponse get_student(id)

Returns a specific student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_student(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

StudentResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_students

StudentsResponse get_students(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of students

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_students(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_students: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_students_for_contact

StudentsResponse get_students_for_contact(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the students for a student contact

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_students_for_contact(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_students_for_contact: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_students_for_school

StudentsResponse get_students_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the students for a school

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_students_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_students_for_school: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_students_for_section

StudentsResponse get_students_for_section(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the students for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_students_for_section(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_students_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_students_for_teacher

StudentsResponse get_students_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the students for a teacher

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_students_for_teacher(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_students_for_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

StudentsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teacher

TeacherResponse get_teacher(id)

Returns a specific teacher

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_teacher(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teacher: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

TeacherResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teacher_for_section

TeacherResponse get_teacher_for_section(id)

Returns the primary teacher for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_teacher_for_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teacher_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

TeacherResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teachers

TeachersResponse get_teachers(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of teachers

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_teachers(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teachers: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teachers_for_school

TeachersResponse get_teachers_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the teachers for a school

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_teachers_for_school(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teachers_for_school: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teachers_for_section

TeachersResponse get_teachers_for_section(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the teachers for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_teachers_for_section(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teachers_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_teachers_for_student

TeachersResponse get_teachers_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns the teachers for a student

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_teachers_for_student(id, limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_teachers_for_student: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

TeachersResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_term

TermResponse get_term(id)

Returns a specific term

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_term(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_term: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

TermResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_term_for_section

TermResponse get_term_for_section(id)

Returns the term for a section

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
id = 'id_example' # str | 

try: 
    api_response = api_instance.get_term_for_section(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_term_for_section: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

TermResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_terms

TermsResponse get_terms(limit=limit, starting_after=starting_after, ending_before=ending_before)

Returns a list of terms

Example

from __future__ import print_function
import time
import clever
from clever.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = clever.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = clever.DataApi(clever.ApiClient(configuration))
limit = 56 # int |  (optional)
starting_after = 'starting_after_example' # str |  (optional)
ending_before = 'ending_before_example' # str |  (optional)

try: 
    api_response = api_instance.get_terms(limit=limit, starting_after=starting_after, ending_before=ending_before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->get_terms: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional]
starting_after	str		[optional]
ending_before	str		[optional]

Return type

TermsResponse

Authorization

oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]