GET
/integration/v1/users/{user_id}/calendar
Get calendar events for a user
Get calendar events for a user
operationId Get calendar events for a user
معلمات المسار
| الاسم | النوع | الإلزامية | الوصف |
|---|---|---|---|
user_id
|
string (uuid) | مطلوب | User id |
معلمات الاستعلام
| الاسم | النوع | الإلزامية | الوصف |
|---|---|---|---|
date_start
|
string (date) | اختياري | Start date (YYYY-MM-DD) |
date_end
|
string (date) | اختياري | End date (YYYY-MM-DD) |
lang
|
string | اختياري | Language code |
event_type
|
string | اختياري | Event type enum: ``, `online`, `online_zoom`, `offline` |
event_status
|
string | اختياري | Event status enum: ``, `registration_not_started`, `registration`, `registration_closed`, `started`, `finished` |
student_status
|
string | اختياري | Student status enum: ``, `review`, `approved`, `rejected`, `canceled_by_user`, `attended`, … |
access_type
|
string | اختياري | Access type filter (access_opens_date, access_closes_date, pass_due_date) enum: ``, `access_opens_date`, `access_closes_date`, `pass_due_date` |
الاستجابات
200
نص application/json
| الحقل | النوع | الإلزامية | الوصف |
|---|---|---|---|
assignments
|
array | مطلوب | |
entity_type
|
string | مطلوب | enum: `course`, `learning_path`, `skill_path`, `course_list` |
event_type
|
string | مطلوب | enum: `access_opens_date`, `access_closes_date`, `pass_due_date` |
date
|
string (date-time) | مطلوب | |
title
|
string | مطلوب | |
id
|
string | مطلوب | |
entity_data
|
object | اختياري | |
events
|
array | مطلوب | |
event_id
|
string (uuid) | مطلوب | Event GUID |
course_id
|
string | مطلوب | Course GUID |
ceid
|
integer | مطلوب | Content enumeration ID |
course_title
|
string | مطلوب | Course title |
event_title
|
string | اختياري | Event title |
event_description
|
string | اختياري | Event description |
terms_of_use
|
string | اختياري | Terms of use |
date_start
|
string (date-time) | مطلوب | Event start date |
reg_date_start
|
string (date-time) | مطلوب | Event registration start date |
reg_date_end
|
string (date-time) | مطلوب | Event registration end date |
type
|
string | مطلوب | enum: `online`, `online_zoom`, `offline` |
is_certificate
|
boolean | اختياري | Flag, defines if this event creates certificate or not |
is_webinar_published
|
boolean | اختياري | Flag, defines if webinar was published |
is_terms_of_use_enabled
|
boolean | اختياري | Flag, defines if "Terms of Use" enabled |
teacher
|
string | اختياري | Teacher name |
capacity
|
integer | مطلوب | Event capacity |
capacity_min
|
integer | مطلوب | Event minimal capacity |
duration
|
integer | مطلوب | Event duration |
event_status
|
string | اختياري | Event status enum: `registration_not_started`, `registration`, `registration_closed`, `started`, `finished` |
remaining
|
integer | مطلوب | Remaining number of sits for this event |
student_capacity
|
integer | اختياري | LMS-3092: seats of the requesting student's capacity bucket; null when the event has no capacity rules |
student_remaining
|
integer | اختياري | LMS-3092: remaining seats of the requesting student's capacity bucket; null when the event has no capacity rules |
student_status
|
string | اختياري | Event student status enum: `review`, `approved`, `rejected`, `canceled_by_user`, `attended`, `missed`, … |
date_review
|
string (date-time) | مطلوب | Date, when event was reviewed |
date_checked
|
string (date-time) | مطلوب | Date, when event was checked |
is_justification_required
|
boolean | اختياري | Is justification required flag |
final_justification_status
|
string | اختياري | enum: `approved`, `rejected`, `review` |
justification_comment
|
string | اختياري | Student justification comment |
justification_file
|
string | اختياري | Student justification file url |
justification_file_name
|
string | اختياري | Student justification origin file name |
justification_date
|
string (date-time) | اختياري | Student justification date |
justification_id
|
string (uuid) | اختياري | Student justification id |
justification_review_comment
|
string | اختياري | Student justification review comment |
justification_review_date
|
string (date-time) | اختياري | Student justification review date |
approvers
|
array | مطلوب | List of course event approvers |
event_approver_id
|
string (uuid) | مطلوب | Event approver id |
admin_id
|
string (uuid) | اختياري | Admin id |
approver_type
|
string | مطلوب | Approver type enum: `line_manager`, `specific_approver` |
approver_api_user_id
|
string (uuid) | اختياري | Approver api user id |
it_is_me
|
boolean | اختياري | It is me flag |
order
|
integer | مطلوب | Approver order |
full_name
|
string | مطلوب | Approver full name |
decision_date
|
string (date-time) | اختياري | Decision date |
email
|
string | اختياري | Approver email |
comment
|
string | اختياري | Comment |
status
|
string | اختياري | Approver status enum: `approved`, `rejected`, `review`, `rejected`, `approved` |
feedback_required
|
boolean | اختياري | Whether feedback is required for this class course |
has_submitted_feedback
|
boolean | اختياري | Whether the student has already submitted feedback for this course |
student_rating
|
integer | اختياري | FB-542: the student's own 1-5 star rating of this event, null when not rated |
rating_submitted_at
|
string | اختياري | FB-542: when the rating was last submitted/updated (UTC), null when not rated |
rating_eligible
|
boolean | اختياري | FB-542: whether the student may rate this event (registered + attended + event ended) |
date_end
|
string (date-time) | اختياري | LMS-3089: event end date (last training day end for multi-day events) |
is_multi_day
|
boolean | اختياري | LMS-3089: event spans multiple training days |
days
|
object | اختياري | LMS-3089: training-day schedule (empty for single-day events) |
412 Invalid parameters
500 Server error
512 Specification violations