Releases · FlatIO/api-reference

Scores & Library:
- GET /users/{user}/scores: As planned in 2020, this endpoint has been updated to only return public scores for user community profiles. The endpoint has also a new pagination system and sorting options.
- ScoreDetails: Added editHtmlUrl, instrumentsNames and scheduledDeletionDate properties.
- Collection: Added contents.scoresCount property.
Flat Community profiles:
- UserPublic now includes likesCount and playsCount properties.
Flat for Education:
- GET /eduResources:
  - Added options withoutSubfoldersResources, assignmentTypes, subjects, and grades to filter content.
  - Added new response headers X-Total-Assignments-Count and X-Total-Folders-Count.
- EduResource: Added sharingDescription, subjects, grades and capabilities.canChangePrivacy properties.
- EduResourceFolder: Added assignmentsTypes and resourcesCount properties.
- Assignment: Added restrictPlayNote and restrictToAudioTracks properties.
- AssignmentSubmission: Updated LTI to support LTI 1.1 and 1.3 (lti.gradeService property).
- ScoreTrack: Added purpose property.

Keep rights property optional on ScoreDetails

Accounts:
- feat(account): Added pagination to GET /users/{user}/likes and fixed typo in operationId.
- feat(account): Added product on UserDetails to know the product the user is using.
Score Library:
- feat(library): Added collaboratorType to ResourceRights to know if the user accessing a resource is the owner, user or group collaborator. Adjusted non-optional properties on ResourceRights.
- feat(library): Added date to ResourceCollaborator with the date the collaborator was added.
- feat(score): Added new mainKeySignature, highlightedDate and organization properties to ScoreDetails. Adjusted non-optional properties on ScoreDetails.
- feat(score): Added new purpose property to ScoreTrack. Adjusted non-optional properties on ScoreTrack.
- feat(score): Added new googleDriveDisabled option when copying score (POST /scores/{score}/fork).
Flat for Education:
- feat(edu): Some Flat for Education invitatons can be re-used multiple times.
- fix(edu): Flat for Education invitatons can only be used to create admin or teacher accounts, fixed organizationRole enum.
- feat(edu): Added new verifyIfNotAlreadyInResourceLibrary option to POST /classes/{class}/assignments/{assignment}/copy to avoid copying to the Resource Library if the assignment is already in it.
- fix(edu): Fixed ClassAttachmentCreation enum values to reflect the current state of our product.
- feat(edu): Added playback and lti properties to AssignmentSubmission.
- fix(edu): comments object has never been available in AssignmentSubmissionUpdate, only in AssignmentSubmission.
- feat(edu): Added graded state for submissions.
- feat(edu): Added organizationResources library type to GET /eduResources/libraries, and added organizationPublic enum value to EduResourcePrivacy.
- feat(edu): Added new privacy property to PUT /eduResources/{resource}
- fix(edu): Removed unused property alternateLink from MicrosoftGraphSubmission.
fix(schema): missing required: true on some POST/PUT bodies.

feat(edu): added new POST /eduResources/{resource}/createLtiLink endpoint to create LTI links from Flat for Education resources.
feat(edu): maximum graded has been increased from 100 to 10000.
feat(score): new nullable properties in PUT /scores/{score} to unset properties (subtitle, composer, lyricist, arranger, description, creationType, license, licenseText).
fix(score): wrong user object in ScoreSummary, returned object has more properties than the specification (UserPublic).
fix(spec): various properties marked as required as they will always be returned.

