Calendar API

Calendar API

core_calendar_create_calendar_events

Arguments
events (Required)
General structure

list of ( 
  //event
object {
name string   //event name
description string  Default to "null" //Description
format int  Default to "1" //description format (1 = HTML, 2 = PLAIN or 4 = MARKDOWN)
courseid int  Default to "0" //course id
groupid int  Default to "0" //group id
repeats int  Default to "0" //number of repeats
eventtype string  Default to "user" //Event type
timestart int  Default to "1587390712" //timestart
timeduration int  Default to "0" //time duration
visible int  Default to "1" //visible
sequence int  Default to "1" //sequence
} 
)
REST (POST parameters)

events[0][name]= string
events[0][description]= string
events[0][format]= int
events[0][courseid]= int
events[0][groupid]= int
events[0][repeats]= int
events[0][eventtype]= string
events[0][timestart]= int
events[0][timeduration]= int
events[0][visible]= int
events[0][sequence]= int


core_calendar_delete_calendar_events

Arguments
events (Required)
General structure

list of ( 
  //List of events to delete
object {
eventid int   //Event ID
repeat int   //Delete comeplete series if repeated event
} 
)
REST (POST parameters)

events[0][eventid]= int
events[0][repeat]= int


    • Related Articles

    • User API

      core_user_create_users Arguments users (Required) General structure list of (  object { createpassword int  Optional //True if password should be created and mailed to user. username string   //Username of profile. auth string  Default to "manual" ...

    • Generate your API Key

      Step 1: Click on "Site admin" > "Integrations" > "Manage tokens": Step 2: Click on "Create Token": Step 3: (1) Select the user you wish to give the API Token to, (2) Select "API" then (3) Save: Step 4: Share this token with the user or save it if ...

    • Setting Up Your API

      We advise the use of a developer to help you setup your API connection. We will offer an example of how to CREATE NEW USER on your LMS (core_user_create_users) Let's review only the required REST (POST parameters): wsfunction=core_user_create_users ...

    • Enrollment API

      enrol_manual_enrol_users Arguments enrolments (Required) General structure list of (  object { roleid int   //Role to assign to the user userid int   //The user that is going to be enrolled courseid int   //The course to enrol the user role in ...

    • Messaging API

      core_message_get_messages Arguments useridto (Required) the user id who received the message, 0 for any user.  useridfrom (Default to "0") the user id who send the message, 0 for any user. Note that a useridto=0 and useridfrom=0, will not work. At ...