Website : rimsha.abasa.com
backdoor
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
var
/
canvas
/
public
/
doc
/
api
/
Filename :
appointment_groups.json
back
Copy
{ "apiVersion": "1.0", "swaggerVersion": "1.2", "basePath": "https://canvas.managedclass.com/api", "resourcePath": "/appointment_groups", "produces": [ "application/json" ], "apis": [ { "path": "/v1/appointment_groups", "description": "Retrieve the paginated list of appointment groups that can be reserved or\nmanaged by the current user.", "operations": [ { "method": "GET", "summary": "List appointment groups", "notes": "Retrieve the paginated list of appointment groups that can be reserved or\nmanaged by the current user.", "nickname": "list_appointment_groups", "parameters": [ { "paramType": "query", "name": "scope", "description": "Defaults to \"reservable\"", "type": "string", "format": null, "required": false, "deprecated": false, "enum": [ "reservable", "manageable" ] }, { "paramType": "query", "name": "context_codes", "description": "Array of context codes used to limit returned results.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } }, { "paramType": "query", "name": "include_past_appointments", "description": "Defaults to false. If true, includes past appointment groups", "type": "boolean", "format": null, "required": false, "deprecated": false }, { "paramType": "query", "name": "include", "description": "Array of additional information to include.\n\n\"appointments\":: calendar event time slots for this appointment group\n\"child_events\":: reservations of those time slots\n\"participant_count\":: number of reservations\n\"reserved_times\":: the event id, start time and end time of reservations\n the current user has made)\n\"all_context_codes\":: all context codes associated with this appointment group", "type": "array", "format": null, "required": false, "deprecated": false, "enum": [ "appointments", "child_events", "participant_count", "reserved_times", "all_context_codes" ], "items": { "type": "string" } } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups", "description": "Create and return a new appointment group. If new_appointments are\nspecified, the response will return a new_appointments array (same format\nas appointments array, see \"List appointment groups\" action)", "operations": [ { "method": "POST", "summary": "Create an appointment group", "notes": "Create and return a new appointment group. If new_appointments are\nspecified, the response will return a new_appointments array (same format\nas appointments array, see \"List appointment groups\" action)", "nickname": "create_appointment_group", "parameters": [ { "paramType": "form", "name": "appointment_group[context_codes]", "description": "Array of context codes (courses, e.g. course_1) this group should be\nlinked to (1 or more). Users in the course(s) with appropriate permissions\nwill be able to sign up for this appointment group.", "type": "array", "format": null, "required": true, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[sub_context_codes]", "description": "Array of sub context codes (course sections or a single group category)\nthis group should be linked to. Used to limit the appointment group to\nparticular sections. If a group category is specified, students will sign\nup in groups and the participant_type will be \"Group\" instead of \"User\".", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[title]", "description": "Short title for the appointment group.", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "form", "name": "appointment_group[description]", "description": "Longer text description of the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[location_name]", "description": "Location name of the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[location_address]", "description": "Location address.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[publish]", "description": "Indicates whether this appointment group should be published (i.e. made\navailable for signup). Once published, an appointment group cannot be\nunpublished. Defaults to false.", "type": "boolean", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[participants_per_appointment]", "description": "Maximum number of participants that may register for each time slot.\nDefaults to null (no limit).", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[min_appointments_per_participant]", "description": "Minimum number of time slots a user must register for. If not set, users\ndo not need to sign up for any time slots.", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[max_appointments_per_participant]", "description": "Maximum number of time slots a user may register for.", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[new_appointments][X]", "description": "Nested array of start time/end time pairs indicating time slots for this\nappointment group. Refer to the example request.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[participant_visibility]", "description": "\"private\":: participants cannot see who has signed up for a particular\n time slot\n\"protected\":: participants can see who has signed up. Defaults to\n \"private\".", "type": "string", "format": null, "required": false, "deprecated": false, "enum": [ "private", "protected" ] }, { "paramType": "form", "name": "appointment_group[allow_observer_signup]", "description": "Whether observer users can sign-up for an appointment. Defaults to false.", "type": "boolean", "format": null, "required": false, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/{id}", "description": "Returns information for a single appointment group", "operations": [ { "method": "GET", "summary": "Get a single appointment group", "notes": "Returns information for a single appointment group", "nickname": "get_single_appointment_group", "parameters": [ { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "query", "name": "include", "description": "Array of additional information to include. See include[] argument of\n\"List appointment groups\" action.\n\n\"child_events\":: reservations of time slots time slots\n\"appointments\":: will always be returned\n\"all_context_codes\":: all context codes associated with this appointment group", "type": "array", "format": null, "required": false, "deprecated": false, "enum": [ "child_events", "appointments", "all_context_codes" ], "items": { "type": "string" } } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/{id}", "description": "Update and return an appointment group. If new_appointments are specified,\nthe response will return a new_appointments array (same format as\nappointments array, see \"List appointment groups\" action).", "operations": [ { "method": "PUT", "summary": "Update an appointment group", "notes": "Update and return an appointment group. If new_appointments are specified,\nthe response will return a new_appointments array (same format as\nappointments array, see \"List appointment groups\" action).", "nickname": "update_appointment_group", "parameters": [ { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "form", "name": "appointment_group[context_codes]", "description": "Array of context codes (courses, e.g. course_1) this group should be\nlinked to (1 or more). Users in the course(s) with appropriate permissions\nwill be able to sign up for this appointment group.", "type": "array", "format": null, "required": true, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[sub_context_codes]", "description": "Array of sub context codes (course sections or a single group category)\nthis group should be linked to. Used to limit the appointment group to\nparticular sections. If a group category is specified, students will sign\nup in groups and the participant_type will be \"Group\" instead of \"User\".", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[title]", "description": "Short title for the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[description]", "description": "Longer text description of the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[location_name]", "description": "Location name of the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[location_address]", "description": "Location address.", "type": "string", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[publish]", "description": "Indicates whether this appointment group should be published (i.e. made\navailable for signup). Once published, an appointment group cannot be\nunpublished. Defaults to false.", "type": "boolean", "format": null, "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[participants_per_appointment]", "description": "Maximum number of participants that may register for each time slot.\nDefaults to null (no limit).", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[min_appointments_per_participant]", "description": "Minimum number of time slots a user must register for. If not set, users\ndo not need to sign up for any time slots.", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[max_appointments_per_participant]", "description": "Maximum number of time slots a user may register for.", "type": "integer", "format": "int64", "required": false, "deprecated": false }, { "paramType": "form", "name": "appointment_group[new_appointments][X]", "description": "Nested array of start time/end time pairs indicating time slots for this\nappointment group. Refer to the example request.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "appointment_group[participant_visibility]", "description": "\"private\":: participants cannot see who has signed up for a particular\n time slot\n\"protected\":: participants can see who has signed up. Defaults to \"private\".", "type": "string", "format": null, "required": false, "deprecated": false, "enum": [ "private", "protected" ] }, { "paramType": "form", "name": "appointment_group[allow_observer_signup]", "description": "Whether observer users can sign-up for an appointment.", "type": "boolean", "format": null, "required": false, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/{id}", "description": "Delete an appointment group (and associated time slots and reservations)\nand return the deleted group", "operations": [ { "method": "DELETE", "summary": "Delete an appointment group", "notes": "Delete an appointment group (and associated time slots and reservations)\nand return the deleted group", "nickname": "delete_appointment_group", "parameters": [ { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "query", "name": "cancel_reason", "description": "Reason for deleting/canceling the appointment group.", "type": "string", "format": null, "required": false, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/{id}/users", "description": "A paginated list of users that are (or may be) participating in this\nappointment group. Refer to the Users API for the response fields. Returns\nno results for appointment groups with the \"Group\" participant_type.", "operations": [ { "method": "GET", "summary": "List user participants", "notes": "A paginated list of users that are (or may be) participating in this\nappointment group. Refer to the Users API for the response fields. Returns\nno results for appointment groups with the \"Group\" participant_type.", "nickname": "list_user_participants", "parameters": [ { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "query", "name": "registration_status", "description": "Limits results to the a given participation status, defaults to \"all\"", "type": "string", "format": null, "required": false, "deprecated": false, "enum": [ "all", "registered", "registered" ] } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/{id}/groups", "description": "A paginated list of student groups that are (or may be) participating in\nthis appointment group. Refer to the Groups API for the response fields.\nReturns no results for appointment groups with the \"User\" participant_type.", "operations": [ { "method": "GET", "summary": "List student group participants", "notes": "A paginated list of student groups that are (or may be) participating in\nthis appointment group. Refer to the Groups API for the response fields.\nReturns no results for appointment groups with the \"User\" participant_type.", "nickname": "list_student_group_participants", "parameters": [ { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "query", "name": "registration_status", "description": "Limits results to the a given participation status, defaults to \"all\"", "type": "string", "format": null, "required": false, "deprecated": false, "enum": [ "all", "registered", "registered" ] } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/appointment_groups/next_appointment", "description": "Return the next appointment available to sign up for. The appointment\nis returned in a one-element array. If no future appointments are\navailable, an empty array is returned.", "operations": [ { "method": "GET", "summary": "Get next appointment", "notes": "Return the next appointment available to sign up for. The appointment\nis returned in a one-element array. If no future appointments are\navailable, an empty array is returned.", "nickname": "get_next_appointment", "parameters": [ { "paramType": "query", "name": "appointment_group_ids", "description": "List of ids of appointment groups to search.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "string" } } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "array", "items": { "$ref": "CalendarEvent" } } ] } ], "models": { "Appointment": { "id": "Appointment", "description": "Date and time for an appointment", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "id": { "description": "The appointment identifier.", "example": 987, "type": "integer" }, "start_at": { "description": "Start time for the appointment", "example": "2012-07-20T15:00:00-06:00", "type": "datetime" }, "end_at": { "description": "End time for the appointment", "example": "2012-07-20T15:00:00-06:00", "type": "datetime" } } }, "AppointmentGroup": { "id": "AppointmentGroup", "description": "", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "id": { "description": "The ID of the appointment group", "example": 543, "type": "integer" }, "title": { "description": "The title of the appointment group", "example": "Final Presentation", "type": "string" }, "start_at": { "description": "The start of the first time slot in the appointment group", "example": "2012-07-20T15:00:00-06:00", "type": "datetime" }, "end_at": { "description": "The end of the last time slot in the appointment group", "example": "2012-07-20T17:00:00-06:00", "type": "datetime" }, "description": { "description": "The text description of the appointment group", "example": "Es muy importante", "type": "string" }, "location_name": { "description": "The location name of the appointment group", "example": "El Tigre Chino's office", "type": "string" }, "location_address": { "description": "The address of the appointment group's location", "example": "Room 234", "type": "string" }, "participant_count": { "description": "The number of participant who have reserved slots (see include[] argument)", "example": 2, "type": "integer" }, "reserved_times": { "description": "The start and end times of slots reserved by the current user as well as the id of the calendar event for the reservation (see include[] argument)", "example": [ { "id": 987, "start_at": "2012-07-20T15:00:00-06:00", "end_at": "2012-07-20T15:00:00-06:00" } ], "type": "array", "items": { "$ref": "Appointment" } }, "allow_observer_signup": { "description": "Boolean indicating whether observer users should be able to sign-up for an appointment", "example": false, "type": "boolean" }, "context_codes": { "description": "The context codes (i.e. courses) this appointment group belongs to. Only people in these courses will be eligible to sign up.", "example": [ "course_123" ], "type": "array", "items": { "type": "string" } }, "sub_context_codes": { "description": "The sub-context codes (i.e. course sections and group categories) this appointment group is restricted to", "example": [ "course_section_234" ], "type": "array", "items": { "type": "integer" } }, "workflow_state": { "description": "Current state of the appointment group ('pending', 'active' or 'deleted'). 'pending' indicates that it has not been published yet and is invisible to participants.", "example": "active", "type": "string", "allowableValues": { "values": [ "pending", "active", "deleted" ] } }, "requiring_action": { "description": "Boolean indicating whether the current user needs to sign up for this appointment group (i.e. it's reservable and the min_appointments_per_participant limit has not been met by this user).", "example": true, "type": "boolean" }, "appointments_count": { "description": "Number of time slots in this appointment group", "example": 2, "type": "integer" }, "appointments": { "description": "Calendar Events representing the time slots (see include[] argument) Refer to the Calendar Events API for more information", "example": [], "type": "array", "items": { "$ref": "CalendarEvent" } }, "new_appointments": { "description": "Newly created time slots (same format as appointments above). Only returned in Create/Update responses where new time slots have been added", "example": [], "type": "array", "items": { "$ref": "CalendarEvent" } }, "max_appointments_per_participant": { "description": "Maximum number of time slots a user may register for, or null if no limit", "example": 1, "type": "integer" }, "min_appointments_per_participant": { "description": "Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots", "example": 1, "type": "integer" }, "participants_per_appointment": { "description": "Maximum number of participants that may register for each time slot, or null if no limit", "example": 1, "type": "integer" }, "participant_visibility": { "description": "'private' means participants cannot see who has signed up for a particular time slot, 'protected' means that they can", "example": "private", "type": "string", "allowableValues": { "values": [ "private", "protected" ] } }, "participant_type": { "description": "Indicates how participants sign up for the appointment group, either as individuals ('User') or in student groups ('Group'). Related to sub_context_codes (i.e. 'Group' signups always have a single group category)", "example": "User", "type": "string", "allowableValues": { "values": [ "User", "Group" ] } }, "url": { "description": "URL for this appointment group (to update, delete, etc.)", "example": "https://example.com/api/v1/appointment_groups/543", "type": "string" }, "html_url": { "description": "URL for a user to view this appointment group", "example": "http://example.com/appointment_groups/1", "type": "string" }, "created_at": { "description": "When the appointment group was created", "example": "2012-07-13T10:55:20-06:00", "type": "datetime" }, "updated_at": { "description": "When the appointment group was last updated", "example": "2012-07-13T10:55:20-06:00", "type": "datetime" } } } } }