feat(edu): Released Resource Library API in beta (/eduResources) with new OAuth 2 scopes edu.resources and edu.resources.readonly.
feat(edu): Updated POST /classes/{class}/assignments/{assignment}/copy to allow to copy to Resource Library.
feat(edu): Updated DELETE /classes/{class}/assignments/{assignment}/submissions/{submission} behavior, now only resets the submission instead of deleting it.
feat(edu): Added POST /classes/{class}/testStudent to create testing student accounts.
feat(edu): Operation POST /classes/{class}/assignments has been renamed from createAssignment -> createClassAssignment in schema.
feat(edu): Assignment models now include a new capabilities property returning which actions are possible with a specific resource (canEdit, canPublishInClass, canPublishInClassError, canArchive, canUnarchive).
feat(edu): Assignment models now include a new useDedicatedAttachments property to know if the underlying resources are dedicated and stored inside the assignment (new behavior with the resource library).
feat(edu): ClassAssignment now includes a new issue property to return any issues encountered with the assignment.
feat(edu): toolset id provided when creating or updated assignments will now make a copy of the toolset to have a dedicated object for the assignment.
feat(edu): AssignmentSubmissionHistory now includes the source of the change, when this one comes from a third party (Google Classroom, Microsoft Teams, LTI). It also includes the following new properties: dueDate, comment and attachment.title.
feat(edu): UserDetails now contains Microsoft Sign in details (azureDetails) and list of groups the user is part of (groups).
feat(edu): Added optional metadata on class objects (level, skillsFocused, size).
fix(edu): Fixed ClassAttachmentCreation enum values to reflect the current state of our product.
feat(scores): Updated GET /scores/{score}/revisions/{revision} now returns the startDate and endDate for the score revisions.
feat(scores): Updated POST /scores to add hasQuarterTone on score builders to enable quarter tones on score parts.
feat(scores): Updated POST /scores/{score}/fork to add option to keep original title during a file copy (keepOriginalTitle).
fix(schema): Added missing required properties on models ScoreSummary, MediaAttachment and FlatErrorResponse.

feat(collections): Add new dedicated App Collections. When creating new scores, by default Flat will add the scores to a dedicated collection for the 3rd party app. This collection is automatically created in the user account and has a new alias app that can be used in the URLs paths.

feat(scores): added POST /scores/{score}/revisions/{revision}/{format}/task to create a new export task for a score and GET /tasks/{task} to fetch the progress of an export task.

feat(edu): added POST /organizations/users/{user}/signinLink to allow admins to create sign in links for their organization's users.
feat(edu): added POST /organizations/users/{user}/accessToken to allow admins to create delegated access tokens for their organization's users.
feat(locale): added ja-HIRA
feat(comments): added moderation object on public comments
feat(scores): added defaultTrack option to GET /scores/{score}/revisions/{revision}/{format} to return mp3 tracks when a mp3 is set as default track.
DEPRECATED: removed onlyCached option from GET /scores/{score}/revisions/{revision}/{format} since only cached files are now returned for audio exports.

feat(scores): POST /v2/scores has a new score builder to easily create blank scores without the need of importing a MusicXML file. Provide a list of instruments to use, and optionally customize the time signature, key signature, enable TABs, Chord grids as well as the page layout.
feat(edu): POST /v2/organizations/users has support for roles.
feat(edu): added new shuffleExercises option for worksheets.
feat(edu): added new exercisesIds in students submissions.

feat(scores): GET /scores/{score}/tracks has new query strings:
- listAutoTrack to fetch tracks automatically generated & synced (playback available as a MP3 file).
- assignment to filter tracks related to a Flat for Education assignment.
feat(scores): added GET /scores/{score}/revisions/{revision}/synchronizationPoints to fetch synchronization points automatically generated from latest MP3 playback file.
feat(scores): GET /scores/{score}/revisions/{revision}/{format} has a new query string url to fetch the CDN URL of the exported file in the JSON body.
feat(edu): added DELETE /classes/{class}/assignments/{assignment}/submissions/{submission} to let teachers reset students' submissions.
feat(edu): added detected issues on classes with the list fo accounts that couldn't be added to the classes during synchronizations.
feat(edu): added microsoftGraph property on assignments with the Microsoft Teams assignments state, URLs (alternateLink) and categories.
feat(edu): added microsoftGraph property on submissions with the Microsoft Teams submissions state and URLs (alternateLink).
feat(edu): POST /classes/{class}/assignments/{assignment}/copy has a new property scheduledDate to schedule assignments copies.
feat(edu): added track property to submissions for performance assigments saved audio tracks.
feat(account): added a coverPicture property with the URL of the profile cover picture, and pictureFile and coverPictureFile containing the ID of the corresponding files.
feat(account): GET /me has a new onlyId query string to quickly fetch current user id.

Search code, repositories, users, issues, pull requests...

Releases: FlatIO/api-reference

v2.21.0

Uh oh!

v2.20.1

Uh oh!

v2.20.0

Uh oh!

v2.19.0

Uh oh!

v2.18.0

Uh oh!

v2.17.0

Uh oh!

v2.16.0

Uh oh!

v2.15.0

Uh oh!

v2.14.0

Uh oh!

v2.13.0

Uh oh!