Python Client for the Flat REST API

The Flat API allows you to easily extend the abilities of the Flat Platform, 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.

You can find the API reference including code samples and our OpenAPI Specification at the following url: https://flat.io/developers/api/reference.

To request some API credentials, please visit https://flat.io/developers.

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install flat_api

pip install git+https://github.com/FlatIO/api-client-python.git

Then import the package:

import flat_api

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import flat_api

Getting Started

Please follow the installation procedure above and then run the following:

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

configuration = flat_api.Configuration()
# Configure your personal access token or OAuth2 access token
configuration.access_token = 'YOUR_ACCESS_TOKEN'
flat_api_client = flat_api.ApiClient(configuration)

# create an instance of the API class
api_instance = flat_api.AccountApi(flat_api_client)

try:
    # Get current user profile
    api_response = api_instance.get_authenticated_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->get_authenticated_user: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.flat.io/v2

Documentation For Models

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

Documentation For Authorization

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://flat.io/auth/oauth
• Scopes:
• account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope education_profile to access to the a basic education account profile.
• account.email: Provices access to the person's email.
• account.education_profile: Provides access to the basic person's education profile and public organization information.
• scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
• scores.social: Allow to post comments and like scores
• scores: Full, permissive scope to access all of a user's scores.
• collections.readonly: Allow read-only access to a user's collections.
• collections.add_scores: Allow to add scores to a user's collections.
• collections: Full, permissive scope to access all of a user's collections.
• edu.classes: Full, permissive scope to manage the classes.
• edu.classes.readonly: Read-only access to the classes.
• edu.assignments: Read-write access to the assignments and submissions.
• edu.assignments.readonly: Read-only access to the assignments and submissions.
• edu.admin: Full, permissive scope to manage all the admin of an organization.
• edu.admin.lti: Access and manage the LTI Credentials for an organization.
• edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
• edu.admin.users: Access and manage the users and invitations of the organization.
• edu.admin.users.readonly: Read-only access to the users and invitations of the organization.