Module: OneRosterClient

Defined in:
lib/oneroster_client/error.rb,
lib/oneroster_client.rb,
lib/oneroster_client/version.rb,
lib/oneroster_client/api_error.rb,
lib/oneroster_client/api_client.rb,
lib/oneroster_client/configuration.rb,
lib/oneroster_client/models/org_type.rb,
lib/oneroster_client/models/base_type.rb,
lib/oneroster_client/models/guid_type.rb,
lib/oneroster_client/models/orgs_type.rb,
lib/oneroster_client/models/user_type.rb,
lib/oneroster_client/models/class_type.rb,
lib/oneroster_client/models/users_type.rb,
lib/oneroster_client/models/course_type.rb,
lib/oneroster_client/models/result_type.rb,
lib/oneroster_client/models/classes_type.rb,
lib/oneroster_client/models/courses_type.rb,
lib/oneroster_client/models/results_type.rb,
lib/oneroster_client/models/user_id_type.rb,
lib/oneroster_client/models/category_type.rb,
lib/oneroster_client/models/guid_ref_type.rb,
lib/oneroster_client/models/metadata_type.rb,
lib/oneroster_client/models/resource_type.rb,
lib/oneroster_client/models/line_item_type.rb,
lib/oneroster_client/models/resources_type.rb,
lib/oneroster_client/models/categories_type.rb,
lib/oneroster_client/models/enrollment_type.rb,
lib/oneroster_client/models/identifier_type.rb,
lib/oneroster_client/models/line_items_type.rb,
lib/oneroster_client/models/org_type_all_of.rb,
lib/oneroster_client/models/single_org_type.rb,
lib/oneroster_client/api/orgs_management_api.rb,
lib/oneroster_client/models/demographic_type.rb,
lib/oneroster_client/models/enrollments_type.rb,
lib/oneroster_client/models/single_user_type.rb,
lib/oneroster_client/models/user_type_all_of.rb,
lib/oneroster_client/api/terms_management_api.rb,
lib/oneroster_client/api/users_management_api.rb,
lib/oneroster_client/models/class_type_all_of.rb,
lib/oneroster_client/models/demographics_type.rb,
lib/oneroster_client/models/single_class_type.rb,
lib/oneroster_client/models/course_type_all_of.rb,
lib/oneroster_client/models/result_type_all_of.rb,
lib/oneroster_client/models/single_course_type.rb,
lib/oneroster_client/models/single_result_type.rb,
lib/oneroster_client/api/classes_management_api.rb,
lib/oneroster_client/api/courses_management_api.rb,
lib/oneroster_client/api/results_management_api.rb,
lib/oneroster_client/api/schools_management_api.rb,
lib/oneroster_client/api/students_management_api.rb,
lib/oneroster_client/api/teachers_management_api.rb,
lib/oneroster_client/models/category_type_all_of.rb,
lib/oneroster_client/models/imsx_code_minor_type.rb,
lib/oneroster_client/models/resource_type_all_of.rb,
lib/oneroster_client/models/single_category_type.rb,
lib/oneroster_client/models/single_resource_type.rb,
lib/oneroster_client/api/resources_management_api.rb,
lib/oneroster_client/models/academic_session_type.rb,
lib/oneroster_client/models/imsx_status_info_type.rb,
lib/oneroster_client/models/line_item_type_all_of.rb,
lib/oneroster_client/models/single_line_item_type.rb,
lib/oneroster_client/api/categories_management_api.rb,
lib/oneroster_client/api/line_items_management_api.rb,
lib/oneroster_client/models/enrollment_type_all_of.rb,
lib/oneroster_client/models/single_enrollment_type.rb,
lib/oneroster_client/api/enrollments_management_api.rb,
lib/oneroster_client/models/demographic_type_all_of.rb,
lib/oneroster_client/api/demographics_management_api.rb,
lib/oneroster_client/models/single_demographics_type.rb,
lib/oneroster_client/models/imsx_code_minor_field_type.rb,
lib/oneroster_client/api/grading_periods_management_api.rb,
lib/oneroster_client/models/academic_session_type_all_of.rb,
lib/oneroster_client/models/single_academic_session_type.rb,
lib/oneroster_client/api/academic_sessions_management_api.rb,
lib/oneroster_client/models/multiple_academic_sessions_type.rb

Overview

#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.

OpenAPI spec version: 1.1 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 3.0.34

Defined Under Namespace

Classes: AcademicSessionType, AcademicSessionTypeAllOf, AcademicSessionsManagementApi, ApiClient, ApiError, BaseType, CategoriesManagementApi, CategoriesType, CategoryType, CategoryTypeAllOf, ClassType, ClassTypeAllOf, ClassesManagementApi, ClassesType, ClientError, Configuration, CourseType, CourseTypeAllOf, CoursesManagementApi, CoursesType, DemographicType, DemographicTypeAllOf, DemographicsManagementApi, DemographicsType, EnrollmentType, EnrollmentTypeAllOf, EnrollmentsManagementApi, EnrollmentsType, Error, GUIDRefType, GUIDType, GradingPeriodsManagementApi, IdentifierType, ImsxCodeMinorFieldType, ImsxCodeMinorType, ImsxStatusInfoType, LineItemType, LineItemTypeAllOf, LineItemsManagementApi, LineItemsType, MetadataType, MultipleAcademicSessionsType, NilStatusError, OrgType, OrgTypeAllOf, OrgsManagementApi, OrgsType, ResourceType, ResourceTypeAllOf, ResourcesManagementApi, ResourcesType, ResultType, ResultTypeAllOf, ResultsManagementApi, ResultsType, SchoolsManagementApi, ServerError, SingleAcademicSessionType, SingleCategoryType, SingleClassType, SingleCourseType, SingleDemographicsType, SingleEnrollmentType, SingleLineItemType, SingleOrgType, SingleResourceType, SingleResultType, SingleUserType, StudentsManagementApi, TeachersManagementApi, TermsManagementApi, TimeoutError, UserIdType, UserType, UserTypeAllOf, UsersManagementApi, UsersType

Constant Summary collapse

VERSION = 
'2.0.3'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

OneRosterClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



100
101
102
103
104
105
106
 
# File 'lib/oneroster_client.rb', line 100

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end