Module: FlatApi

Defined in:
lib/flat_api/version.rb,
lib/flat_api.rb,
lib/flat_api/api_error.rb,
lib/flat_api/api_client.rb,
lib/flat_api/api/user_api.rb,
lib/flat_api/models/group.rb,
lib/flat_api/api/class_api.rb,
lib/flat_api/api/group_api.rb,
lib/flat_api/api/score_api.rb,
lib/flat_api/configuration.rb,
lib/flat_api/api/account_api.rb,
lib/flat_api/models/lms_name.rb,
lib/flat_api/models/assignment.rb,
lib/flat_api/models/collection.rb,
lib/flat_api/models/group_type.rb,
lib/flat_api/models/score_data.rb,
lib/flat_api/models/score_fork.rb,
lib/flat_api/api/collection_api.rb,
lib/flat_api/models/class_roles.rb,
lib/flat_api/models/class_state.rb,
lib/flat_api/models/score_track.rb,
lib/flat_api/models/user_basics.rb,
lib/flat_api/models/user_public.rb,
lib/flat_api/models/class_update.rb,
lib/flat_api/models/flat_locales.rb,
lib/flat_api/models/license_mode.rb,
lib/flat_api/models/score_source.rb,
lib/flat_api/models/user_details.rb,
lib/flat_api/api/organization_api.rb,
lib/flat_api/models/class_details.rb,
lib/flat_api/models/group_details.rb,
lib/flat_api/models/score_comment.rb,
lib/flat_api/models/score_details.rb,
lib/flat_api/models/score_license.rb,
lib/flat_api/models/score_privacy.rb,
lib/flat_api/models/score_summary.rb,
lib/flat_api/models/user_creation.rb,
lib/flat_api/models/class_creation.rb,
lib/flat_api/models/score_creation.rb,
lib/flat_api/models/score_revision.rb,
lib/flat_api/models/assignment_copy.rb,
lib/flat_api/models/collection_type.rb,
lib/flat_api/models/license_sources.rb,
lib/flat_api/models/lti_credentials.rb,
lib/flat_api/models/resource_rights.rb,
lib/flat_api/models/collection_title.rb,
lib/flat_api/models/media_attachment.rb,
lib/flat_api/models/score_track_type.rb,
lib/flat_api/models/user_instruments.rb,
lib/flat_api/models/class_details_lti.rb,
lib/flat_api/models/score_track_point.rb,
lib/flat_api/models/score_track_state.rb,
lib/flat_api/models/user_admin_update.rb,
lib/flat_api/models/collection_privacy.rb,
lib/flat_api/models/organization_roles.rb,
lib/flat_api/models/score_likes_counts.rb,
lib/flat_api/models/score_modification.rb,
lib/flat_api/models/score_track_update.rb,
lib/flat_api/models/score_views_counts.rb,
lib/flat_api/models/user_details_admin.rb,
lib/flat_api/models/assignment_creation.rb,
lib/flat_api/models/collection_creation.rb,
lib/flat_api/models/flat_error_response.rb,
lib/flat_api/models/score_creation_type.rb,
lib/flat_api/models/score_data_encoding.rb,
lib/flat_api/models/user_public_summary.rb,
lib/flat_api/models/class_details_canvas.rb,
lib/flat_api/models/class_details_clever.rb,
lib/flat_api/models/resource_sharing_key.rb,
lib/flat_api/models/score_comment_update.rb,
lib/flat_api/models/score_track_creation.rb,
lib/flat_api/models/assignment_submission.rb,
lib/flat_api/models/resource_collaborator.rb,
lib/flat_api/models/score_comment_context.rb,
lib/flat_api/models/score_comments_counts.rb,
lib/flat_api/models/score_comment_creation.rb,
lib/flat_api/models/collection_capabilities.rb,
lib/flat_api/models/collection_modification.rb,
lib/flat_api/models/organization_invitation.rb,
lib/flat_api/models/score_revision_creation.rb,
lib/flat_api/models/lti_credentials_creation.rb,
lib/flat_api/models/media_score_sharing_mode.rb,
lib/flat_api/models/class_attachment_creation.rb,
lib/flat_api/models/score_revision_statistics.rb,
lib/flat_api/models/class_details_google_drive.rb,
lib/flat_api/models/user_details_admin_license.rb,
lib/flat_api/models/google_classroom_coursework.rb,
lib/flat_api/models/google_classroom_submission.rb,
lib/flat_api/models/assignment_submission_update.rb,
lib/flat_api/models/class_details_google_classroom.rb,
lib/flat_api/models/resource_collaborator_creation.rb,
lib/flat_api/models/organization_invitation_creation.rb

Overview

#Flat API

#The Flat API allows you to easily extend the abilities of the [Flat Platform](flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user’s scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](www.openapis.org/), you can use and work with [compatible Swagger tools](swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat’s API. This specification and reference is [available on Github](github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](flat.io/developers/docs/api/authentication.html) * [SDKs](flat.io/developers/docs/api/sdks.html) * [Rate Limits](flat.io/developers/docs/api/rate-limits.html) * [Changelog](flat.io/developers/docs/api/changelog.html)

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

Defined Under Namespace

Classes: AccountApi, ApiClient, ApiError, Assignment, AssignmentCopy, AssignmentCreation, AssignmentSubmission, AssignmentSubmissionUpdate, ClassApi, ClassAttachmentCreation, ClassCreation, ClassDetails, ClassDetailsCanvas, ClassDetailsClever, ClassDetailsGoogleClassroom, ClassDetailsGoogleDrive, ClassDetailsLti, ClassRoles, ClassState, ClassUpdate, Collection, CollectionApi, CollectionCapabilities, CollectionCreation, CollectionModification, CollectionPrivacy, CollectionTitle, CollectionType, Configuration, FlatErrorResponse, FlatLocales, GoogleClassroomCoursework, GoogleClassroomSubmission, Group, GroupApi, GroupDetails, GroupType, LicenseMode, LicenseSources, LmsName, LtiCredentials, LtiCredentialsCreation, MediaAttachment, MediaScoreSharingMode, OrganizationApi, OrganizationInvitation, OrganizationInvitationCreation, OrganizationRoles, ResourceCollaborator, ResourceCollaboratorCreation, ResourceRights, ResourceSharingKey, ScoreApi, ScoreComment, ScoreCommentContext, ScoreCommentCreation, ScoreCommentUpdate, ScoreCommentsCounts, ScoreCreation, ScoreCreationType, ScoreData, ScoreDataEncoding, ScoreDetails, ScoreFork, ScoreLicense, ScoreLikesCounts, ScoreModification, ScorePrivacy, ScoreRevision, ScoreRevisionCreation, ScoreRevisionStatistics, ScoreSource, ScoreSummary, ScoreTrack, ScoreTrackCreation, ScoreTrackPoint, ScoreTrackState, ScoreTrackType, ScoreTrackUpdate, ScoreViewsCounts, UserAdminUpdate, UserApi, UserBasics, UserCreation, UserDetails, UserDetailsAdmin, UserDetailsAdminLicense, UserInstruments, UserPublic, UserPublicSummary

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

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

If no block given, return the default Configuration object.



118
119
120
121
122
123
124
 
# File 'lib/flat_api.rb', line 118

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