clever_client

Serves the Clever Data API

This Python package is automatically generated by the Swagger Codegen project:

• API version: 3.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

Install Azure artifacts keyring to get access to StrongMind pip packages

pip install twine keyring artifacts-keyring

pip install

If the python package is hosted on Github, you can install directly from Github

pip install clever_client --extra-index-url https://pkgs.dev.azure.com/strongmind/Strongmind/_packaging/StrongMindPackages/pypi/simple/

Then import the package:

import clever_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import clever_client

Getting Started

Please follow the installation procedure and then run the following:

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

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

# create an instance of the API class
api_instance = clever_client.CoursesApi(clever_client.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 CoursesApi->get_course: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CoursesApi	get_course	GET /courses/{id}
CoursesApi	get_courses	GET /courses
CoursesApi	get_district_for_course	GET /courses/{id}/district
CoursesApi	get_resources_for_course	GET /courses/{id}/resources
CoursesApi	get_schools_for_course	GET /courses/{id}/schools
CoursesApi	get_sections_for_course	GET /courses/{id}/sections
DistrictsApi	get_district	GET /districts/{id}
DistrictsApi	get_districts	GET /districts
EventsApi	get_event	GET /events/{id}
EventsApi	get_events	GET /events
ResourcesApi	get_courses_for_resource	GET /resources/{id}/courses
ResourcesApi	get_resource	GET /resources/{id}
ResourcesApi	get_resources	GET /resources
ResourcesApi	get_sections_for_resource	GET /resources/{id}/sections
ResourcesApi	get_users_for_resource	GET /resources/{id}/users
SchoolsApi	get_courses_for_school	GET /schools/{id}/courses
SchoolsApi	get_district_for_school	GET /schools/{id}/district
SchoolsApi	get_school	GET /schools/{id}
SchoolsApi	get_schools	GET /schools
SchoolsApi	get_sections_for_school	GET /schools/{id}/sections
SchoolsApi	get_terms_for_school	GET /schools/{id}/terms
SchoolsApi	get_users_for_school	GET /schools/{id}/users
SectionsApi	get_course_for_section	GET /sections/{id}/course
SectionsApi	get_district_for_section	GET /sections/{id}/district
SectionsApi	get_resources_for_section	GET /sections/{id}/resources
SectionsApi	get_school_for_section	GET /sections/{id}/school
SectionsApi	get_section	GET /sections/{id}
SectionsApi	get_sections	GET /sections
SectionsApi	get_term_for_section	GET /sections/{id}/term
SectionsApi	get_users_for_section	GET /sections/{id}/users
TermsApi	get_district_for_term	GET /terms/{id}/district
TermsApi	get_schools_for_term	GET /terms/{id}/schools
TermsApi	get_sections_for_term	GET /terms/{id}/sections
TermsApi	get_term	GET /terms/{id}
TermsApi	get_terms	GET /terms
UsersApi	get_contacts_for_user	GET /users/{id}/mycontacts
UsersApi	get_district_for_user	GET /users/{id}/district
UsersApi	get_resources_for_user	GET /users/{id}/resources
UsersApi	get_schools_for_user	GET /users/{id}/schools
UsersApi	get_sections_for_user	GET /users/{id}/sections
UsersApi	get_students_for_user	GET /users/{id}/mystudents
UsersApi	get_teachers_for_user	GET /users/{id}/myteachers
UsersApi	get_user	GET /users/{id}
UsersApi	get_users	GET /users

Documentation For Models

• BadRequest
• Contact
• Course
• CourseObject
• CourseResponse
• CoursesCreated
• CoursesDeleted
• CoursesResponse
• CoursesUpdated
• Credentials
• District
• DistrictAdmin
• DistrictContact
• DistrictObject
• DistrictResponse
• DistrictsCreated
• DistrictsDeleted
• DistrictsResponse
• DistrictsUpdated
• Event
• EventResponse
• EventResponseWithUri
• EventsResponse
• InternalError
• Link
• Location
• Name
• NotFound
• Principal
• Resource
• ResourceObject
• ResourceResponse
• ResourcesCreated
• ResourcesDeleted
• ResourcesResponse
• ResourcesUpdated
• Roles
• School
• SchoolEnrollment
• SchoolObject
• SchoolResponse
• SchoolsCreated
• SchoolsDeleted
• SchoolsResponse
• SchoolsUpdated
• Section
• SectionObject
• SectionResponse
• SectionsCreated
• SectionsDeleted
• SectionsResponse
• SectionsUpdated
• Staff
• Student
• StudentRelationship
• Teacher
• Term
• TermObject
• TermResponse
• TermsCreated
• TermsDeleted
• TermsResponse
• TermsUpdated
• User
• UserObject
• UserResponse
• UsersCreated
• UsersDeleted
• UsersResponse
• UsersUpdated

Documentation For Authorization

oauth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://clever.com/oauth/authorize
• Scopes: N/A

Author

[email protected]