Skip to main content

Course Comment

{
"id": "integer",
"html": "string",
"parent": "integer",
"in_reply_to": "integer",
"created_at": "string",
"created_by": {},
"medias": [],
"latest_comment": {},
"replies": [],
"extras": {
"course": {
"id": "integer",
"slug": "string"
},
"section": {
"id": "integer",
"name": "string"
},
"lesson": {
"id": "integer",
"name": "string"
}
}
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyUnique integer value identifying this comment on a specific comment
textstringfalsewrite-onlyThe comment text.
Default: empty string.
Only available when creating or updating a comment
htmlstringfalseread-onlyThe comment text.
Only available when getting a comment
parentinteger¦nullfalsenoneId of the parent Course Comment
in_reply_tointeger¦nullfalsenoneId of the reply Course Comment.
It must have the same parent
created_atstring(date-time)falseread-onlyDatetime of comment creation
created_byUserfalseread-onlyThe comment creator
mediaslist(integer)falsenoneList of id of Media for this comment
latest_replyCourse Comment¦nullfalseread-onlyThe last comment in reply to (with parent) this comment.
Not available if replies are presents.
replieslist(Course Comment)falseread-onlyThe list of comments in reply to (with parent) this comment.
Not available if latest_reply are presents.
Only available on the route: Get Course Comments
extrasobjectfalseread-onlySome extra useful data for the call that retrieves all the comments received within the entire course.
Only available on the route: Get Course Comments
» courseobjecttrueread-onlyThe course object associated to this comment
» » idnumbertrueread-onlyId of the course
» » slugstringtrueread-onlySlug of the course
» sectionobjecttrueread-onlyThe section object associated to this comment
» » idnumbertrueread-onlyId of the section
» » namestringtrueread-onlySection name
» lessonobjecttrueread-onlyThe lesson object associated to this comment
» » idnumbertrueread-onlyId of the lesson
» » namestringtrueread-onlyLesson name