oneroster_client
OneRosterClient - the Ruby gem for the OneRoster OpenAPI (JSON) Definition
The OneRoster service binding is available in WSDL/XSD and REST/JSON. The model is based upon the IMS PSM modelling approach.
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen For more information, please visit http://www.strongmind.com
Installation
Build a gem
To build the Ruby code into a gem:
gem build oneroster_client.gemspec
Then either install the gem locally:
gem install ./strongmind-oneroster-client-1.0.0.gem
(for development, run gem install --dev ./oneroster_client-1.0.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'oneroster_client', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'oneroster_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'oneroster_client'
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::AcademicSessionsManagementApi.new
sourced_id = 'sourced_id_example' # String | The unique identifier for this academic session.
begin
#The REST read request message for the getAcademicSession() API call.
result = api_instance.get_academic_session(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling AcademicSessionsManagementApi->get_academic_session: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::AcademicSessionsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getAcademicSessions() API call.
result = api_instance.get_academic_sessions(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling AcademicSessionsManagementApi->get_academic_sessions: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CategoriesManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST delete request message for the deleteCategory() API call.
api_instance.delete_category(sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling CategoriesManagementApi->delete_category: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CategoriesManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getCategories() API call.
result = api_instance.get_categories(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling CategoriesManagementApi->get_categories: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CategoriesManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getCategory() API call.
result = api_instance.get_category(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling CategoriesManagementApi->get_category: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CategoriesManagementApi.new
body = OneRosterClient::SingleCategoryType.new # SingleCategoryType | ...tbd...
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST create request message for the putCategory() API call.
api_instance.put_category(body, sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling CategoriesManagementApi->put_category: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
sourced_id = 'sourced_id_example' # String | The unique identifier for this class.
begin
#The REST read request message for the getClass() API call.
result = api_instance.get_class(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClasses() API call.
result = api_instance.get_classes(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
course_sourced_id = 'course_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForCourse() API call.
result = api_instance.get_classes_for_course(course_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_course: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForSchool() API call.
result = api_instance.get_classes_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
student_sourced_id = 'student_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForStudent() API call.
result = api_instance.get_classes_for_student(student_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_student: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
teacher_sourced_id = 'teacher_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForTeacher() API call.
result = api_instance.get_classes_for_teacher(teacher_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_teacher: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
term_sourced_id = 'term_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForTerm() API call.
result = api_instance.get_classes_for_term(term_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_term: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ClassesManagementApi.new
user_sourced_id = 'user_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getClassesForUser() API call.
result = api_instance.get_classes_for_user(user_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ClassesManagementApi->get_classes_for_user: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CoursesManagementApi.new
sourced_id = 'sourced_id_example' # String | The unique identifier for this course.
begin
#The REST read request message for the getCourse() API call.
result = api_instance.get_course(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling CoursesManagementApi->get_course: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CoursesManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getCourses() API call.
result = api_instance.get_courses(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling CoursesManagementApi->get_courses: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::CoursesManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getCoursesForSchool() API call.
result = api_instance.get_courses_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling CoursesManagementApi->get_courses_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::DemographicsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getDemographic() API call.
result = api_instance.get_demographic(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling DemographicsManagementApi->get_demographic: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::DemographicsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getDemographics() API call.
result = api_instance.get_demographics(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling DemographicsManagementApi->get_demographics: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::EnrollmentsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getEnrollment() API call.
result = api_instance.get_enrollment(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling EnrollmentsManagementApi->get_enrollment: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::EnrollmentsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getEnrollments() API call.
result = api_instance.get_enrollments(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling EnrollmentsManagementApi->get_enrollments: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::EnrollmentsManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getEnrollmentsForClassInSchool() API call.
result = api_instance.get_enrollments_for_class_in_school(school_sourced_id, class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling EnrollmentsManagementApi->get_enrollments_for_class_in_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::EnrollmentsManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getEnrollmentsForSchool() API call.
result = api_instance.get_enrollments_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling EnrollmentsManagementApi->get_enrollments_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::GradingPeriodsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getGradingPeriod() API call.
result = api_instance.get_grading_period(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling GradingPeriodsManagementApi->get_grading_period: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::GradingPeriodsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getGradingPeriods() API call.
result = api_instance.get_grading_periods(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling GradingPeriodsManagementApi->get_grading_periods: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::GradingPeriodsManagementApi.new
term_sourced_id = 'term_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getGradingPeriodsForTerm() API call.
result = api_instance.get_grading_periods_for_term(term_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling GradingPeriodsManagementApi->get_grading_periods_for_term: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::LineItemsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST delete request message for the deleteLineItem() API call.
api_instance.delete_line_item(sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling LineItemsManagementApi->delete_line_item: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::LineItemsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getLineItem() API call.
result = api_instance.get_line_item(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling LineItemsManagementApi->get_line_item: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::LineItemsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getLineItems() API call.
result = api_instance.get_line_items(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling LineItemsManagementApi->get_line_items: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::LineItemsManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getLineItemsForClass() API call.
result = api_instance.get_line_items_for_class(class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling LineItemsManagementApi->get_line_items_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::LineItemsManagementApi.new
body = OneRosterClient::SingleLineItemType.new # SingleLineItemType | ...tbd...
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST create request message for the putLineItem() API call.
api_instance.put_line_item(body, sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling LineItemsManagementApi->put_line_item: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::OrgsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getOrg() API call.
result = api_instance.get_org(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling OrgsManagementApi->get_org: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::OrgsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getOrgs() API call.
result = api_instance.get_orgs(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling OrgsManagementApi->get_orgs: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResourcesManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getResource() API call.
result = api_instance.get_resource(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResourcesManagementApi->get_resource: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResourcesManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResources() API call.
result = api_instance.get_resources(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResourcesManagementApi->get_resources: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResourcesManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResourcesForClass() API call.
result = api_instance.get_resources_for_class(class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResourcesManagementApi->get_resources_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResourcesManagementApi.new
course_sourced_id = 'course_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResourcesForCourse() API call.
result = api_instance.get_resources_for_course(course_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResourcesManagementApi->get_resources_for_course: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST delete request message for the deleteResult() API call.
api_instance.delete_result(sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->delete_result: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getResult() API call.
result = api_instance.get_result(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->get_result: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResults() API call.
result = api_instance.get_results(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->get_results: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResultsForClass() API call.
result = api_instance.get_results_for_class(class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->get_results_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
line_item_sourced_id = 'line_item_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResultsForLineItemForClass() API call.
result = api_instance.get_results_for_line_item_for_class(class_sourced_id, line_item_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->get_results_for_line_item_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
student_sourced_id = 'student_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getResultsForStudentForClass() API call.
result = api_instance.get_results_for_student_for_class(class_sourced_id, student_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->get_results_for_student_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::ResultsManagementApi.new
body = OneRosterClient::SingleResultType.new # SingleResultType | ...tbd...
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST create request message for the putResult() API call.
api_instance.put_result(body, sourced_id)
rescue OneRosterClient::ApiError => e
puts "Exception when calling ResultsManagementApi->put_result: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::SchoolsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getSchool() API call.
result = api_instance.get_school(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling SchoolsManagementApi->get_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::SchoolsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getSchools() API call.
result = api_instance.get_schools(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling SchoolsManagementApi->get_schools: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::StudentsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getStudent() API call.
result = api_instance.get_student(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling StudentsManagementApi->get_student: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::StudentsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getStudents() API call.
result = api_instance.get_students(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling StudentsManagementApi->get_students: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::StudentsManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getStudentsForClass() API call.
result = api_instance.get_students_for_class(class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling StudentsManagementApi->get_students_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::StudentsManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getStudentsForClassInSchool() API call.
result = api_instance.get_students_for_class_in_school(school_sourced_id, class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling StudentsManagementApi->get_students_for_class_in_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::StudentsManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getStudentsForSchool() API call.
result = api_instance.get_students_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling StudentsManagementApi->get_students_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TeachersManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getTeacher() API call.
result = api_instance.get_teacher(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TeachersManagementApi->get_teacher: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TeachersManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTeachers() API call.
result = api_instance.get_teachers(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TeachersManagementApi->get_teachers: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TeachersManagementApi.new
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTeachersForClass() API call.
result = api_instance.get_teachers_for_class(class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TeachersManagementApi->get_teachers_for_class: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TeachersManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
class_sourced_id = 'class_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTeachersForClassInSchool() API call.
result = api_instance.get_teachers_for_class_in_school(school_sourced_id, class_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TeachersManagementApi->get_teachers_for_class_in_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TeachersManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTeachersForSchool() API call.
result = api_instance.get_teachers_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TeachersManagementApi->get_teachers_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TermsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getTerm() API call.
result = api_instance.get_term(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TermsManagementApi->get_term: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TermsManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTerms() API call.
result = api_instance.get_terms(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TermsManagementApi->get_terms: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::TermsManagementApi.new
school_sourced_id = 'school_sourced_id_example' # String | ...tbd...
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getTermsForSchool() API call.
result = api_instance.get_terms_for_school(school_sourced_id, opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling TermsManagementApi->get_terms_for_school: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::UsersManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...
begin
#The REST read request message for the getUser() API call.
result = api_instance.get_user(sourced_id)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling UsersManagementApi->get_user: #{e}"
end
# Setup authorization
OneRosterClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2Security
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = OneRosterClient::UsersManagementApi.new
opts = {
limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}
begin
#The REST read request message for the getUsers() API call.
result = api_instance.get_users(opts)
p result
rescue OneRosterClient::ApiError => e
puts "Exception when calling UsersManagementApi->get_users: #{e}"
end
Documentation for API Endpoints
All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| OneRosterClient::AcademicSessionsManagementApi | get_academic_session | GET /academicSessions/sourcedId | The REST read request message for the getAcademicSession() API call. |
| OneRosterClient::AcademicSessionsManagementApi | get_academic_sessions | GET /academicSessions | The REST read request message for the getAcademicSessions() API call. |
| OneRosterClient::CategoriesManagementApi | delete_category | DELETE /categories/sourcedId | The REST delete request message for the deleteCategory() API call. |
| OneRosterClient::CategoriesManagementApi | get_categories | GET /categories | The REST read request message for the getCategories() API call. |
| OneRosterClient::CategoriesManagementApi | get_category | GET /categories/sourcedId | The REST read request message for the getCategory() API call. |
| OneRosterClient::CategoriesManagementApi | put_category | PUT /categories/sourcedId | The REST create request message for the putCategory() API call. |
| OneRosterClient::ClassesManagementApi | get_class | GET /classes/sourcedId | The REST read request message for the getClass() API call. |
| OneRosterClient::ClassesManagementApi | get_classes | GET /classes | The REST read request message for the getClasses() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_course | GET /courses/courseSourcedId/classes | The REST read request message for the getClassesForCourse() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_school | GET /schools/schoolSourcedId/classes | The REST read request message for the getClassesForSchool() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_student | GET /students/studentSourcedId/classes | The REST read request message for the getClassesForStudent() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_teacher | GET /teachers/teacherSourcedId/classes | The REST read request message for the getClassesForTeacher() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_term | GET /terms/termSourcedId/classes | The REST read request message for the getClassesForTerm() API call. |
| OneRosterClient::ClassesManagementApi | get_classes_for_user | GET /users/userSourcedId/classes | The REST read request message for the getClassesForUser() API call. |
| OneRosterClient::CoursesManagementApi | get_course | GET /courses/sourcedId | The REST read request message for the getCourse() API call. |
| OneRosterClient::CoursesManagementApi | get_courses | GET /courses | The REST read request message for the getCourses() API call. |
| OneRosterClient::CoursesManagementApi | get_courses_for_school | GET /schools/schoolSourcedId/courses | The REST read request message for the getCoursesForSchool() API call. |
| OneRosterClient::DemographicsManagementApi | get_demographic | GET /demographics/sourcedId | The REST read request message for the getDemographic() API call. |
| OneRosterClient::DemographicsManagementApi | get_demographics | GET /demographics | The REST read request message for the getDemographics() API call. |
| OneRosterClient::EnrollmentsManagementApi | get_enrollment | GET /enrollments/sourcedId | The REST read request message for the getEnrollment() API call. |
| OneRosterClient::EnrollmentsManagementApi | get_enrollments | GET /enrollments | The REST read request message for the getEnrollments() API call. |
| OneRosterClient::EnrollmentsManagementApi | get_enrollments_for_class_in_school | GET /schools/schoolSourcedId/classes/classSourcedId/enrollments | The REST read request message for the getEnrollmentsForClassInSchool() API call. |
| OneRosterClient::EnrollmentsManagementApi | get_enrollments_for_school | GET /schools/schoolSourcedId/enrollments | The REST read request message for the getEnrollmentsForSchool() API call. |
| OneRosterClient::GradingPeriodsManagementApi | get_grading_period | GET /gradingPeriods/sourcedId | The REST read request message for the getGradingPeriod() API call. |
| OneRosterClient::GradingPeriodsManagementApi | get_grading_periods | GET /gradingPeriods | The REST read request message for the getGradingPeriods() API call. |
| OneRosterClient::GradingPeriodsManagementApi | get_grading_periods_for_term | GET /terms/termSourcedId/gradingPeriods | The REST read request message for the getGradingPeriodsForTerm() API call. |
| OneRosterClient::LineItemsManagementApi | delete_line_item | DELETE /lineItems/sourcedId | The REST delete request message for the deleteLineItem() API call. |
| OneRosterClient::LineItemsManagementApi | get_line_item | GET /lineItems/sourcedId | The REST read request message for the getLineItem() API call. |
| OneRosterClient::LineItemsManagementApi | get_line_items | GET /lineItems | The REST read request message for the getLineItems() API call. |
| OneRosterClient::LineItemsManagementApi | get_line_items_for_class | GET /classes/classSourcedId/lineItems | The REST read request message for the getLineItemsForClass() API call. |
| OneRosterClient::LineItemsManagementApi | put_line_item | PUT /lineItems/sourcedId | The REST create request message for the putLineItem() API call. |
| OneRosterClient::OrgsManagementApi | get_org | GET /orgs/sourcedId | The REST read request message for the getOrg() API call. |
| OneRosterClient::OrgsManagementApi | get_orgs | GET /orgs | The REST read request message for the getOrgs() API call. |
| OneRosterClient::ResourcesManagementApi | get_resource | GET /resources/sourcedId | The REST read request message for the getResource() API call. |
| OneRosterClient::ResourcesManagementApi | get_resources | GET /resources | The REST read request message for the getResources() API call. |
| OneRosterClient::ResourcesManagementApi | get_resources_for_class | GET /classes/classSourcedId/resources | The REST read request message for the getResourcesForClass() API call. |
| OneRosterClient::ResourcesManagementApi | get_resources_for_course | GET /courses/courseSourcedId/resources | The REST read request message for the getResourcesForCourse() API call. |
| OneRosterClient::ResultsManagementApi | delete_result | DELETE /results/sourcedId | The REST delete request message for the deleteResult() API call. |
| OneRosterClient::ResultsManagementApi | get_result | GET /results/sourcedId | The REST read request message for the getResult() API call. |
| OneRosterClient::ResultsManagementApi | get_results | GET /results | The REST read request message for the getResults() API call. |
| OneRosterClient::ResultsManagementApi | get_results_for_class | GET /classes/classSourcedId/results | The REST read request message for the getResultsForClass() API call. |
| OneRosterClient::ResultsManagementApi | get_results_for_line_item_for_class | GET /classes/classSourcedId/lineItems/lineItemSourcedId/results | The REST read request message for the getResultsForLineItemForClass() API call. |
| OneRosterClient::ResultsManagementApi | get_results_for_student_for_class | GET /classes/classSourcedId/students/studentSourcedId/results | The REST read request message for the getResultsForStudentForClass() API call. |
| OneRosterClient::ResultsManagementApi | put_result | PUT /results/sourcedId | The REST create request message for the putResult() API call. |
| OneRosterClient::SchoolsManagementApi | get_school | GET /schools/sourcedId | The REST read request message for the getSchool() API call. |
| OneRosterClient::SchoolsManagementApi | get_schools | GET /schools | The REST read request message for the getSchools() API call. |
| OneRosterClient::StudentsManagementApi | get_student | GET /students/sourcedId | The REST read request message for the getStudent() API call. |
| OneRosterClient::StudentsManagementApi | get_students | GET /students | The REST read request message for the getStudents() API call. |
| OneRosterClient::StudentsManagementApi | get_students_for_class | GET /classes/classSourcedId/students | The REST read request message for the getStudentsForClass() API call. |
| OneRosterClient::StudentsManagementApi | get_students_for_class_in_school | GET /schools/schoolSourcedId/classes/classSourcedId/students | The REST read request message for the getStudentsForClassInSchool() API call. |
| OneRosterClient::StudentsManagementApi | get_students_for_school | GET /schools/schoolSourcedId/students | The REST read request message for the getStudentsForSchool() API call. |
| OneRosterClient::TeachersManagementApi | get_teacher | GET /teachers/sourcedId | The REST read request message for the getTeacher() API call. |
| OneRosterClient::TeachersManagementApi | get_teachers | GET /teachers | The REST read request message for the getTeachers() API call. |
| OneRosterClient::TeachersManagementApi | get_teachers_for_class | GET /classes/classSourcedId/teachers | The REST read request message for the getTeachersForClass() API call. |
| OneRosterClient::TeachersManagementApi | get_teachers_for_class_in_school | GET /schools/schoolSourcedId/classes/classSourcedId/teachers | The REST read request message for the getTeachersForClassInSchool() API call. |
| OneRosterClient::TeachersManagementApi | get_teachers_for_school | GET /schools/schoolSourcedId/teachers | The REST read request message for the getTeachersForSchool() API call. |
| OneRosterClient::TermsManagementApi | get_term | GET /terms/sourcedId | The REST read request message for the getTerm() API call. |
| OneRosterClient::TermsManagementApi | get_terms | GET /terms | The REST read request message for the getTerms() API call. |
| OneRosterClient::TermsManagementApi | get_terms_for_school | GET /schools/schoolSourcedId/terms | The REST read request message for the getTermsForSchool() API call. |
| OneRosterClient::UsersManagementApi | get_user | GET /users/sourcedId | The REST read request message for the getUser() API call. |
| OneRosterClient::UsersManagementApi | get_users | GET /users | The REST read request message for the getUsers() API call. |
Documentation for Models
- OneRosterClient::AcademicSessionType
- OneRosterClient::AcademicSessionTypeAllOf
- OneRosterClient::BaseType
- OneRosterClient::CategoriesType
- OneRosterClient::CategoryType
- OneRosterClient::CategoryTypeAllOf
- OneRosterClient::ClassType
- OneRosterClient::ClassTypeAllOf
- OneRosterClient::ClassesType
- OneRosterClient::CourseType
- OneRosterClient::CourseTypeAllOf
- OneRosterClient::CoursesType
- OneRosterClient::DemographicType
- OneRosterClient::DemographicTypeAllOf
- OneRosterClient::DemographicsType
- OneRosterClient::EnrollmentType
- OneRosterClient::EnrollmentTypeAllOf
- OneRosterClient::EnrollmentsType
- OneRosterClient::GUIDRefType
- OneRosterClient::GUIDType
- OneRosterClient::IdentifierType
- OneRosterClient::ImsxCodeMinorFieldType
- OneRosterClient::ImsxCodeMinorType
- OneRosterClient::ImsxStatusInfoType
- OneRosterClient::LineItemType
- OneRosterClient::LineItemTypeAllOf
- OneRosterClient::LineItemsType
- OneRosterClient::MetadataType
- OneRosterClient::MultipleAcademicSessionsType
- OneRosterClient::OrgType
- OneRosterClient::OrgTypeAllOf
- OneRosterClient::OrgsType
- OneRosterClient::ResourceType
- OneRosterClient::ResourceTypeAllOf
- OneRosterClient::ResourcesType
- OneRosterClient::ResultType
- OneRosterClient::ResultTypeAllOf
- OneRosterClient::ResultsType
- OneRosterClient::SingleAcademicSessionType
- OneRosterClient::SingleCategoryType
- OneRosterClient::SingleClassType
- OneRosterClient::SingleCourseType
- OneRosterClient::SingleDemographicsType
- OneRosterClient::SingleEnrollmentType
- OneRosterClient::SingleLineItemType
- OneRosterClient::SingleOrgType
- OneRosterClient::SingleResourceType
- OneRosterClient::SingleResultType
- OneRosterClient::SingleUserType
- OneRosterClient::UserIdType
- OneRosterClient::UserType
- OneRosterClient::UserTypeAllOf
- OneRosterClient::UsersType
Documentation for Authorization
OAuth2Security
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- StrongMind.Platform.OneRoster.Read: Read access to OneRoster resources