Skip to content
This repository was archived by the owner on Jun 24, 2022. It is now read-only.

Files

Latest commit

author
Joshua Lawrence
Adjusting object instantiation documentation
Aug 31, 2018
0a4b0d6 · Aug 31, 2018

History

History
2685 lines (1764 loc) · 69.1 KB

DataApi.md

File metadata and controls

2685 lines (1764 loc) · 69.1 KB

Clever\DataApi

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

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

getContact

\Clever\Model\ContactResponse getContact($id)

Returns a specific student contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getContact($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getContact: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getContacts

\Clever\Model\ContactsResponse getContacts($limit, $starting_after, $ending_before)

Returns a list of student contacts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getContacts($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getContacts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getContactsForStudent

\Clever\Model\ContactsResponse getContactsForStudent($id, $limit, $starting_after, $ending_before)

Returns the contacts for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getContactsForStudent($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getContactsForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getCourse

\Clever\Model\CourseResponse getCourse($id)

Returns a specific course

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getCourse($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getCourse: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getCourseForSection

\Clever\Model\CourseResponse getCourseForSection($id)

Returns the course for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getCourseForSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getCourseForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getCourses

\Clever\Model\CoursesResponse getCourses($limit, $starting_after, $ending_before)

Returns a list of courses

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getCourses($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getCourses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getDistrict

\Clever\Model\DistrictResponse getDistrict($id)

Returns a specific district

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrict($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrict: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictAdmin

\Clever\Model\DistrictAdminResponse getDistrictAdmin($id)

Returns a specific district admin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictAdmin($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictAdmins

\Clever\Model\DistrictAdminsResponse getDistrictAdmins($limit, $starting_after, $ending_before)

Returns a list of district admins

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getDistrictAdmins($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictAdmins: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getDistrictForContact

\Clever\Model\DistrictResponse getDistrictForContact($id)

Returns the district for a student contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForContact($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForContact: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForCourse

\Clever\Model\DistrictResponse getDistrictForCourse($id)

Returns the district for a course

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForCourse($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForCourse: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForDistrictAdmin

\Clever\Model\DistrictResponse getDistrictForDistrictAdmin($id)

Returns the district for a district admin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForDistrictAdmin($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForDistrictAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForSchool

\Clever\Model\DistrictResponse getDistrictForSchool($id)

Returns the district for a school

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForSchool($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForSchool: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForSchoolAdmin

\Clever\Model\DistrictResponse getDistrictForSchoolAdmin($id)

Returns the district for a school admin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForSchoolAdmin($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForSchoolAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForSection

\Clever\Model\DistrictResponse getDistrictForSection($id)

Returns the district for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForStudent

\Clever\Model\DistrictResponse getDistrictForStudent($id)

Returns the district for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForStudent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForTeacher

\Clever\Model\DistrictResponse getDistrictForTeacher($id)

Returns the district for a teacher

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForTeacher($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistrictForTerm

\Clever\Model\DistrictResponse getDistrictForTerm($id)

Returns the district for a term

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getDistrictForTerm($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistrictForTerm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getDistricts

\Clever\Model\DistrictsResponse getDistricts()

Returns a list of districts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');


try {
    $result = $api_instance->getDistricts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDistricts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Clever\Model\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]

getSchool

\Clever\Model\SchoolResponse getSchool($id)

Returns a specific school

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSchool($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchool: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSchoolAdmin

\Clever\Model\SchoolAdminResponse getSchoolAdmin($id)

Returns a specific school admin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSchoolAdmin($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSchoolAdmins

\Clever\Model\SchoolAdminsResponse getSchoolAdmins($limit, $starting_after, $ending_before)

Returns a list of school admins

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSchoolAdmins($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolAdmins: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSchoolForSection

\Clever\Model\SchoolResponse getSchoolForSection($id)

Returns the school for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSchoolForSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSchoolForStudent

\Clever\Model\SchoolResponse getSchoolForStudent($id)

Returns the primary school for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSchoolForStudent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSchoolForTeacher

\Clever\Model\SchoolResponse getSchoolForTeacher($id)

Retrieves school info for a teacher.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSchoolForTeacher($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolForTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSchools

\Clever\Model\SchoolsResponse getSchools($limit, $starting_after, $ending_before)

Returns a list of schools

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSchools($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchools: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSchoolsForSchoolAdmin

\Clever\Model\SchoolsResponse getSchoolsForSchoolAdmin($id, $limit, $starting_after, $ending_before)

Returns the schools for a school admin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSchoolsForSchoolAdmin($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolsForSchoolAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSchoolsForStudent

\Clever\Model\SchoolsResponse getSchoolsForStudent($id, $limit, $starting_after, $ending_before)

Returns the schools for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSchoolsForStudent($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolsForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSchoolsForTeacher

\Clever\Model\SchoolsResponse getSchoolsForTeacher($id, $limit, $starting_after, $ending_before)

Returns the schools for a teacher

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSchoolsForTeacher($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSchoolsForTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSection

\Clever\Model\SectionResponse getSection($id)

Returns a specific section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getSections

\Clever\Model\SectionsResponse getSections($limit, $starting_after, $ending_before)

Returns a list of sections

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSections($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSections: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSectionsForCourse

\Clever\Model\SectionsResponse getSectionsForCourse($id, $limit, $starting_after, $ending_before)

Returns the sections for a Courses

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSectionsForCourse($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSectionsForCourse: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSectionsForSchool

\Clever\Model\SectionsResponse getSectionsForSchool($id, $limit, $starting_after, $ending_before)

Returns the sections for a school

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSectionsForSchool($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSectionsForSchool: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSectionsForStudent

\Clever\Model\SectionsResponse getSectionsForStudent($id, $limit, $starting_after, $ending_before)

Returns the sections for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSectionsForStudent($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSectionsForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSectionsForTeacher

\Clever\Model\SectionsResponse getSectionsForTeacher($id, $limit, $starting_after, $ending_before)

Returns the sections for a teacher

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSectionsForTeacher($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSectionsForTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getSectionsForTerm

\Clever\Model\SectionsResponse getSectionsForTerm($id, $limit, $starting_after, $ending_before)

Returns the sections for a term

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getSectionsForTerm($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getSectionsForTerm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getStudent

\Clever\Model\StudentResponse getStudent($id)

Returns a specific student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getStudent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getStudents

\Clever\Model\StudentsResponse getStudents($limit, $starting_after, $ending_before)

Returns a list of students

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getStudents($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudents: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getStudentsForContact

\Clever\Model\StudentsResponse getStudentsForContact($id, $limit, $starting_after, $ending_before)

Returns the students for a student contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getStudentsForContact($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudentsForContact: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getStudentsForSchool

\Clever\Model\StudentsResponse getStudentsForSchool($id, $limit, $starting_after, $ending_before)

Returns the students for a school

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getStudentsForSchool($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudentsForSchool: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getStudentsForSection

\Clever\Model\StudentsResponse getStudentsForSection($id, $limit, $starting_after, $ending_before)

Returns the students for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getStudentsForSection($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudentsForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getStudentsForTeacher

\Clever\Model\StudentsResponse getStudentsForTeacher($id, $limit, $starting_after, $ending_before)

Returns the students for a teacher

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getStudentsForTeacher($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudentsForTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getTeacher

\Clever\Model\TeacherResponse getTeacher($id)

Returns a specific teacher

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getTeacher($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeacher: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getTeacherForSection

\Clever\Model\TeacherResponse getTeacherForSection($id)

Returns the primary teacher for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getTeacherForSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeacherForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getTeachers

\Clever\Model\TeachersResponse getTeachers($limit, $starting_after, $ending_before)

Returns a list of teachers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getTeachers($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeachers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getTeachersForSchool

\Clever\Model\TeachersResponse getTeachersForSchool($id, $limit, $starting_after, $ending_before)

Returns the teachers for a school

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getTeachersForSchool($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeachersForSchool: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getTeachersForSection

\Clever\Model\TeachersResponse getTeachersForSection($id, $limit, $starting_after, $ending_before)

Returns the teachers for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getTeachersForSection($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeachersForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getTeachersForStudent

\Clever\Model\TeachersResponse getTeachersForStudent($id, $limit, $starting_after, $ending_before)

Returns the teachers for a student

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 
$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getTeachersForStudent($id, $limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTeachersForStudent: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]

getTerm

\Clever\Model\TermResponse getTerm($id)

Returns a specific term

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getTerm($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTerm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getTermForSection

\Clever\Model\TermResponse getTermForSection($id)

Returns the term for a section

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$id = "id_example"; // string | 

try {
    $result = $api_instance->getTermForSection($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTermForSection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Clever\Model\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]

getTerms

\Clever\Model\TermsResponse getTerms($limit, $starting_after, $ending_before)

Returns a list of terms

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Clever\Api\DataApi();

// Configure OAuth2 access token for authorization: oauth
$api_instance->getConfig()->setAccessToken('YOUR_ACCESS_TOKEN');

$limit = 56; // int | 
$starting_after = "starting_after_example"; // string | 
$ending_before = "ending_before_example"; // string | 

try {
    $result = $api_instance->getTerms($limit, $starting_after, $ending_before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getTerms: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Clever\Model\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]