Bot releases are hidden (Show)
rights
property optional on ScoreDetails
Published by gierschv 8 months ago
GET /users/{user}/likes
and fixed typo in operationId.product
on UserDetails
to know the product the user is using.collaboratorType
to ResourceRights
to know if the user accessing a resource is the owner, user or group collaborator. Adjusted non-optional properties on ResourceRights
.date
to ResourceCollaborator
with the date the collaborator was added.mainKeySignature
, highlightedDate
and organization
properties to ScoreDetails
. Adjusted non-optional properties on ScoreDetails
.purpose
property to ScoreTrack
. Adjusted non-optional properties on ScoreTrack
.googleDriveDisabled
option when copying score (POST /scores/{score}/fork
).admin
or teacher
accounts, fixed organizationRole
enum.verifyIfNotAlreadyInResourceLibrary
option to POST /classes/{class}/assignments/{assignment}/copy
to avoid copying to the Resource Library if the assignment is already in it.ClassAttachmentCreation
enum values to reflect the current state of our product.playback
and lti
properties to AssignmentSubmission
.comments
object has never been available in AssignmentSubmissionUpdate
, only in AssignmentSubmission
.graded
state for submissions.organizationResources
library type to GET /eduResources/libraries
, and added organizationPublic
enum value to EduResourcePrivacy
.privacy
property to PUT /eduResources/{resource}
alternateLink
from MicrosoftGraphSubmission
.required: true
on some POST/PUT bodies.Published by gierschv about 1 year ago
POST /eduResources/{resource}/createLtiLink
endpoint to create LTI links from Flat for Education resources.PUT /scores/{score}
to unset properties (subtitle
, composer
, lyricist
, arranger
, description
, creationType
, license
, licenseText
).ScoreSummary
, returned object has more properties than the specification (UserPublic
).Published by gierschv over 1 year ago
/eduResources
) with new OAuth 2 scopes edu.resources
and edu.resources.readonly
.POST /classes/{class}/assignments/{assignment}/copy
to allow to copy to Resource Library.DELETE /classes/{class}/assignments/{assignment}/submissions/{submission}
behavior, now only resets the submission instead of deleting it.POST /classes/{class}/testStudent
to create testing student accounts.POST /classes/{class}/assignments
has been renamed from createAssignment
-> createClassAssignment
in schema.Assignment
models now include a new capabilities
property returning which actions are possible with a specific resource (canEdit
, canPublishInClass
, canPublishInClassError
, canArchive
, canUnarchive
).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).ClassAssignment
now includes a new issue
property to return any issues encountered with the assignment.toolset
id provided when creating or updated assignments will now make a copy of the toolset to have a dedicated object for the assignment.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
.UserDetails
now contains Microsoft Sign in details (azureDetails
) and list of groups the user is part of (groups
).level
, skillsFocused
, size
).ClassAttachmentCreation
enum values to reflect the current state of our product.GET /scores/{score}/revisions/{revision}
now returns the startDate
and endDate
for the score revisions.POST /scores
to add hasQuarterTone
on score builders to enable quarter tones on score parts.POST /scores/{score}/fork
to add option to keep original title during a file copy (keepOriginalTitle
).ScoreSummary
, MediaAttachment
and FlatErrorResponse
.Published by gierschv over 2 years ago
app
that can be used in the URLs paths.Published by gierschv almost 3 years ago
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.Published by gierschv almost 3 years ago
POST /organizations/users/{user}/signinLink
to allow admins to create sign in links for their organization's users.POST /organizations/users/{user}/accessToken
to allow admins to create delegated access tokens for their organization's users.ja-HIRA
moderation
object on public commentsdefaultTrack
option to GET /scores/{score}/revisions/{revision}/{format}
to return mp3 tracks when a mp3 is set as default track.onlyCached
option from GET /scores/{score}/revisions/{revision}/{format}
since only cached files are now returned for audio exports.Published by gierschv about 3 years ago
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.POST /v2/organizations/users
has support for roles.shuffleExercises
option for worksheets.exercisesIds
in students submissions.Published by gierschv over 3 years ago
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.GET /scores/{score}/revisions/{revision}/synchronizationPoints
to fetch synchronization points automatically generated from latest MP3 playback file.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.DELETE /classes/{class}/assignments/{assignment}/submissions/{submission}
to let teachers reset students' submissions.issues
on classes with the list fo accounts that couldn't be added to the classes during synchronizations.microsoftGraph
property on assignments with the Microsoft Teams assignments state
, URLs (alternateLink
) and categories
.microsoftGraph
property on submissions with the Microsoft Teams submissions state
and URLs (alternateLink
).POST /classes/{class}/assignments/{assignment}/copy
has a new property scheduledDate
to schedule assignments copies.track
property to submissions for performance assigments saved audio tracks.coverPicture
property with the URL of the profile cover picture, and pictureFile
and coverPictureFile
containing the ID of the corresponding files.GET /me
has a new onlyId
query string to quickly fetch current user id.Published by gierschv over 3 years ago
ResourceCollaborator
now includes a invited
boolean property to know if the collaborator is still a pending invite.GET /classes/{class}/assignments/{assignment}/submissions/csv
and /classes/{class}/assignments/{assignment}/submissions/excel
)POST /classes/{class}/assignments
) and assignments objects now include a type
(AssignmentType
).Assignment
) now include a cover URL (cover
) and the corresponding file identifier (`coverFile).POST /classes/{class}/assignments/{assignment}/copy
) now accepts an optional assigment
identifier. This can be used to override a draft assignment with the content from another assignment.Published by gierschv almost 4 years ago
PUT /organizations/users/{user}
has new parameters to edit accounts: username
, firstname
, lastname
, email
.POST /classes/{class}/assignments
has new parameters:
toolset
id to enable a toolset for the assignment.nbPlaybackAuthorized
to limit the number of time the playback can be usedmaxPoints
for grading purposegoogleClassroom.topicId
to add the assignment under a specific Google Classroom course topicassigneeMode
and assignedStudents
to assign specific studentslockScoreTemplate
to lock assigned templatesdueDate
and scheduledDate
are nullable to unset propertiesPUT /classes/{class}/assignments/{assignment}/submissions
has:
draftGrade
, grade
)return
) andcomments
)AssignmentSubmission
now includes maxPoints
for the maximum number of points when the grade was set./classes/{class}/assignments/{assignment}/submissions/{submission}/comments
to create, list, update and delete comments for the submission.GET /scores/{score}/revisions/{revision}/{format}
query string parts
now only accepts parts UUIDs.GET /organizations/users
query string licenseExpirationDate
now also accepts active
and notActive
values, and has a new query option onlyIds
PUT /classes/{class}/assignments/{assignment}/submissions
parameters studentComment
and returnFeedback
have been removed. returnFeedback
has been replace by a boolean return
to return a submission as a teacher.Published by gierschv over 4 years ago
POST /v2/organizations/users
now accepts optional firstname
and lastname
GET /v2/organizations/users
now accepts sort options and filtersGET /v2/organizations/users/count
to count users matching specified filtersrole
property from POST /organizations/invitations
(previously renamed to organizationRole
)POST/DELETE /v2/classes/{class}/assignments/{assignment}/archive
to archive/unarchive assignmentsGET /v2/classes/{class}/assignments/{assignment}
now includes the main type of the assignment: newScore
, scoreTemplare
or sharedWriting
.GET /v2/groups/{group}/users
can now be filtered by the sync source: googleClassroom
, microsoftGraph
or clever
.GET /v2/scores/{score}
(and similar) now includes the audio samples list used by our playback. The instruments
property now includes a normalized list of instruments that is not dependent from the samples used.Published by gierschv almost 5 years ago
GET/PUT /v2/scores/{score}
:
arranger
property has been addedplays
statistics are now returned (ScorePlaysCounts
)now
proprty on the DELETE
method to schedule a deletion to be executed shortly (avoid keeping in trash)MediaAttachment
and ClassAttachmentCreation
) have new type googleDrive
for attached Drive file, and a new googleDriveFileId
property. If the attachment is a googleDrive
item, the iconUrl
and mimeType
properties are also returnedmicrosoftGraph
info to ClassDetails
(e.g. GET /v2/classes
and GET /v2/classes/{class}
)firstname
and lastname
properties for education accountsPublished by gierschv over 5 years ago
PUT /v2/scores/{score}
:
subtitle
, composer
, lyricist
and licenseText
properties has been addedtitle
, subtitle
, composer
, lyricist
and licenseText
via the API, the modifications events will be pushed to our real-time engine, and a new version will be scheduled (asynchronous)description
can now be up to 2000 characters (was previously 1000)created
, turnedIn
, returned
)event
when fetching a revision metadata (UUID)tr
)appStore
isFlatTeam
property to public profilesUserInstruments
, ResourceSharingKey
, ScoreData
, ScoreDataEncoding
, CollectionTitle
Published by gierschv about 6 years ago
produces
and consumes
on endpoints instead of globallyfilename
when importing scoresparent
collection can now be a collection id when listing collectionscreationDate
property in collection detailsstaffUuid
for contextualized comments, which will completely replace staffIdx
in the futureisCollaborator
boolean property with the Score or Collection rightsPublished by gierschv over 6 years ago
POST /collections
: Create new collectionGET /collections
: List collectionsGET /collections/{collection}
: Get collection detailsPUT /collections/{collection}
: Update collection detailsDELETE /collections/{collection}
: Delete collectionPOST /collections/{collection}/untrash
: Untrash collectionGET /collections/{collection}/scores
: List scores contained in a collectionPUT /collections/{collection}/scores/{score}
: Add a score to a collectionDELETE /collections/{collection}/scores/{score}
: Remove a score from a collectioncollections.readonly
: Allow read-only access to a user's collections.collections.add_scores
: Allow to add scores to a user's collections.collections
: Full, permissive scope to access all of a user's collections.POST /v2/scores/{score}/untrash
)DELETE /v2/scores/{score}
can now be used without admin rights. This new behavior will unshare the score from the current account.POST /scores/{score}/fork
now accepts a collection identifier to copy a score to a specific collection.type
(document
or inline
).ScoreRights
-> ResourceRights
ScoreCollaborator
-> ResourceCollaborator
ScoreCollaboratorCreation
-> ResourceCollaboratorCreation
ResourceSharingKey
GET /scores/{score}/revisions/{revision}/{format}
no longer support part indexes for single/set of parts exports, but our own part UUIDs.GET /users/{user}/scores
will no longer list private and shared scores, but only public scores of a Flat account.Published by gierschv over 6 years ago
Published by gierschv over 6 years ago
pattern
(UserCreation.username
).Published by gierschv over 6 years ago
/v2/scores/{score}/tracks
.Published by gierschv about 7 years ago
PUT /v2/scores/{score}
:
subtitle
, lyricist
, composer
, description
, tags
, creationType
, license
, licenseText
, durationTime
, numberMeasures
, mainTempoQpm
, publicationDate
.PUT /v2/scores/{score}
: Remove title
property, this one can be updated by saving a new revision of the score data.PUT /v2/scores/{score}
: New settable properties: description
, tags
, creationType
, license
.