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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * Brow
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.flat.io/v2
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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 (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing ed
| method | path | what the vendor says it does |
|---|---|---|
GET | /classes | List the classes available for the current user Class |
POST | /classes | Create a new class Classrooms on Flat allow you to create activities with assignments and post content to a sp |
POST | /classes/enroll/{enrollmentCode} | Join a class Use this method to join a class using an enrollment code given one of the teacher of this class. |
GET | /classes/{class} | Get the details of a single class Class |
PUT | /classes/{class} | Update the class Update the meta information of the class Class |
POST | /classes/{class}/activate | Activate the class Mark the class as `active`. This is mainly used for classes synchronized from Clever that a |
POST | /classes/{class}/archive | Archive the class Mark the class as `archived`. When this course is synchronized with another app, like Google |
DELETE | /classes/{class}/archive | Unarchive the class Mark the class as `active`. When this course is synchronized with another app, like Google |
GET | /classes/{class}/assignments | Assignments listing Class |
POST | /classes/{class}/assignments | Assignment creation Use this method as a teacher to create and post a new assignment to a class. If the class |
POST | /classes/{class}/assignments/{assignment}/archive | Archive the assignment Archive the assignment Class |
DELETE | /classes/{class}/assignments/{assignment}/archive | Unarchive the assignment. Mark the assignment as `active`. Class |
POST | /classes/{class}/assignments/{assignment}/copy | Copy an assignment Copy an assignment to a specified class. If the original assignment has a due date in the |
GET | /classes/{class}/assignments/{assignment}/submissions | List the students' submissions Class |
PUT | /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission Use this method as a student to create, update and submit a submission related to |
GET | /classes/{class}/assignments/{assignment}/submissions/csv | CSV Grades exports Export list of submissions grades to a CSV file Class |
GET | /classes/{class}/assignments/{assignment}/submissions/excel | Excel Grades exports Export list of submissions grades to an Excel file Class |
GET | /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission Class |
PUT | /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission Use this method as a teacher to update the different submission and give feedback. Teachers |
DELETE | /classes/{class}/assignments/{assignment}/submissions/{submission} | Delete a submission Use this method as a teacher to delete a submission and allow student to start over the as |
GET | /classes/{class}/assignments/{assignment}/submissions/{submission}/comments | List the feedback comments of a submission Class |
POST | /classes/{class}/assignments/{assignment}/submissions/{submission}/comments | Add a feedback comment to a submission Class |
PUT | /classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment} | Update a feedback comment to a submission Class |
DELETE | /classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment} | Delete a feedback comment to a submission Class |
GET | /classes/{class}/assignments/{assignment}/submissions/{submission}/history | Get the history of the submission For teachers only. Returns a detailed history of the submission. This curren |
GET | /classes/{class}/students/{user}/submissions | List the submissions for a student Use this method as a teacher to list all the assignment submissions sent by |
PUT | /classes/{class}/users/{user} | Add a user to the class This method can be used by a teacher of the class to enroll another Flat user into the |
DELETE | /classes/{class}/users/{user} | Remove a user from the class This method can be used by a teacher to remove a user from the class, or by a stu |
GET | /collections | List the collections Use this method to list the user's collections contained in `parent` (by default in the ` |
POST | /collections | Create a new collection This method will create a new collection and add it to your `root` collection. Collect |
GET | /collections/{collection} | Get collection details Collection |
PUT | /collections/{collection} | Update a collection's metadata Collection |
DELETE | /collections/{collection} | Delete the collection This method will schedule the deletion of the collection. Until deleted, the collection |
GET | /collections/{collection}/scores | List the scores contained in a collection Use this method to list the scores contained in a collection. If no |
PUT | /collections/{collection}/scores/{score} | Add a score to the collection This operation will add a score to a collection. The default behavior will make |
DELETE | /collections/{collection}/scores/{score} | Delete a score from the collection This method will delete a score from the collection. Unlike [`DELETE /score |
POST | /collections/{collection}/untrash | Untrash a collection This method will restore the collection by removing it from the `trash` and add it back t |
GET | /groups/{group} | Get group information Group |
GET | /groups/{group}/scores | List group's scores Get the list of scores shared with a group. Group Score |
GET | /groups/{group}/users | List group's users Group |
and 41 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/FlatIO/api-reference/master/spec/swagger.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.