flat_api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1 -1
- data/lib/flat_api/api/account_api.rb +2 -2
- data/lib/flat_api/api/class_api.rb +22 -22
- data/lib/flat_api/api/collection_api.rb +6 -6
- data/lib/flat_api/api/edu_resources_api.rb +6 -6
- data/lib/flat_api/api/group_api.rb +4 -4
- data/lib/flat_api/api/omr_api.rb +6 -6
- data/lib/flat_api/api/organization_api.rb +8 -8
- data/lib/flat_api/api/score_api.rb +38 -38
- data/lib/flat_api/api/task_api.rb +6 -6
- data/lib/flat_api/api/user_api.rb +6 -6
- data/lib/flat_api/api_client.rb +2 -2
- data/lib/flat_api/api_error.rb +2 -2
- data/lib/flat_api/api_model_base.rb +2 -2
- data/lib/flat_api/configuration.rb +2 -2
- data/lib/flat_api/models/add_group_user200_response.rb +2 -2
- data/lib/flat_api/models/add_group_user_request.rb +2 -2
- data/lib/flat_api/models/api_access_token.rb +4 -4
- data/lib/flat_api/models/app_scopes.rb +2 -2
- data/lib/flat_api/models/assignment.rb +5 -5
- data/lib/flat_api/models/assignment_capabilities.rb +2 -2
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +2 -2
- data/lib/flat_api/models/assignment_copy.rb +2 -2
- data/lib/flat_api/models/assignment_copy_response.rb +5 -5
- data/lib/flat_api/models/assignment_copy_to_class.rb +3 -3
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +3 -3
- data/lib/flat_api/models/assignment_group.rb +2 -2
- data/lib/flat_api/models/assignment_submission.rb +3 -3
- data/lib/flat_api/models/assignment_submission_comment.rb +2 -2
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +3 -3
- data/lib/flat_api/models/assignment_submission_comments.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +2 -2
- data/lib/flat_api/models/assignment_submission_history_state.rb +2 -2
- data/lib/flat_api/models/assignment_submission_lti.rb +2 -2
- data/lib/flat_api/models/assignment_submission_playback.rb +2 -2
- data/lib/flat_api/models/assignment_submission_state.rb +2 -2
- data/lib/flat_api/models/assignment_submission_students_mode.rb +2 -2
- data/lib/flat_api/models/assignment_submission_update.rb +4 -4
- data/lib/flat_api/models/assignment_type.rb +2 -2
- data/lib/flat_api/models/assignment_update.rb +5 -5
- data/lib/flat_api/models/class_assignment.rb +6 -6
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +3 -3
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +2 -2
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +3 -3
- data/lib/flat_api/models/class_assignment_update.rb +6 -6
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +2 -2
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +2 -2
- data/lib/flat_api/models/class_attachment_creation.rb +5 -5
- data/lib/flat_api/models/class_creation.rb +2 -2
- data/lib/flat_api/models/class_details.rb +5 -5
- data/lib/flat_api/models/class_details_canvas.rb +3 -3
- data/lib/flat_api/models/class_details_clever.rb +2 -2
- data/lib/flat_api/models/class_details_google_classroom.rb +2 -2
- data/lib/flat_api/models/class_details_google_drive.rb +2 -2
- data/lib/flat_api/models/class_details_issues.rb +2 -2
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +2 -2
- data/lib/flat_api/models/class_details_lti.rb +2 -2
- data/lib/flat_api/models/class_details_mfc.rb +3 -3
- data/lib/flat_api/models/class_details_microsoft_graph.rb +2 -2
- data/lib/flat_api/models/class_grade_level.rb +2 -2
- data/lib/flat_api/models/class_roles.rb +2 -2
- data/lib/flat_api/models/class_state.rb +2 -2
- data/lib/flat_api/models/class_update.rb +2 -2
- data/lib/flat_api/models/collection.rb +3 -3
- data/lib/flat_api/models/collection_app.rb +2 -2
- data/lib/flat_api/models/collection_capabilities.rb +2 -2
- data/lib/flat_api/models/collection_contents.rb +2 -2
- data/lib/flat_api/models/collection_creation.rb +2 -2
- data/lib/flat_api/models/collection_modification.rb +2 -2
- data/lib/flat_api/models/collection_privacy.rb +2 -2
- data/lib/flat_api/models/collection_type.rb +2 -2
- data/lib/flat_api/models/credit_transaction.rb +2 -2
- data/lib/flat_api/models/edu_library.rb +3 -3
- data/lib/flat_api/models/edu_resource.rb +2 -2
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +2 -2
- data/lib/flat_api/models/edu_resource_capabilities.rb +2 -2
- data/lib/flat_api/models/edu_resource_copy.rb +3 -3
- data/lib/flat_api/models/edu_resource_creation.rb +3 -3
- data/lib/flat_api/models/edu_resource_folder.rb +3 -3
- data/lib/flat_api/models/edu_resource_lti_link.rb +3 -3
- data/lib/flat_api/models/edu_resource_move.rb +3 -3
- data/lib/flat_api/models/edu_resource_privacy.rb +2 -2
- data/lib/flat_api/models/edu_resource_resource.rb +2 -2
- data/lib/flat_api/models/edu_resource_type.rb +2 -2
- data/lib/flat_api/models/edu_resource_update.rb +2 -2
- data/lib/flat_api/models/edu_resource_use_in_class.rb +3 -3
- data/lib/flat_api/models/flat_error_response.rb +3 -3
- data/lib/flat_api/models/google_classroom_coursework.rb +2 -2
- data/lib/flat_api/models/google_classroom_submission.rb +2 -2
- data/lib/flat_api/models/grade.rb +2 -2
- data/lib/flat_api/models/group.rb +2 -2
- data/lib/flat_api/models/group_creation.rb +2 -2
- data/lib/flat_api/models/group_details.rb +5 -5
- data/lib/flat_api/models/group_type.rb +2 -2
- data/lib/flat_api/models/license_mode.rb +2 -2
- data/lib/flat_api/models/license_sources.rb +2 -2
- data/lib/flat_api/models/lms_name.rb +2 -2
- data/lib/flat_api/models/lti_configuration.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p1.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +3 -3
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +3 -3
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +2 -2
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +2 -2
- data/lib/flat_api/models/lti_configuration_base.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p1.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +3 -3
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +2 -2
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +2 -2
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +2 -2
- data/lib/flat_api/models/lti_credentials.rb +6 -6
- data/lib/flat_api/models/lti_credentials_creation.rb +4 -4
- data/lib/flat_api/models/media_attachment.rb +8 -8
- data/lib/flat_api/models/media_score_sharing_mode.rb +2 -2
- data/lib/flat_api/models/microsoft_graph_assignment.rb +2 -2
- data/lib/flat_api/models/microsoft_graph_submission.rb +2 -2
- data/lib/flat_api/models/omr_capabilities.rb +2 -2
- data/lib/flat_api/models/omr_details_step_data.rb +3 -3
- data/lib/flat_api/models/omr_details_submission.rb +2 -2
- data/lib/flat_api/models/omr_detected_instrument.rb +2 -2
- data/lib/flat_api/models/omr_imported_metadata.rb +2 -2
- data/lib/flat_api/models/omr_instrument_override.rb +2 -2
- data/lib/flat_api/models/omr_job.rb +13 -3
- data/lib/flat_api/models/omr_job_creation.rb +16 -4
- data/lib/flat_api/models/omr_job_file_metadata.rb +2 -2
- data/lib/flat_api/models/omr_job_file_upload.rb +2 -2
- data/lib/flat_api/models/omr_job_file_upload_result.rb +2 -2
- data/lib/flat_api/models/omr_job_input_file.rb +2 -2
- data/lib/flat_api/models/omr_job_output.rb +2 -2
- data/lib/flat_api/models/omr_job_progress.rb +2 -2
- data/lib/flat_api/models/omr_job_result.rb +2 -2
- data/lib/flat_api/models/omr_job_retention.rb +3 -3
- data/lib/flat_api/models/omr_job_status.rb +2 -2
- data/lib/flat_api/models/omr_locale_details.rb +2 -2
- data/lib/flat_api/models/omr_pending_step.rb +2 -2
- data/lib/flat_api/models/omr_step_name.rb +2 -2
- data/lib/flat_api/models/organization_invitation.rb +3 -3
- data/lib/flat_api/models/organization_invitation_creation.rb +2 -2
- data/lib/flat_api/models/organization_roles.rb +2 -2
- data/lib/flat_api/models/organization_user_access_token_creation.rb +2 -2
- data/lib/flat_api/models/rename_group_request.rb +2 -2
- data/lib/flat_api/models/resource_collaborator.rb +3 -3
- data/lib/flat_api/models/resource_collaborator_creation.rb +3 -3
- data/lib/flat_api/models/resource_rights.rb +2 -2
- data/lib/flat_api/models/score_comment.rb +7 -7
- data/lib/flat_api/models/score_comment_context.rb +5 -5
- data/lib/flat_api/models/score_comment_creation.rb +3 -3
- data/lib/flat_api/models/score_comment_moderation.rb +2 -2
- data/lib/flat_api/models/score_comment_update.rb +3 -3
- data/lib/flat_api/models/score_comments_counts.rb +2 -2
- data/lib/flat_api/models/score_creation.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data.rb +3 -3
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +2 -2
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +4 -4
- data/lib/flat_api/models/score_creation_common.rb +3 -3
- data/lib/flat_api/models/score_creation_file_import.rb +3 -3
- data/lib/flat_api/models/score_creation_google_drive_import.rb +3 -3
- data/lib/flat_api/models/score_creation_type.rb +2 -2
- data/lib/flat_api/models/score_details.rb +7 -7
- data/lib/flat_api/models/score_details_all_of_me.rb +2 -2
- data/lib/flat_api/models/score_fork.rb +2 -2
- data/lib/flat_api/models/score_license.rb +2 -2
- data/lib/flat_api/models/score_likes_counts.rb +2 -2
- data/lib/flat_api/models/score_modification.rb +2 -2
- data/lib/flat_api/models/score_plays_counts.rb +2 -2
- data/lib/flat_api/models/score_privacy.rb +2 -2
- data/lib/flat_api/models/score_revision.rb +2 -2
- data/lib/flat_api/models/score_revision_creation.rb +3 -3
- data/lib/flat_api/models/score_revision_statistics.rb +2 -2
- data/lib/flat_api/models/score_source.rb +3 -3
- data/lib/flat_api/models/score_summary.rb +2 -2
- data/lib/flat_api/models/score_track.rb +2 -2
- data/lib/flat_api/models/score_track_creation.rb +2 -2
- data/lib/flat_api/models/score_track_creation_response.rb +2 -2
- data/lib/flat_api/models/score_track_point.rb +2 -2
- data/lib/flat_api/models/score_track_purpose.rb +2 -2
- data/lib/flat_api/models/score_track_state.rb +2 -2
- data/lib/flat_api/models/score_track_type.rb +2 -2
- data/lib/flat_api/models/score_track_update.rb +2 -2
- data/lib/flat_api/models/score_views_counts.rb +2 -2
- data/lib/flat_api/models/task.rb +2 -2
- data/lib/flat_api/models/task_export_options.rb +2 -2
- data/lib/flat_api/models/task_progress.rb +2 -2
- data/lib/flat_api/models/task_result.rb +4 -4
- data/lib/flat_api/models/teaching_theme.rb +2 -2
- data/lib/flat_api/models/tutteo_product.rb +2 -2
- data/lib/flat_api/models/user_admin_update.rb +2 -2
- data/lib/flat_api/models/user_azure_details.rb +2 -2
- data/lib/flat_api/models/user_basics.rb +2 -2
- data/lib/flat_api/models/user_community_profile_links.rb +3 -3
- data/lib/flat_api/models/user_creation.rb +2 -2
- data/lib/flat_api/models/user_details.rb +7 -7
- data/lib/flat_api/models/user_details_admin.rb +2 -2
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +3 -3
- data/lib/flat_api/models/user_public.rb +6 -6
- data/lib/flat_api/models/user_public_summary.rb +2 -2
- data/lib/flat_api/models/user_signin_link.rb +2 -2
- data/lib/flat_api/models/user_signin_link_creation.rb +2 -2
- data/lib/flat_api/version.rb +3 -3
- data/lib/flat_api.rb +2 -2
- metadata +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -36,7 +36,7 @@ module FlatApi
|
|
|
36
36
|
# The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`.
|
|
37
37
|
attr_accessor :attachments
|
|
38
38
|
|
|
39
|
-
# The number of
|
|
39
|
+
# The number of playbacks authorized on the scores of the assignment.
|
|
40
40
|
attr_accessor :nb_playback_authorized
|
|
41
41
|
|
|
42
42
|
# Restrict the ability to get an audio feedback every time a student adds or selects a note.
|
|
@@ -54,13 +54,13 @@ module FlatApi
|
|
|
54
54
|
# The URL of the cover to display
|
|
55
55
|
attr_accessor :cover
|
|
56
56
|
|
|
57
|
-
# If set, the grading will be enabled for the
|
|
57
|
+
# If set, the grading will be enabled for the assignment with this value as the maximum of points
|
|
58
58
|
attr_accessor :max_points
|
|
59
59
|
|
|
60
60
|
# For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions
|
|
61
61
|
attr_accessor :release_grades
|
|
62
62
|
|
|
63
|
-
#
|
|
63
|
+
# Shuffle the worksheet exercises for each student
|
|
64
64
|
attr_accessor :shuffle_exercises
|
|
65
65
|
|
|
66
66
|
attr_accessor :submission_students_mode
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -49,19 +49,19 @@ module FlatApi
|
|
|
49
49
|
# For all assignments created after 02/2023, all the underlying resources must be dedicated and stored in the assignment. This boolean indicates that this assignment only supports dedicated attachments.
|
|
50
50
|
attr_accessor :use_dedicated_attachments
|
|
51
51
|
|
|
52
|
-
# If set, the grading will be enabled for the
|
|
52
|
+
# If set, the grading will be enabled for the assignment
|
|
53
53
|
attr_accessor :max_points
|
|
54
54
|
|
|
55
55
|
# For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions
|
|
56
56
|
attr_accessor :release_grades
|
|
57
57
|
|
|
58
|
-
#
|
|
58
|
+
# Shuffle the worksheet exercises for each student
|
|
59
59
|
attr_accessor :shuffle_exercises
|
|
60
60
|
|
|
61
61
|
# The id of the associated toolset
|
|
62
62
|
attr_accessor :toolset
|
|
63
63
|
|
|
64
|
-
# The number of
|
|
64
|
+
# The number of playbacks authorized on the scores of the assignment.
|
|
65
65
|
attr_accessor :nb_playback_authorized
|
|
66
66
|
|
|
67
67
|
# Restrict the ability to get an audio feedback every time a student adds or selects a note.
|
|
@@ -102,7 +102,7 @@ module FlatApi
|
|
|
102
102
|
# The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.
|
|
103
103
|
attr_accessor :scheduled_date
|
|
104
104
|
|
|
105
|
-
# The due date of this assignment, late submissions will be marked as
|
|
105
|
+
# The due date of this assignment, late submissions will be marked as past due.
|
|
106
106
|
attr_accessor :due_date
|
|
107
107
|
|
|
108
108
|
# Possible modes of assigning assignments
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# A Canvas LMS assignment
|
|
18
18
|
class ClassAssignmentAllOfCanvas < ApiModelBase
|
|
19
|
-
# Unique identifier of the
|
|
19
|
+
# Unique identifier of the assignment on Canvas
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
22
22
|
# Link to Canvas assignment
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module FlatApi
|
|
17
17
|
# A MusicFirst Classroom assignment
|
|
18
18
|
class ClassAssignmentAllOfMfc < ApiModelBase
|
|
19
|
-
# Unique identifier of the
|
|
19
|
+
# Unique identifier of the task on MusicFirst Classroom
|
|
20
20
|
attr_accessor :id
|
|
21
21
|
|
|
22
22
|
# Link to MusicFirst Classroom task
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -35,7 +35,7 @@ module FlatApi
|
|
|
35
35
|
# The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`.
|
|
36
36
|
attr_accessor :attachments
|
|
37
37
|
|
|
38
|
-
# The number of
|
|
38
|
+
# The number of playbacks authorized on the scores of the assignment.
|
|
39
39
|
attr_accessor :nb_playback_authorized
|
|
40
40
|
|
|
41
41
|
# Restrict the ability to get an audio feedback every time a student adds or selects a note.
|
|
@@ -53,13 +53,13 @@ module FlatApi
|
|
|
53
53
|
# The URL of the cover to display
|
|
54
54
|
attr_accessor :cover
|
|
55
55
|
|
|
56
|
-
# If set, the grading will be enabled for the
|
|
56
|
+
# If set, the grading will be enabled for the assignment with this value as the maximum of points
|
|
57
57
|
attr_accessor :max_points
|
|
58
58
|
|
|
59
59
|
# For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions
|
|
60
60
|
attr_accessor :release_grades
|
|
61
61
|
|
|
62
|
-
#
|
|
62
|
+
# Shuffle the worksheet exercises for each student
|
|
63
63
|
attr_accessor :shuffle_exercises
|
|
64
64
|
|
|
65
65
|
attr_accessor :submission_students_mode
|
|
@@ -82,7 +82,7 @@ module FlatApi
|
|
|
82
82
|
# State of the assignment
|
|
83
83
|
attr_accessor :state
|
|
84
84
|
|
|
85
|
-
# The due date of this assignment, late submissions will be marked as
|
|
85
|
+
# The due date of this assignment, late submissions will be marked as past due. If not set, the assignment won't have a due date.
|
|
86
86
|
attr_accessor :due_date
|
|
87
87
|
|
|
88
88
|
# The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
# Attachment creation for an assignment or stream post. This attachment must contain a `score` or
|
|
17
|
+
# Attachment creation for an assignment or stream post. This attachment must contain a `score` or a `url`; its details are resolved and returned as a `MediaAttachment` once the assignment or stream post is created.
|
|
18
18
|
class ClassAttachmentCreation < ApiModelBase
|
|
19
19
|
# The type of the attachment posted: * `rich`, `photo`, `video` are attachment types that are automatically resolved from a `link` attachment. * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property.
|
|
20
20
|
attr_accessor :type
|
|
@@ -22,10 +22,10 @@ module FlatApi
|
|
|
22
22
|
# A unique Flat score identifier. The user creating the assignment must at least have read access to the document. If the user has admin rights, new group permissions will be automatically added for the teachers and students of the class.
|
|
23
23
|
attr_accessor :score
|
|
24
24
|
|
|
25
|
-
#
|
|
25
|
+
# A unique worksheet identifier
|
|
26
26
|
attr_accessor :worksheet
|
|
27
27
|
|
|
28
|
-
#
|
|
28
|
+
# A unique revision identifier of a score
|
|
29
29
|
attr_accessor :revision
|
|
30
30
|
|
|
31
31
|
# The UUID of the instrument part selected for this attachment (for performance submissions)
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -27,7 +27,7 @@ module FlatApi
|
|
|
27
27
|
# The section of the class
|
|
28
28
|
attr_accessor :section
|
|
29
29
|
|
|
30
|
-
# An
|
|
30
|
+
# An optional description for this class
|
|
31
31
|
attr_accessor :description
|
|
32
32
|
|
|
33
33
|
# The unique identifier of the Organization owning this class
|
|
@@ -36,7 +36,7 @@ module FlatApi
|
|
|
36
36
|
# The unique identifier of the User owning this class
|
|
37
37
|
attr_accessor :owner
|
|
38
38
|
|
|
39
|
-
# The date when the class was
|
|
39
|
+
# The date when the class was created
|
|
40
40
|
attr_accessor :creation_date
|
|
41
41
|
|
|
42
42
|
# The date when the class was last modified
|
|
@@ -45,7 +45,7 @@ module FlatApi
|
|
|
45
45
|
# [Teachers only] The enrollment code that can be used by the students to join the class
|
|
46
46
|
attr_accessor :enrollment_code
|
|
47
47
|
|
|
48
|
-
# The theme identifier
|
|
48
|
+
# The theme identifier used in the Flat user interface
|
|
49
49
|
attr_accessor :theme
|
|
50
50
|
|
|
51
51
|
# The number of assignments created in the class
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
# Meta information provided by
|
|
17
|
+
# Meta information provided by Canvas LMS
|
|
18
18
|
class ClassDetailsCanvas < ApiModelBase
|
|
19
19
|
# Unique identifier of the course on Canvas
|
|
20
20
|
attr_accessor :id
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FlatApi
|
|
17
|
-
# Meta information provided by
|
|
17
|
+
# Meta information provided by MusicFirst Classroom
|
|
18
18
|
class ClassDetailsMfc < ApiModelBase
|
|
19
19
|
# Unique identifier of the course on MusicFirst Classroom
|
|
20
20
|
attr_accessor :id
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * 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](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://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 are [available on GitHub](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 2.26.
|
|
6
|
+
The version of the OpenAPI document: 2.26.2
|
|
7
7
|
Contact: developers@flat.io
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.24.0
|