AssignmentCopyResponse.md

FlatApi::AssignmentCopyResponse

Properties

Name	Type	Description	Notes
id	String	Unique identifier of the assignment
type	AssignmentType
capabilities	AssignmentCapabilities
title	String	Title of the assignment
description	String	Student instructions and content of the assignment (plain text)	[optional]
description_html	String	HTML version of student instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs.	[optional]
teacher_instructions	String	Teacher-only instructions for this assignment. These instructions are only visible to teachers and are not returned when students view the assignment. If `teacherInstructionsHtml` is provided, this field will contain the plain text version for compatibility.	[optional]
teacher_instructions_html	String	HTML version of teacher-only instructions with rich text formatting. Supports the following HTML tags: p, br, strong, b, em, i, u, a, ul, ol, li, h1, h2, h3, img. Images are served as absolute http(s) URLs.	[optional]
cover	String	The URL of the cover to display	[optional]
cover_file	String	The id of the cover to display	[optional]
attachments	Array<MediaAttachment>	Reference material handed to the students with the assignment: scores, videos, links and Drive files. A score attached here is the one each student receives their own copy of.
use_dedicated_attachments	Boolean	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.	[optional]
max_points	Float	If set, the grading will be enabled for the assignment	[optional]
release_grades	String	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	[optional]
shuffle_exercises	Boolean	Shuffle the worksheet exercises for each student	[optional]
toolset	String	The id of the associated toolset	[optional]
nb_playback_authorized	Float	The number of playbacks authorized on the scores of the assignment.	[optional]
restrict_play_note	Boolean	Restrict the ability to get an audio feedback every time a student adds or selects a note.	[optional]
restrict_to_audio_tracks	Boolean	Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback.	[optional]
submission_students_mode	AssignmentSubmissionStudentsMode		[optional]
recording_type	String	For performance assignments: recording type that will be either 'audio' or 'video'. * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording. Only set when type is 'performance'.	[optional]
allow_metronome	Boolean	For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'.	[optional]
allow_backing_track	Boolean	For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'.	[optional]
allow_speed_change	Boolean	For performance assignments: whether students can adjust the playback speed of the score during recording. * `true`: Students can change the tempo/speed during practice and recording * `false`: Tempo is fixed to the original score tempo Only set when type is 'performance'.	[optional]
free_record	Boolean	For performance assignments: &quot;Free Record&quot; mode. When `true`, no score is attached to the assignment. Students freely record a varied repertoire or an ensemble performance without being constrained by a single score's structure or duration, and all score-dependent options (playback, metronome, backtracking, speed control) are hidden. Only set when type is 'performance'.	[optional]
resource	String	If this assignment is stored as a resource in the Flat for Education Resource Library, the unique identifier of the resource.	[optional]

Example

require 'flat_api'

instance = FlatApi::AssignmentCopyResponse.new(
  id: null,
  type: null,
  capabilities: null,
  title: null,
  description: null,
  description_html: null,
  teacher_instructions: null,
  teacher_instructions_html: null,
  cover: null,
  cover_file: null,
  attachments: null,
  use_dedicated_attachments: null,
  max_points: null,
  release_grades: null,
  shuffle_exercises: null,
  toolset: null,
  nb_playback_authorized: null,
  restrict_play_note: null,
  restrict_to_audio_tracks: null,
  submission_students_mode: null,
  recording_type: null,
  allow_metronome: null,
  allow_backing_track: null,
  allow_speed_change: null,
  free_record: null,
  resource: null
)