Web services: API Documentation
API Documentation
auth_email_get_signup_settings
Get the signup required settings and profile fields.
Arguments
Response
General structure
object {
namefields list of (
string //The order of the name fields
)passwordpolicy string Optional //Password policy
sitepolicy string Optional //Site policy
sitepolicyhandler string Optional //Site policy handler
defaultcity string Optional //Default city
country string Optional //Default country
profilefields Optional //Required profile fields
list of (
object {
id int Optional //Profile field id
shortname string Optional //Password policy
name string Optional //Profield field name
datatype string Optional //Profield field datatype
description string Optional //Profield field description
descriptionformat int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //Profield field category id
categoryname string Optional //Profield field category name
sortorder int Optional //Profield field sort order
required int Optional //Profield field required
locked int Optional //Profield field locked
visible int Optional //Profield field visible
forceunique int Optional //Profield field unique
signup int Optional //Profield field in signup form
defaultdata string Optional //Profield field default data
defaultdataformat int //defaultdata format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
param1 string Optional //Profield field settings
param2 string Optional //Profield field settings
param3 string Optional //Profield field settings
param4 string Optional //Profield field settings
param5 string Optional //Profield field settings
}
)recaptchapublickey string Optional //Recaptcha public key
recaptchachallengehash string Optional //Recaptcha challenge hash
recaptchachallengeimage string Optional //Recaptcha challenge noscript image
recaptchachallengejs string Optional //Recaptcha challenge js url
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [namefields] => Array ( [0] => string ) [passwordpolicy] => string [sitepolicy] => string [sitepolicyhandler] => string [defaultcity] => string [country] => string [profilefields] => Array ( [0] => Array ( [id] => int [shortname] => string [name] => string [datatype] => string [description] => string [descriptionformat] => int [categoryid] => int [categoryname] => string [sortorder] => int [required] => int [locked] => int [visible] => int [forceunique] => int [signup] => int [defaultdata] => string [defaultdataformat] => int [param1] => string [param2] => string [param3] => string [param4] => string [param5] => string ) ) [recaptchapublickey] => string [recaptchachallengehash] => string [recaptchachallengeimage] => string [recaptchachallengejs] => string [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="namefields"> <MULTIPLE> <VALUE>string</VALUE> </MULTIPLE> </KEY> <KEY name="passwordpolicy"> <VALUE>string</VALUE> </KEY> <KEY name="sitepolicy"> <VALUE>string</VALUE> </KEY> <KEY name="sitepolicyhandler"> <VALUE>string</VALUE> </KEY> <KEY name="defaultcity"> <VALUE>string</VALUE> </KEY> <KEY name="country"> <VALUE>string</VALUE> </KEY> <KEY name="profilefields"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="datatype"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="categoryname"> <VALUE>string</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="required"> <VALUE>int</VALUE> </KEY> <KEY name="locked"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="forceunique"> <VALUE>int</VALUE> </KEY> <KEY name="signup"> <VALUE>int</VALUE> </KEY> <KEY name="defaultdata"> <VALUE>string</VALUE> </KEY> <KEY name="defaultdataformat"> <VALUE>int</VALUE> </KEY> <KEY name="param1"> <VALUE>string</VALUE> </KEY> <KEY name="param2"> <VALUE>string</VALUE> </KEY> <KEY name="param3"> <VALUE>string</VALUE> </KEY> <KEY name="param4"> <VALUE>string</VALUE> </KEY> <KEY name="param5"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="recaptchapublickey"> <VALUE>string</VALUE> </KEY> <KEY name="recaptchachallengehash"> <VALUE>string</VALUE> </KEY> <KEY name="recaptchachallengeimage"> <VALUE>string</VALUE> </KEY> <KEY name="recaptchachallengejs"> <VALUE>string</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
auth_email_signup_user
Adds a new user (pendingto be confirmed) in the site.
Arguments
username (Required)
Username
General structure
string //Username
XML-RPC (PHP structure)
[username] => string
REST (POST parameters)
username= string
Plain text password
General structure
string //Plain text password
XML-RPC (PHP structure)
[password] => string
REST (POST parameters)
password= string
The first name(s) of the user
General structure
string //The first name(s) of the user
XML-RPC (PHP structure)
[firstname] => string
REST (POST parameters)
firstname= string
The family name of the user
General structure
string //The family name of the user
XML-RPC (PHP structure)
[lastname] => string
REST (POST parameters)
lastname= string
A valid and unique email address
General structure
string //A valid and unique email address
XML-RPC (PHP structure)
[email] => string
REST (POST parameters)
email= string
Home city of the user
General structure
string Default to "" //Home city of the user
XML-RPC (PHP structure)
[city] => string
REST (POST parameters)
city= string
Home country code
General structure
string Default to "" //Home country code
XML-RPC (PHP structure)
[country] => string
REST (POST parameters)
country= string
Recaptcha challenge hash
General structure
string Default to "" //Recaptcha challenge hash
XML-RPC (PHP structure)
[recaptchachallengehash] => string
REST (POST parameters)
recaptchachallengehash= string
Recaptcha response
General structure
string Default to "" //Recaptcha response
XML-RPC (PHP structure)
[recaptcharesponse] => string
REST (POST parameters)
recaptcharesponse= string
User custom fields (also known as user profile fields)
General structure
Default to "Array ( ) " //User custom fields (also known as user profile fields)
list of (
object {
type string //The type of the custom field
name string //The name of the custom field
value string //Custom field value, can be an encoded json if required
}
)
XML-RPC (PHP structure)
[customprofilefields] => Array ( [0] => Array ( [type] => string [name] => string [value] => string ) )
REST (POST parameters)
customprofilefields[0][type]= string customprofilefields[0][name]= string customprofilefields[0][value]= string
Redirect the user to this site url after confirmation.
General structure
string Default to "" //Redirect the user to this site url after confirmation.
XML-RPC (PHP structure)
[redirect] => string
REST (POST parameters)
redirect= string
Response
General structure
object {
success int //True if the user was created false otherwise
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [success] => int [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="success"> <VALUE>int</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
core_auth_confirm_user
Confirm a user account.
Arguments
username (Required)
User name
General structure
string //User name
XML-RPC (PHP structure)
[username] => string
REST (POST parameters)
username= string
Confirmation secret
General structure
string //Confirmation secret
XML-RPC (PHP structure)
[secret] => string
REST (POST parameters)
secret= string
Response
General structure
object {
success int //True if the user was confirmed, false if he was already confirmed
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [success] => int [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="success"> <VALUE>int</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
core_auth_is_age_digital_consent_verification_enabled
Checks if age digital consent verification is enabled.
Arguments
Response
General structure
object {
status int //True if digital consent verification is enabled, false otherwise.
}
XML-RPC (PHP structure)
Array ( [status] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="status"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
core_auth_is_minor
Requests a check if a user is a digital minor.
Arguments
age (Required)
Age
General structure
int //Age
XML-RPC (PHP structure)
[age] => int
REST (POST parameters)
age= int
Country of residence
General structure
string //Country of residence
XML-RPC (PHP structure)
[country] => string
REST (POST parameters)
country= string
Response
General structure
object {
status int //True if the user is considered to be a digital minor, false if not
}
XML-RPC (PHP structure)
Array ( [status] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="status"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
core_auth_request_password_reset
Requests a password reset.
Arguments
username (Default to "")
User name
General structure
string Default to "" //User name
XML-RPC (PHP structure)
[username] => string
REST (POST parameters)
username= string
User email
General structure
string Default to "" //User email
XML-RPC (PHP structure)
[email] => string
REST (POST parameters)
email= string
Response
General structure
object {
status string //The returned status of the process: dataerror: Error in the sent data (username or email). More information in warnings field. emailpasswordconfirmmaybesent: Email sent or not (depends on user found in database). emailpasswordconfirmnotsent: Failure, user not found. emailpasswordconfirmnoemail: Failure, email not found. emailalreadysent: Email already sent. emailpasswordconfirmsent: User pending confirmation. emailresetconfirmsent: Email sent.
notice string //Important information for the user about the process.
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [status] => string [notice] => string [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="status"> <VALUE>string</VALUE> </KEY> <KEY name="notice"> <VALUE>string</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
No
Callable from AJAX
Yes
core_badges_get_user_badges
Returns the list of badges awarded to a user.
Arguments
userid (Default to "0")
Badges only for this user id, empty for current user
General structure
int Default to "0" //Badges only for this user id, empty for current user
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Filter badges by course id, empty all the courses
General structure
int Default to "0" //Filter badges by course id, empty all the courses
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
The page of records to return.
General structure
int Default to "0" //The page of records to return.
XML-RPC (PHP structure)
[page] => int
REST (POST parameters)
page= int
The number of records to return per page
General structure
int Default to "0" //The number of records to return per page
XML-RPC (PHP structure)
[perpage] => int
REST (POST parameters)
perpage= int
A simple string to search for
General structure
string Default to "" //A simple string to search for
XML-RPC (PHP structure)
[search] => string
REST (POST parameters)
search= string
Whether to return only public badges
General structure
int Default to "" //Whether to return only public badges
XML-RPC (PHP structure)
[onlypublic] => int
REST (POST parameters)
onlypublic= int
Response
General structure
object {
badges list of (
object {
id int Optional //Badge id.
name string //Badge name.
description string //Badge description.
badgeurl string //Badge URL.
timecreated int Optional //Time created.
timemodified int Optional //Time modified.
usercreated int Optional //User created.
usermodified int Optional //User modified.
issuername string //Issuer name.
issuerurl string //Issuer URL.
issuercontact string //Issuer contact.
expiredate int Optional //Expire date.
expireperiod int Optional //Expire period.
type int Optional //Type.
courseid int Optional //Course id.
message string Optional //Message.
messagesubject string Optional //Message subject.
attachment int Optional //Attachment.
status int Optional //Status.
issuedid int Optional //Issued id.
uniquehash string //Unique hash.
dateissued int //Date issued.
dateexpire int //Date expire.
visible int Optional //Visible.
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [badges] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [badgeurl] => string [timecreated] => int [timemodified] => int [usercreated] => int [usermodified] => int [issuername] => string [issuerurl] => string [issuercontact] => string [expiredate] => int [expireperiod] => int [type] => int [courseid] => int [message] => string [messagesubject] => string [attachment] => int [status] => int [issuedid] => int [uniquehash] => string [dateissued] => int [dateexpire] => int [visible] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="badges"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="badgeurl"> <VALUE>string</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usercreated"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="issuername"> <VALUE>string</VALUE> </KEY> <KEY name="issuerurl"> <VALUE>string</VALUE> </KEY> <KEY name="issuercontact"> <VALUE>string</VALUE> </KEY> <KEY name="expiredate"> <VALUE>int</VALUE> </KEY> <KEY name="expireperiod"> <VALUE>int</VALUE> </KEY> <KEY name="type"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> <KEY name="messagesubject"> <VALUE>string</VALUE> </KEY> <KEY name="attachment"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="issuedid"> <VALUE>int</VALUE> </KEY> <KEY name="uniquehash"> <VALUE>string</VALUE> </KEY> <KEY name="dateissued"> <VALUE>int</VALUE> </KEY> <KEY name="dateexpire"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_block_get_course_blocks
Returns blocks information for a course.
Arguments
courseid (Required)
course id
General structure
int //course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Response
General structure
object {
blocks //List of blocks in the course.
list of (
//Block information.
object {
instanceid int //Block instance id.
name string //Block name.
region string //Block region.
positionid int //Position id.
collapsible int //Whether the block is collapsible.
dockable int //hether the block is dockable.
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [blocks] => Array ( [0] => Array ( [instanceid] => int [name] => string [region] => string [positionid] => int [collapsible] => int [dockable] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="blocks"> <MULTIPLE> <SINGLE> <KEY name="instanceid"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="region"> <VALUE>string</VALUE> </KEY> <KEY name="positionid"> <VALUE>int</VALUE> </KEY> <KEY name="collapsible"> <VALUE>int</VALUE> </KEY> <KEY name="dockable"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_calendar_create_calendar_events
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, 0 = MOODLE, 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 "1570118730" //timestart
timeduration int Default to "0" //time duration
visible int Default to "1" //visible
sequence int Default to "1" //sequence
}
)
XML-RPC (PHP structure)
[events] => Array ( [0] => Array ( [name] => string [description] => string [format] => int [courseid] => int [groupid] => int [repeats] => int [eventtype] => string [timestart] => int [timeduration] => int [visible] => int [sequence] => int ) )
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
Response
General structure
object {
events list of (
//event
object {
id int //event id
name string //event name
description string Optional //Description
format int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
courseid int //course id
groupid int //group id
userid int //user id
repeatid int Optional //repeat id
modulename string Optional //module name
instance int //instance id
eventtype string //Event type
timestart int //timestart
timeduration int //time duration
visible int //visible
uuid string Optional //unique id of ical events
sequence int //sequence
timemodified int //time modified
subscriptionid int Optional //Subscription id
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [format] => int [courseid] => int [groupid] => int [userid] => int [repeatid] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [visible] => int [uuid] => string [sequence] => int [timemodified] => int [subscriptionid] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="format"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="uuid"> <VALUE>string</VALUE> </KEY> <KEY name="sequence"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionid"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_calendar_delete_calendar_events
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
}
)
XML-RPC (PHP structure)
[events] => Array ( [0] => Array ( [eventid] => int [repeat] => int ) )
REST (POST parameters)
events[0][eventid]= int events[0][repeat]= int
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_action_events_by_course
Get calendar action events by course
Arguments
courseid (Required)
Course id
General structure
int //Course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Time sort from
General structure
int Default to "null" //Time sort from
XML-RPC (PHP structure)
[timesortfrom] => int
REST (POST parameters)
timesortfrom= int
Time sort to
General structure
int Default to "null" //Time sort to
XML-RPC (PHP structure)
[timesortto] => int
REST (POST parameters)
timesortto= int
The last seen event id
General structure
int Default to "0" //The last seen event id
XML-RPC (PHP structure)
[aftereventid] => int
REST (POST parameters)
aftereventid= int
Limit number
General structure
int Default to "20" //Limit number
XML-RPC (PHP structure)
[limitnum] => int
REST (POST parameters)
limitnum= int
Response
General structure
object {
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
)firstid int //firstid
lastid int //lastid
}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) ) [firstid] => int [lastid] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="firstid"> <VALUE>int</VALUE> </KEY> <KEY name="lastid"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_action_events_by_courses
Get calendar action events by courses
Arguments
courseids (Required)
General structure
list of (
int //Course id
)
XML-RPC (PHP structure)
[courseids] => Array ( [0] => int )
REST (POST parameters)
courseids[0]= int
Time sort from
General structure
int Default to "null" //Time sort from
XML-RPC (PHP structure)
[timesortfrom] => int
REST (POST parameters)
timesortfrom= int
Time sort to
General structure
int Default to "null" //Time sort to
XML-RPC (PHP structure)
[timesortto] => int
REST (POST parameters)
timesortto= int
Limit number
General structure
int Default to "10" //Limit number
XML-RPC (PHP structure)
[limitnum] => int
REST (POST parameters)
limitnum= int
Response
General structure
object {
groupedbycourse //groupedbycourse
list of (
object {
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
)firstid int //firstid
lastid int //lastid
courseid int //courseid
}
)}
XML-RPC (PHP structure)
Array ( [groupedbycourse] => Array ( [0] => Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) ) [firstid] => int [lastid] => int [courseid] => int ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="groupedbycourse"> <MULTIPLE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="firstid"> <VALUE>int</VALUE> </KEY> <KEY name="lastid"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_action_events_by_timesort
Get calendar action events by tiemsort
Arguments
timesortfrom (Default to "0")
Time sort from
General structure
int Default to "0" //Time sort from
XML-RPC (PHP structure)
[timesortfrom] => int
REST (POST parameters)
timesortfrom= int
Time sort to
General structure
int Default to "null" //Time sort to
XML-RPC (PHP structure)
[timesortto] => int
REST (POST parameters)
timesortto= int
The last seen event id
General structure
int Default to "0" //The last seen event id
XML-RPC (PHP structure)
[aftereventid] => int
REST (POST parameters)
aftereventid= int
Limit number
General structure
int Default to "20" //Limit number
XML-RPC (PHP structure)
[limitnum] => int
REST (POST parameters)
limitnum= int
Limit the events to courses the user is not suspended in
General structure
int Default to "" //Limit the events to courses the user is not suspended in
XML-RPC (PHP structure)
[limittononsuspendedevents] => int
REST (POST parameters)
limittononsuspendedevents= int
Response
General structure
object {
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
)firstid int //firstid
lastid int //lastid
}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) ) [firstid] => int [lastid] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="firstid"> <VALUE>int</VALUE> </KEY> <KEY name="lastid"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_calendar_day_view
Fetch the day view data for a calendar
Arguments
year (Required)
Year to be viewed
General structure
int //Year to be viewed
XML-RPC (PHP structure)
[year] => int
REST (POST parameters)
year= int
Month to be viewed
General structure
int //Month to be viewed
XML-RPC (PHP structure)
[month] => int
REST (POST parameters)
month= int
Day to be viewed
General structure
int //Day to be viewed
XML-RPC (PHP structure)
[day] => int
REST (POST parameters)
day= int
Course being viewed
General structure
int Default to "1" //Course being viewed
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Category being viewed
General structure
int Default to "null" //Category being viewed
XML-RPC (PHP structure)
[categoryid] => int
REST (POST parameters)
categoryid= int
Response
General structure
object {
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
islastday int //islastday
calendareventtype string //calendareventtype
popupname string //popupname
mindaytimestamp int Optional //mindaytimestamp
mindayerror string Optional //mindayerror
maxdaytimestamp int Optional //maxdaytimestamp
maxdayerror string Optional //maxdayerror
draggable int //draggable
}
)defaulteventcontext int //defaulteventcontext
filter_selector string //filter_selector
courseid int //courseid
categoryid int Optional //categoryid
neweventtimestamp int //neweventtimestamp
date object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
periodname string //periodname
previousperiod object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
previousperiodlink string //previousperiodlink
previousperiodname string //previousperiodname
nextperiod object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
nextperiodname string //nextperiodname
nextperiodlink string //nextperiodlink
larrow string //larrow
rarrow string //rarrow
}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [islastday] => int [calendareventtype] => string [popupname] => string [mindaytimestamp] => int [mindayerror] => string [maxdaytimestamp] => int [maxdayerror] => string [draggable] => int ) ) [defaulteventcontext] => int [filter_selector] => string [courseid] => int [categoryid] => int [neweventtimestamp] => int [date] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [periodname] => string [previousperiod] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [previousperiodlink] => string [previousperiodname] => string [nextperiod] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [nextperiodname] => string [nextperiodlink] => string [larrow] => string [rarrow] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="islastday"> <VALUE>int</VALUE> </KEY> <KEY name="calendareventtype"> <VALUE>string</VALUE> </KEY> <KEY name="popupname"> <VALUE>string</VALUE> </KEY> <KEY name="mindaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="mindayerror"> <VALUE>string</VALUE> </KEY> <KEY name="maxdaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="maxdayerror"> <VALUE>string</VALUE> </KEY> <KEY name="draggable"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="defaulteventcontext"> <VALUE>int</VALUE> </KEY> <KEY name="filter_selector"> <VALUE>string</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="neweventtimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="date"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="periodname"> <VALUE>string</VALUE> </KEY> <KEY name="previousperiod"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="previousperiodlink"> <VALUE>string</VALUE> </KEY> <KEY name="previousperiodname"> <VALUE>string</VALUE> </KEY> <KEY name="nextperiod"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="nextperiodname"> <VALUE>string</VALUE> </KEY> <KEY name="nextperiodlink"> <VALUE>string</VALUE> </KEY> <KEY name="larrow"> <VALUE>string</VALUE> </KEY> <KEY name="rarrow"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_calendar_events
Get calendar events
Arguments
events (Default to "Array ( ) ")
Event details
General structure
Default to "Array ( ) " //Event details
object {
eventids Default to "Array ( ) " //List of event ids
list of (
int //event ids
)courseids Default to "Array ( ) " //List of course ids for which events will be returned
list of (
int //course ids
)groupids Default to "Array ( ) " //List of group ids for which events should be returned
list of (
int //group ids
)categoryids Default to "Array ( ) " //List of category ids for which events will be returned
list of (
int //Category ids
)}
XML-RPC (PHP structure)
[events] => Array ( [eventids] => Array ( [0] => int ) [courseids] => Array ( [0] => int ) [groupids] => Array ( [0] => int ) [categoryids] => Array ( [0] => int ) )
REST (POST parameters)
events[eventids][0]= int events[courseids][0]= int events[groupids][0]= int events[categoryids][0]= int
Options
General structure
Default to "Array ( ) " //Options
object {
userevents int Default to "1" //Set to true to return current user's user events
siteevents int Default to "1" //Set to true to return global events
timestart int Default to "0" //Time from which events should be returned
timeend int Default to "0" //Time to which the events should be returned. We treat 0 and null as no end
ignorehidden int Default to "1" //Ignore hidden events or not
}
XML-RPC (PHP structure)
[options] => Array ( [userevents] => int [siteevents] => int [timestart] => int [timeend] => int [ignorehidden] => int )
REST (POST parameters)
options[userevents]= int options[siteevents]= int options[timestart]= int options[timeend]= int options[ignorehidden]= int
Response
General structure
object {
events list of (
//event
object {
id int //event id
name string //event name
description string Optional //Description
format int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
courseid int //course id
categoryid int Optional //Category id (only for category events).
groupid int //group id
userid int //user id
repeatid int //repeat id
modulename string Optional //module name
instance int //instance id
eventtype string //Event type
timestart int //timestart
timeduration int //time duration
visible int //visible
uuid string Optional //unique id of ical events
sequence int //sequence
timemodified int //time modified
subscriptionid int Optional //Subscription id
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [format] => int [courseid] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [visible] => int [uuid] => string [sequence] => int [timemodified] => int [subscriptionid] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="format"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="uuid"> <VALUE>string</VALUE> </KEY> <KEY name="sequence"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionid"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_calendar_get_calendar_event_by_id
Get calendar event by id
Arguments
eventid (Required)
The event id to be retrieved
General structure
int //The event id to be retrieved
XML-RPC (PHP structure)
[eventid] => int
REST (POST parameters)
eventid= int
Response
General structure
object {
event object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [event] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="event"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_calendar_monthly_view
Fetch the monthly view data for a calendar
Arguments
year (Required)
Month to be viewed
General structure
int //Month to be viewed
XML-RPC (PHP structure)
[year] => int
REST (POST parameters)
year= int
Year to be viewed
General structure
int //Year to be viewed
XML-RPC (PHP structure)
[month] => int
REST (POST parameters)
month= int
Course being viewed
General structure
int Default to "1" //Course being viewed
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Category being viewed
General structure
int Default to "null" //Category being viewed
XML-RPC (PHP structure)
[categoryid] => int
REST (POST parameters)
categoryid= int
Whether to show course navigation
General structure
int Default to "1" //Whether to show course navigation
XML-RPC (PHP structure)
[includenavigation] => int
REST (POST parameters)
includenavigation= int
Whether to return the mini month view or not
General structure
int Default to "" //Whether to return the mini month view or not
XML-RPC (PHP structure)
[mini] => int
REST (POST parameters)
mini= int
Response
General structure
object {
url string //url
courseid int //courseid
categoryid int Optional //categoryid
filter_selector string Optional //filter_selector
weeks //weeks
list of (
object {
prepadding //prepadding
list of (
int //prepadding
)postpadding //postpadding
list of (
int //postpadding
)days //days
list of (
object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
year int //year
yday int //yday
istoday int //istoday
isweekend int //isweekend
timestamp int //timestamp
neweventtimestamp int //neweventtimestamp
viewdaylink string Optional //viewdaylink
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
islastday int //islastday
calendareventtype string //calendareventtype
popupname string //popupname
mindaytimestamp int Optional //mindaytimestamp
mindayerror string Optional //mindayerror
maxdaytimestamp int Optional //maxdaytimestamp
maxdayerror string Optional //maxdayerror
draggable int //draggable
}
)hasevents int //hasevents
calendareventtypes //calendareventtypes
list of (
string //calendareventtypes
)previousperiod int //previousperiod
nextperiod int //nextperiod
navigation string //navigation
haslastdayofevent int //haslastdayofevent
popovertitle string //popovertitle
}
)}
)daynames //daynames
list of (
object {
dayno int //dayno
shortname string //shortname
fullname string //fullname
}
)view string //view
date object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
periodname string //periodname
includenavigation int //includenavigation
initialeventsloaded int //initialeventsloaded
previousperiod object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
previousperiodlink string //previousperiodlink
previousperiodname string //previousperiodname
nextperiod object {
seconds int //seconds
minutes int //minutes
hours int //hours
mday int //mday
wday int //wday
mon int //mon
year int //year
yday int //yday
weekday string //weekday
month string //month
timestamp int //timestamp
}
nextperiodname string //nextperiodname
nextperiodlink string //nextperiodlink
larrow string //larrow
rarrow string //rarrow
defaulteventcontext int //defaulteventcontext
}
XML-RPC (PHP structure)
Array ( [url] => string [courseid] => int [categoryid] => int [filter_selector] => string [weeks] => Array ( [0] => Array ( [prepadding] => Array ( [0] => int ) [postpadding] => Array ( [0] => int ) [days] => Array ( [0] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [year] => int [yday] => int [istoday] => int [isweekend] => int [timestamp] => int [neweventtimestamp] => int [viewdaylink] => string [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [islastday] => int [calendareventtype] => string [popupname] => string [mindaytimestamp] => int [mindayerror] => string [maxdaytimestamp] => int [maxdayerror] => string [draggable] => int ) ) [hasevents] => int [calendareventtypes] => Array ( [0] => string ) [previousperiod] => int [nextperiod] => int [navigation] => string [haslastdayofevent] => int [popovertitle] => string ) ) ) ) [daynames] => Array ( [0] => Array ( [dayno] => int [shortname] => string [fullname] => string ) ) [view] => string [date] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [periodname] => string [includenavigation] => int [initialeventsloaded] => int [previousperiod] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [previousperiodlink] => string [previousperiodname] => string [nextperiod] => Array ( [seconds] => int [minutes] => int [hours] => int [mday] => int [wday] => int [mon] => int [year] => int [yday] => int [weekday] => string [month] => string [timestamp] => int ) [nextperiodname] => string [nextperiodlink] => string [larrow] => string [rarrow] => string [defaulteventcontext] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="filter_selector"> <VALUE>string</VALUE> </KEY> <KEY name="weeks"> <MULTIPLE> <SINGLE> <KEY name="prepadding"> <MULTIPLE> <VALUE>int</VALUE> </MULTIPLE> </KEY> <KEY name="postpadding"> <MULTIPLE> <VALUE>int</VALUE> </MULTIPLE> </KEY> <KEY name="days"> <MULTIPLE> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="istoday"> <VALUE>int</VALUE> </KEY> <KEY name="isweekend"> <VALUE>int</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> <KEY name="neweventtimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="viewdaylink"> <VALUE>string</VALUE> </KEY> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="islastday"> <VALUE>int</VALUE> </KEY> <KEY name="calendareventtype"> <VALUE>string</VALUE> </KEY> <KEY name="popupname"> <VALUE>string</VALUE> </KEY> <KEY name="mindaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="mindayerror"> <VALUE>string</VALUE> </KEY> <KEY name="maxdaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="maxdayerror"> <VALUE>string</VALUE> </KEY> <KEY name="draggable"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="hasevents"> <VALUE>int</VALUE> </KEY> <KEY name="calendareventtypes"> <MULTIPLE> <VALUE>string</VALUE> </MULTIPLE> </KEY> <KEY name="previousperiod"> <VALUE>int</VALUE> </KEY> <KEY name="nextperiod"> <VALUE>int</VALUE> </KEY> <KEY name="navigation"> <VALUE>string</VALUE> </KEY> <KEY name="haslastdayofevent"> <VALUE>int</VALUE> </KEY> <KEY name="popovertitle"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="daynames"> <MULTIPLE> <SINGLE> <KEY name="dayno"> <VALUE>int</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="view"> <VALUE>string</VALUE> </KEY> <KEY name="date"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="periodname"> <VALUE>string</VALUE> </KEY> <KEY name="includenavigation"> <VALUE>int</VALUE> </KEY> <KEY name="initialeventsloaded"> <VALUE>int</VALUE> </KEY> <KEY name="previousperiod"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="previousperiodlink"> <VALUE>string</VALUE> </KEY> <KEY name="previousperiodname"> <VALUE>string</VALUE> </KEY> <KEY name="nextperiod"> <SINGLE> <KEY name="seconds"> <VALUE>int</VALUE> </KEY> <KEY name="minutes"> <VALUE>int</VALUE> </KEY> <KEY name="hours"> <VALUE>int</VALUE> </KEY> <KEY name="mday"> <VALUE>int</VALUE> </KEY> <KEY name="wday"> <VALUE>int</VALUE> </KEY> <KEY name="mon"> <VALUE>int</VALUE> </KEY> <KEY name="year"> <VALUE>int</VALUE> </KEY> <KEY name="yday"> <VALUE>int</VALUE> </KEY> <KEY name="weekday"> <VALUE>string</VALUE> </KEY> <KEY name="month"> <VALUE>string</VALUE> </KEY> <KEY name="timestamp"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="nextperiodname"> <VALUE>string</VALUE> </KEY> <KEY name="nextperiodlink"> <VALUE>string</VALUE> </KEY> <KEY name="larrow"> <VALUE>string</VALUE> </KEY> <KEY name="rarrow"> <VALUE>string</VALUE> </KEY> <KEY name="defaulteventcontext"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_get_calendar_upcoming_view
Fetch the upcoming view data for a calendar
Arguments
courseid (Default to "1")
Course being viewed
General structure
int Default to "1" //Course being viewed
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Category being viewed
General structure
int Default to "null" //Category being viewed
XML-RPC (PHP structure)
[categoryid] => int
REST (POST parameters)
categoryid= int
Response
General structure
object {
events //events
list of (
object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
islastday int //islastday
calendareventtype string //calendareventtype
popupname string //popupname
mindaytimestamp int Optional //mindaytimestamp
mindayerror string Optional //mindayerror
maxdaytimestamp int Optional //maxdaytimestamp
maxdayerror string Optional //maxdayerror
draggable int //draggable
}
)defaulteventcontext int //defaulteventcontext
filter_selector string //filter_selector
courseid int //courseid
categoryid int Optional //categoryid
isloggedin int //isloggedin
}
XML-RPC (PHP structure)
Array ( [events] => Array ( [0] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [islastday] => int [calendareventtype] => string [popupname] => string [mindaytimestamp] => int [mindayerror] => string [maxdaytimestamp] => int [maxdayerror] => string [draggable] => int ) ) [defaulteventcontext] => int [filter_selector] => string [courseid] => int [categoryid] => int [isloggedin] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="events"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="islastday"> <VALUE>int</VALUE> </KEY> <KEY name="calendareventtype"> <VALUE>string</VALUE> </KEY> <KEY name="popupname"> <VALUE>string</VALUE> </KEY> <KEY name="mindaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="mindayerror"> <VALUE>string</VALUE> </KEY> <KEY name="maxdaytimestamp"> <VALUE>int</VALUE> </KEY> <KEY name="maxdayerror"> <VALUE>string</VALUE> </KEY> <KEY name="draggable"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="defaulteventcontext"> <VALUE>int</VALUE> </KEY> <KEY name="filter_selector"> <VALUE>string</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="isloggedin"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_submit_create_update_form
Submit form data for event form
Arguments
formdata (Required)
The data from the event form
General structure
string //The data from the event form
XML-RPC (PHP structure)
[formdata] => string
REST (POST parameters)
formdata= string
Response
General structure
object {
event object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
validationerror int Default to "" //Invalid form data
}
XML-RPC (PHP structure)
Array ( [event] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) [validationerror] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="event"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </KEY> <KEY name="validationerror"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_calendar_update_event_start_day
Update the start day (but not time) for an event.
Arguments
eventid (Required)
Id of event to be updated
General structure
int //Id of event to be updated
XML-RPC (PHP structure)
[eventid] => int
REST (POST parameters)
eventid= int
Timestamp for the new start day
General structure
int //Timestamp for the new start day
XML-RPC (PHP structure)
[daytimestamp] => int
REST (POST parameters)
daytimestamp= int
Response
General structure
object {
event object {
id int //id
name string //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
categoryid int Optional //categoryid
groupid int Optional //groupid
userid int Optional //userid
repeatid int Optional //repeatid
eventcount int Optional //eventcount
modulename string Optional //modulename
instance int Optional //instance
eventtype string //eventtype
timestart int //timestart
timeduration int //timeduration
timesort int //timesort
visible int //visible
timemodified int //timemodified
icon object {
key string //key
component string //component
alttext string //alttext
}
category object {
id int //id
name string //name
idnumber string //idnumber
description string Optional //description
parent int //parent
coursecount int //coursecount
visible int //visible
timemodified int //timemodified
depth int //depth
nestedname string //nestedname
url string //url
}
course object {
id int //id
fullname string //fullname
shortname string //shortname
idnumber string //idnumber
summary string //summary
summaryformat int //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
startdate int //startdate
enddate int //enddate
fullnamedisplay string //fullnamedisplay
viewurl string //viewurl
}
subscription object {
displayeventsource int //displayeventsource
subscriptionname string Optional //subscriptionname
subscriptionurl string Optional //subscriptionurl
}
canedit int //canedit
candelete int //candelete
deleteurl string //deleteurl
editurl string //editurl
viewurl string //viewurl
formattedtime string //formattedtime
isactionevent int //isactionevent
iscourseevent int //iscourseevent
iscategoryevent int //iscategoryevent
groupname string Optional //groupname
url string //url
action object {
name string //name
url string //url
itemcount int //itemcount
actionable int //actionable
showitemcount int //showitemcount
}
}
}
XML-RPC (PHP structure)
Array ( [event] => Array ( [id] => int [name] => string [description] => string [descriptionformat] => int [categoryid] => int [groupid] => int [userid] => int [repeatid] => int [eventcount] => int [modulename] => string [instance] => int [eventtype] => string [timestart] => int [timeduration] => int [timesort] => int [visible] => int [timemodified] => int [icon] => Array ( [key] => string [component] => string [alttext] => string ) [category] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [parent] => int [coursecount] => int [visible] => int [timemodified] => int [depth] => int [nestedname] => string [url] => string ) [course] => Array ( [id] => int [fullname] => string [shortname] => string [idnumber] => string [summary] => string [summaryformat] => int [startdate] => int [enddate] => int [fullnamedisplay] => string [viewurl] => string ) [subscription] => Array ( [displayeventsource] => int [subscriptionname] => string [subscriptionurl] => string ) [canedit] => int [candelete] => int [deleteurl] => string [editurl] => string [viewurl] => string [formattedtime] => string [isactionevent] => int [iscourseevent] => int [iscategoryevent] => int [groupname] => string [url] => string [action] => Array ( [name] => string [url] => string [itemcount] => int [actionable] => int [showitemcount] => int ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="event"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="categoryid"> <VALUE>int</VALUE> </KEY> <KEY name="groupid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="repeatid"> <VALUE>int</VALUE> </KEY> <KEY name="eventcount"> <VALUE>int</VALUE> </KEY> <KEY name="modulename"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="eventtype"> <VALUE>string</VALUE> </KEY> <KEY name="timestart"> <VALUE>int</VALUE> </KEY> <KEY name="timeduration"> <VALUE>int</VALUE> </KEY> <KEY name="timesort"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="icon"> <SINGLE> <KEY name="key"> <VALUE>string</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="alttext"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="category"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="parent"> <VALUE>int</VALUE> </KEY> <KEY name="coursecount"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="depth"> <VALUE>int</VALUE> </KEY> <KEY name="nestedname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="course"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="summary"> <VALUE>string</VALUE> </KEY> <KEY name="summaryformat"> <VALUE>int</VALUE> </KEY> <KEY name="startdate"> <VALUE>int</VALUE> </KEY> <KEY name="enddate"> <VALUE>int</VALUE> </KEY> <KEY name="fullnamedisplay"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="subscription"> <SINGLE> <KEY name="displayeventsource"> <VALUE>int</VALUE> </KEY> <KEY name="subscriptionname"> <VALUE>string</VALUE> </KEY> <KEY name="subscriptionurl"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="canedit"> <VALUE>int</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> <KEY name="deleteurl"> <VALUE>string</VALUE> </KEY> <KEY name="editurl"> <VALUE>string</VALUE> </KEY> <KEY name="viewurl"> <VALUE>string</VALUE> </KEY> <KEY name="formattedtime"> <VALUE>string</VALUE> </KEY> <KEY name="isactionevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscourseevent"> <VALUE>int</VALUE> </KEY> <KEY name="iscategoryevent"> <VALUE>int</VALUE> </KEY> <KEY name="groupname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="action"> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="itemcount"> <VALUE>int</VALUE> </KEY> <KEY name="actionable"> <VALUE>int</VALUE> </KEY> <KEY name="showitemcount"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_cohort_add_cohort_members
Adds cohort members.
Arguments
members (Required)
General structure
list of (
object {
cohorttype object {
type string //The name of the field: id (numeric value of cohortid) or idnumber (alphanumeric value of idnumber)
value string //The value of the cohort
}
usertype object {
type string //The name of the field: id (numeric value of id) or username (alphanumeric value of username)
value string //The value of the cohort
}
}
)
XML-RPC (PHP structure)
[members] => Array ( [0] => Array ( [cohorttype] => Array ( [type] => string [value] => string ) [usertype] => Array ( [type] => string [value] => string ) ) )
REST (POST parameters)
members[0][cohorttype][type]= string members[0][cohorttype][value]= string members[0][usertype][type]= string members[0][usertype][value]= string
Response
General structure
object {
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_create_cohorts
Creates new cohorts.
Arguments
cohorts (Required)
General structure
list of (
object {
categorytype object {
type string //the name of the field: id (numeric value of course category id) or idnumber (alphanumeric value of idnumber course category) or system (value ignored)
value string //the value of the categorytype
}
name string //cohort name
idnumber string //cohort idnumber
description string Optional //cohort description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int Optional //cohort visible
theme string Optional //the cohort theme. The allowcohortthemes setting must be enabled on Moodle
}
)
XML-RPC (PHP structure)
[cohorts] => Array ( [0] => Array ( [categorytype] => Array ( [type] => string [value] => string ) [name] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [theme] => string ) )
REST (POST parameters)
cohorts[0][categorytype][type]= string cohorts[0][categorytype][value]= string cohorts[0][name]= string cohorts[0][idnumber]= string cohorts[0][description]= string cohorts[0][descriptionformat]= int cohorts[0][visible]= int cohorts[0][theme]= string
Response
General structure
list of (
object {
id int //cohort id
name string //cohort name
idnumber string //cohort idnumber
description string //cohort description
descriptionformat int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //cohort visible
theme string Optional //cohort theme
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [theme] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="theme"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_delete_cohorts
Deletes all specified cohorts.
Arguments
cohortids (Required)
General structure
list of (
int //cohort ID
)
XML-RPC (PHP structure)
[cohortids] => Array ( [0] => int )
REST (POST parameters)
cohortids[0]= int
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_delete_cohort_members
Deletes cohort members.
Arguments
members (Required)
General structure
list of (
object {
cohortid int //cohort record id
userid int //user id
}
)
XML-RPC (PHP structure)
[members] => Array ( [0] => Array ( [cohortid] => int [userid] => int ) )
REST (POST parameters)
members[0][cohortid]= int members[0][userid]= int
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_get_cohorts
Returns cohort details.
Arguments
cohortids (Default to "Array ( ) ")
List of cohort id. A cohort id is an integer.
General structure
Default to "Array ( ) " //List of cohort id. A cohort id is an integer.
list of (
int //Cohort ID
)
XML-RPC (PHP structure)
[cohortids] => Array ( [0] => int )
REST (POST parameters)
cohortids[0]= int
Response
General structure
list of (
object {
id int //ID of the cohort
name string //cohort name
idnumber string //cohort idnumber
description string //cohort description
descriptionformat int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //cohort visible
theme string Optional //cohort theme
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [theme] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="theme"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_get_cohort_members
Returns cohort members.
Arguments
cohortids (Required)
General structure
list of (
int //Cohort ID
)
XML-RPC (PHP structure)
[cohortids] => Array ( [0] => int )
REST (POST parameters)
cohortids[0]= int
Response
General structure
list of (
object {
cohortid int //cohort record id
userids list of (
int //user id
)}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [cohortid] => int [userids] => Array ( [0] => int ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="cohortid"> <VALUE>int</VALUE> </KEY> <KEY name="userids"> <MULTIPLE> <VALUE>int</VALUE> </MULTIPLE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_cohort_search_cohorts
Search for cohorts.
Arguments
query (Required)
Query string
General structure
string //Query string
XML-RPC (PHP structure)
[query] => string
REST (POST parameters)
query= string
General structure
object {
contextid int Default to "0" //Context ID. Either use this value, or level and instanceid.
contextlevel string Default to "" //Context level. To be used with instanceid.
instanceid int Default to "0" //Context instance ID. To be used with level
}
XML-RPC (PHP structure)
[context] => Array ( [contextid] => int [contextlevel] => string [instanceid] => int )
REST (POST parameters)
context[contextid]= int context[contextlevel]= string context[instanceid]= int
What other contexts to fetch the frameworks from. (all, parents, self)
General structure
string Default to "parents" //What other contexts to fetch the frameworks from. (all, parents, self)
XML-RPC (PHP structure)
[includes] => string
REST (POST parameters)
includes= string
limitfrom we are fetching the records from
General structure
int Default to "0" //limitfrom we are fetching the records from
XML-RPC (PHP structure)
[limitfrom] => int
REST (POST parameters)
limitfrom= int
Number of records to fetch
General structure
int Default to "25" //Number of records to fetch
XML-RPC (PHP structure)
[limitnum] => int
REST (POST parameters)
limitnum= int
Response
General structure
object {
cohorts list of (
object {
id int //ID of the cohort
name string //cohort name
idnumber string //cohort idnumber
description string //cohort description
descriptionformat int //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //cohort visible
theme string Optional //cohort theme
}
)}
XML-RPC (PHP structure)
Array ( [cohorts] => Array ( [0] => Array ( [id] => int [name] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [theme] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="cohorts"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="theme"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_cohort_update_cohorts
Updates existing cohorts.
Arguments
cohorts (Required)
General structure
list of (
object {
id int //ID of the cohort
categorytype object {
type string //the name of the field: id (numeric value of course category id) or idnumber (alphanumeric value of idnumber course category) or system (value ignored)
value string //the value of the categorytype
}
name string //cohort name
idnumber string //cohort idnumber
description string Optional //cohort description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int Optional //cohort visible
theme string Optional //the cohort theme. The allowcohortthemes setting must be enabled on Moodle
}
)
XML-RPC (PHP structure)
[cohorts] => Array ( [0] => Array ( [id] => int [categorytype] => Array ( [type] => string [value] => string ) [name] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [theme] => string ) )
REST (POST parameters)
cohorts[0][id]= int cohorts[0][categorytype][type]= string cohorts[0][categorytype][value]= string cohorts[0][name]= string cohorts[0][idnumber]= string cohorts[0][description]= string cohorts[0][descriptionformat]= int cohorts[0][visible]= int cohorts[0][theme]= string
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_comment_get_comments
Returns comments.
Arguments
contextlevel (Required)
contextlevel system, course, user...
General structure
string //contextlevel system, course, user...
XML-RPC (PHP structure)
[contextlevel] => string
REST (POST parameters)
contextlevel= string
the Instance id of item associated with the context level
General structure
int //the Instance id of item associated with the context level
XML-RPC (PHP structure)
[instanceid] => int
REST (POST parameters)
instanceid= int
component
General structure
string //component
XML-RPC (PHP structure)
[component] => string
REST (POST parameters)
component= string
associated id
General structure
int //associated id
XML-RPC (PHP structure)
[itemid] => int
REST (POST parameters)
itemid= int
string comment area
General structure
string Default to "" //string comment area
XML-RPC (PHP structure)
[area] => string
REST (POST parameters)
area= string
page number (0 based)
General structure
int Default to "0" //page number (0 based)
XML-RPC (PHP structure)
[page] => int
REST (POST parameters)
page= int
Response
General structure
object {
comments //List of comments
list of (
//comment
object {
id int //Comment ID
content string //The content text formated
format int //content format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
timecreated int //Time created (timestamp)
strftimeformat string //Time format
profileurl string //URL profile
fullname string //fullname
time string //Time in human format
avatar string //HTML user picture
userid int //User ID
delete int Optional //Permission to delete=true/false
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [comments] => Array ( [0] => Array ( [id] => int [content] => string [format] => int [timecreated] => int [strftimeformat] => string [profileurl] => string [fullname] => string [time] => string [avatar] => string [userid] => int [delete] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="comments"> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="content"> <VALUE>string</VALUE> </KEY> <KEY name="format"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="strftimeformat"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="time"> <VALUE>string</VALUE> </KEY> <KEY name="avatar"> <VALUE>string</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="delete"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_competency_add_competency_to_course
Add the competency to a course
Arguments
courseid (Required)
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_add_competency_to_plan
Add the competency to a learning plan
Arguments
planid (Required)
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_add_competency_to_template
Add the competency to a template
Arguments
templateid (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[templateid] => int
REST (POST parameters)
templateid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_add_related_competency
Adds a related competency
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The related competency id
General structure
int //The related competency id
XML-RPC (PHP structure)
[relatedcompetencyid] => int
REST (POST parameters)
relatedcompetencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_approve_plan
Approve a plan.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_competency_framework_viewed
Log event competency framework viewed
Arguments
id (Required)
The competency framework id
General structure
int //The competency framework id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the event competency framework was logged
General structure
int //True if the event competency framework was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_competency_viewed
Log event competency viewed
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the event competency viewed was logged
General structure
int //True if the event competency viewed was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_complete_plan
Complete learning plan.
Arguments
planid (Required)
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Response
True if completing learning plan was successful
General structure
int //True if completing learning plan was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_competencies
Count a list of a competencies.
Arguments
filters (Required)
General structure
list of (
object {
column string //Column name to filter by
value string //Value to filter by. Must be exact match
}
)
XML-RPC (PHP structure)
[filters] => Array ( [0] => Array ( [column] => string [value] => string ) )
REST (POST parameters)
filters[0][column]= string filters[0][value]= string
Response
The number of competencies found.
General structure
int //The number of competencies found.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_competencies_in_course
List the competencies in a course
Arguments
id (Required)
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The number of competencies in this course.
General structure
int //The number of competencies in this course.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_competencies_in_template
Count a list of a competencies for a given template.
Arguments
id (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The number of competencies in this learning plan template.
General structure
int //The number of competencies in this learning plan template.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_competency_frameworks
Count a list of a competency frameworks.
Arguments
context (Required)
General structure
object {
contextid int Default to "0" //Context ID. Either use this value, or level and instanceid.
contextlevel string Default to "" //Context level. To be used with instanceid.
instanceid int Default to "0" //Context instance ID. To be used with level
}
XML-RPC (PHP structure)
[context] => Array ( [contextid] => int [contextlevel] => string [instanceid] => int )
REST (POST parameters)
context[contextid]= int context[contextlevel]= string context[instanceid]= int
What other contextes to fetch the frameworks from. (children, parents, self)
General structure
string Default to "children" //What other contextes to fetch the frameworks from. (children, parents, self)
XML-RPC (PHP structure)
[includes] => string
REST (POST parameters)
includes= string
Response
The number of competency frameworks found.
General structure
int //The number of competency frameworks found.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_courses_using_competency
List the courses using a competency
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The number of courses using this competency
General structure
int //The number of courses using this competency
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_templates
Count a list of a learning plan templates.
Arguments
context (Required)
General structure
object {
contextid int Default to "0" //Context ID. Either use this value, or level and instanceid.
contextlevel string Default to "" //Context level. To be used with instanceid.
instanceid int Default to "0" //Context instance ID. To be used with level
}
XML-RPC (PHP structure)
[context] => Array ( [contextid] => int [contextlevel] => string [instanceid] => int )
REST (POST parameters)
context[contextid]= int context[contextlevel]= string context[instanceid]= int
What other contextes to fetch the frameworks from. (children, parents, self)
General structure
string Default to "children" //What other contextes to fetch the frameworks from. (children, parents, self)
XML-RPC (PHP structure)
[includes] => string
REST (POST parameters)
includes= string
Response
The number of learning plan templates found.
General structure
int //The number of learning plan templates found.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_count_templates_using_competency
Count a list of a learning plan templates for a given competency.
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The number of learning plan templates using this competency
General structure
int //The number of learning plan templates using this competency
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_create_competency
Creates new competencies.
Arguments
competency (Required)
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string Default to "" //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int Default to "0" //sortorder
parentid int Default to "0" //parentid
path string Default to "/0/" //path
ruleoutcome int Default to "0" //ruleoutcome
ruletype string Default to "null" //ruletype
ruleconfig string Default to "null" //ruleconfig
scaleid int Default to "null" //scaleid
scaleconfiguration string Default to "null" //scaleconfiguration
competencyframeworkid int Default to "0" //competencyframeworkid
timecreated int Default to "0" //timecreated
timemodified int Default to "0" //timemodified
usermodified int Default to "0" //usermodified
}
XML-RPC (PHP structure)
[competency] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
competency[shortname]= string competency[idnumber]= string competency[description]= string competency[descriptionformat]= int competency[sortorder]= int competency[parentid]= int competency[path]= string competency[ruleoutcome]= int competency[ruletype]= string competency[ruleconfig]= string competency[scaleid]= int competency[scaleconfiguration]= string competency[competencyframeworkid]= int competency[timecreated]= int competency[timemodified]= int competency[usermodified]= int
Response
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
XML-RPC (PHP structure)
Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_create_competency_framework
Creates new competency frameworks.
Arguments
competencyframework (Required)
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string Default to "" //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int Default to "1" //visible
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
contextid int Optional //The context id
contextlevel string Optional //The context level
instanceid int Optional //The Instance id
taxonomies string Default to "" //taxonomies
timecreated int Default to "0" //timecreated
timemodified int Default to "0" //timemodified
usermodified int Default to "0" //usermodified
}
XML-RPC (PHP structure)
[competencyframework] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [contextlevel] => string [instanceid] => int [taxonomies] => string [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
competencyframework[shortname]= string competencyframework[idnumber]= string competencyframework[description]= string competencyframework[descriptionformat]= int competencyframework[visible]= int competencyframework[scaleid]= int competencyframework[scaleconfiguration]= string competencyframework[contextid]= int competencyframework[contextlevel]= string competencyframework[instanceid]= int competencyframework[taxonomies]= string competencyframework[timecreated]= int competencyframework[timemodified]= int competencyframework[usermodified]= int
Response
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //visible
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
contextid int //contextid
taxonomies string //taxonomies
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canmanage int //canmanage
competenciescount int //competenciescount
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [taxonomies] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canmanage] => int [competenciescount] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="taxonomies"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="competenciescount"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_create_plan
Creates a learning plan.
Arguments
plan (Required)
General structure
object {
name string //name
description string Default to "" //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int //userid
templateid int Default to "null" //templateid
origtemplateid int Default to "null" //origtemplateid
status int Default to "0" //status
duedate int Default to "0" //duedate
reviewerid int Default to "null" //reviewerid
timecreated int Default to "0" //timecreated
timemodified int Default to "0" //timemodified
usermodified int Default to "0" //usermodified
}
XML-RPC (PHP structure)
[plan] => Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
plan[name]= string plan[description]= string plan[descriptionformat]= int plan[userid]= int plan[templateid]= int plan[origtemplateid]= int plan[status]= int plan[duedate]= int plan[reviewerid]= int plan[timecreated]= int plan[timemodified]= int plan[usermodified]= int
Response
General structure
object {
name string //name
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int //userid
templateid int //templateid
origtemplateid int //origtemplateid
status int //status
duedate int //duedate
reviewerid int //reviewerid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
statusname string //statusname
isbasedontemplate int //isbasedontemplate
canmanage int //canmanage
canrequestreview int //canrequestreview
canreview int //canreview
canbeedited int //canbeedited
isactive int //isactive
isdraft int //isdraft
iscompleted int //iscompleted
isinreview int //isinreview
iswaitingforreview int //iswaitingforreview
isreopenallowed int //isreopenallowed
iscompleteallowed int //iscompleteallowed
isunlinkallowed int //isunlinkallowed
isrequestreviewallowed int //isrequestreviewallowed
iscancelreviewrequestallowed int //iscancelreviewrequestallowed
isstartreviewallowed int //isstartreviewallowed
isstopreviewallowed int //isstopreviewallowed
isapproveallowed int //isapproveallowed
isunapproveallowed int //isunapproveallowed
duedateformatted string //duedateformatted
commentarea object {
component string //component
commentarea string //commentarea
itemid int //itemid
courseid int //courseid
contextid int //contextid
cid string //cid
autostart int //autostart
canpost int //canpost
canview int //canview
count int //count
collapsediconkey string //collapsediconkey
displaytotalcount int //displaytotalcount
displaycancel int //displaycancel
fullwidth int //fullwidth
linktext string //linktext
notoggle int //notoggle
template string //template
canpostorhascomments int //canpostorhascomments
}
reviewer object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
template object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
url string //url
}
XML-RPC (PHP structure)
Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [statusname] => string [isbasedontemplate] => int [canmanage] => int [canrequestreview] => int [canreview] => int [canbeedited] => int [isactive] => int [isdraft] => int [iscompleted] => int [isinreview] => int [iswaitingforreview] => int [isreopenallowed] => int [iscompleteallowed] => int [isunlinkallowed] => int [isrequestreviewallowed] => int [iscancelreviewrequestallowed] => int [isstartreviewallowed] => int [isstopreviewallowed] => int [isapproveallowed] => int [isunapproveallowed] => int [duedateformatted] => string [commentarea] => Array ( [component] => string [commentarea] => string [itemid] => int [courseid] => int [contextid] => int [cid] => string [autostart] => int [canpost] => int [canview] => int [count] => int [collapsediconkey] => string [displaytotalcount] => int [displaycancel] => int [fullwidth] => int [linktext] => string [notoggle] => int [template] => string [canpostorhascomments] => int ) [reviewer] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) [url] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="templateid"> <VALUE>int</VALUE> </KEY> <KEY name="origtemplateid"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="reviewerid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="statusname"> <VALUE>string</VALUE> </KEY> <KEY name="isbasedontemplate"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canrequestreview"> <VALUE>int</VALUE> </KEY> <KEY name="canreview"> <VALUE>int</VALUE> </KEY> <KEY name="canbeedited"> <VALUE>int</VALUE> </KEY> <KEY name="isactive"> <VALUE>int</VALUE> </KEY> <KEY name="isdraft"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleted"> <VALUE>int</VALUE> </KEY> <KEY name="isinreview"> <VALUE>int</VALUE> </KEY> <KEY name="iswaitingforreview"> <VALUE>int</VALUE> </KEY> <KEY name="isreopenallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleteallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunlinkallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isrequestreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscancelreviewrequestallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstartreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstopreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <SINGLE> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="cid"> <VALUE>string</VALUE> </KEY> <KEY name="autostart"> <VALUE>int</VALUE> </KEY> <KEY name="canpost"> <VALUE>int</VALUE> </KEY> <KEY name="canview"> <VALUE>int</VALUE> </KEY> <KEY name="count"> <VALUE>int</VALUE> </KEY> <KEY name="collapsediconkey"> <VALUE>string</VALUE> </KEY> <KEY name="displaytotalcount"> <VALUE>int</VALUE> </KEY> <KEY name="displaycancel"> <VALUE>int</VALUE> </KEY> <KEY name="fullwidth"> <VALUE>int</VALUE> </KEY> <KEY name="linktext"> <VALUE>string</VALUE> </KEY> <KEY name="notoggle"> <VALUE>int</VALUE> </KEY> <KEY name="template"> <VALUE>string</VALUE> </KEY> <KEY name="canpostorhascomments"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="reviewer"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="template"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_create_template
Creates new learning plan templates.
Arguments
template (Required)
General structure
object {
shortname string //shortname
description string Default to "" //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int Default to "0" //duedate
visible int Default to "1" //visible
contextid int Optional //The context id
contextlevel string Optional //The context level
instanceid int Optional //The Instance id
timecreated int Default to "0" //timecreated
timemodified int Default to "0" //timemodified
usermodified int Default to "0" //usermodified
}
XML-RPC (PHP structure)
[template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [contextlevel] => string [instanceid] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
template[shortname]= string template[description]= string template[descriptionformat]= int template[duedate]= int template[visible]= int template[contextid]= int template[contextlevel]= string template[instanceid]= int template[timecreated]= int template[timemodified]= int template[usermodified]= int
Response
General structure
object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_create_user_evidence_competency
Create an evidence of prior learning relationship with a competency.
Arguments
userevidenceid (Required)
The user evidence ID.
General structure
int //The user evidence ID.
XML-RPC (PHP structure)
[userevidenceid] => int
REST (POST parameters)
userevidenceid= int
The competency ID.
General structure
int //The competency ID.
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
General structure
object {
userevidenceid int //userevidenceid
competencyid int //competencyid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
XML-RPC (PHP structure)
Array ( [userevidenceid] => int [competencyid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="userevidenceid"> <VALUE>int</VALUE> </KEY> <KEY name="competencyid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_competency
Delete a competency.
Arguments
id (Required)
Data base record id for the competency
General structure
int //Data base record id for the competency
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_competency_framework
Delete a competency framework.
Arguments
id (Required)
Data base record id for the framework
General structure
int //Data base record id for the framework
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_evidence
Delete an evidence
Arguments
id (Required)
The evidence ID
General structure
int //The evidence ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_plan
Delete a learning plan.
Arguments
id (Required)
Data base record id for the learning plan
General structure
int //Data base record id for the learning plan
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_template
Delete a learning plan template.
Arguments
id (Required)
Data base record id for the template
General structure
int //Data base record id for the template
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Boolean to indicate if plans must be deleted
General structure
int //Boolean to indicate if plans must be deleted
XML-RPC (PHP structure)
[deleteplans] => int
REST (POST parameters)
deleteplans= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_user_evidence
Delete an evidence of prior learning.
Arguments
id (Required)
The user evidence ID.
General structure
int //The user evidence ID.
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_delete_user_evidence_competency
Delete an evidence of prior learning relationship with a competency.
Arguments
userevidenceid (Required)
The user evidence ID.
General structure
int //The user evidence ID.
XML-RPC (PHP structure)
[userevidenceid] => int
REST (POST parameters)
userevidenceid= int
The competency ID.
General structure
int //The competency ID.
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if the delete was successful
General structure
int //True if the delete was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_duplicate_competency_framework
Duplicate a competency framework.
Arguments
id (Required)
Data base record id for the framework
General structure
int //Data base record id for the framework
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //visible
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
contextid int //contextid
taxonomies string //taxonomies
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canmanage int //canmanage
competenciescount int //competenciescount
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [taxonomies] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canmanage] => int [competenciescount] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="taxonomies"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="competenciescount"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_duplicate_template
Duplicate learning plan template.
Arguments
id (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_get_scale_values
Fetch the values for a specific scale
Arguments
scaleid (Required)
The scale id
General structure
int //The scale id
XML-RPC (PHP structure)
[scaleid] => int
REST (POST parameters)
scaleid= int
Response
General structure
list of (
object {
id int //Scale value ID
name string //Scale value name
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [id] => int [name] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_grade_competency
Grade a competency.
Arguments
userid (Required)
User ID
General structure
int //User ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Competency ID
General structure
int //Competency ID
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
New grade
General structure
int //New grade
XML-RPC (PHP structure)
[grade] => int
REST (POST parameters)
grade= int
A note to attach to the evidence
General structure
string Default to "null" //A note to attach to the evidence
XML-RPC (PHP structure)
[note] => string
REST (POST parameters)
note= string
Response
General structure
object {
usercompetencyid int //usercompetencyid
contextid int //contextid
action int //action
actionuserid int //actionuserid
descidentifier string //descidentifier
desccomponent string //desccomponent
desca string //desca
url string //url
grade int //grade
note string //note
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
actionuser object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
description string //description
gradename string //gradename
userdate string //userdate
candelete int //candelete
}
XML-RPC (PHP structure)
Array ( [usercompetencyid] => int [contextid] => int [action] => int [actionuserid] => int [descidentifier] => string [desccomponent] => string [desca] => string [url] => string [grade] => int [note] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [actionuser] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [description] => string [gradename] => string [userdate] => string [candelete] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="usercompetencyid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="action"> <VALUE>int</VALUE> </KEY> <KEY name="actionuserid"> <VALUE>int</VALUE> </KEY> <KEY name="descidentifier"> <VALUE>string</VALUE> </KEY> <KEY name="desccomponent"> <VALUE>string</VALUE> </KEY> <KEY name="desca"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="grade"> <VALUE>int</VALUE> </KEY> <KEY name="note"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="actionuser"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="gradename"> <VALUE>string</VALUE> </KEY> <KEY name="userdate"> <VALUE>string</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_grade_competency_in_course
Grade a competency from the course page.
Arguments
courseid (Required)
Course id
General structure
int //Course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
User id
General structure
int //User id
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Competency id
General structure
int //Competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
New grade
General structure
int //New grade
XML-RPC (PHP structure)
[grade] => int
REST (POST parameters)
grade= int
A note to attach to the evidence
General structure
string Default to "null" //A note to attach to the evidence
XML-RPC (PHP structure)
[note] => string
REST (POST parameters)
note= string
Response
General structure
object {
usercompetencyid int //usercompetencyid
contextid int //contextid
action int //action
actionuserid int //actionuserid
descidentifier string //descidentifier
desccomponent string //desccomponent
desca string //desca
url string //url
grade int //grade
note string //note
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
actionuser object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
description string //description
gradename string //gradename
userdate string //userdate
candelete int //candelete
}
XML-RPC (PHP structure)
Array ( [usercompetencyid] => int [contextid] => int [action] => int [actionuserid] => int [descidentifier] => string [desccomponent] => string [desca] => string [url] => string [grade] => int [note] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [actionuser] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [description] => string [gradename] => string [userdate] => string [candelete] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="usercompetencyid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="action"> <VALUE>int</VALUE> </KEY> <KEY name="actionuserid"> <VALUE>int</VALUE> </KEY> <KEY name="descidentifier"> <VALUE>string</VALUE> </KEY> <KEY name="desccomponent"> <VALUE>string</VALUE> </KEY> <KEY name="desca"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="grade"> <VALUE>int</VALUE> </KEY> <KEY name="note"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="actionuser"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="gradename"> <VALUE>string</VALUE> </KEY> <KEY name="userdate"> <VALUE>string</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_grade_competency_in_plan
Grade a competency from the user plan page.
Arguments
planid (Required)
Plan id
General structure
int //Plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Competency id
General structure
int //Competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
New grade
General structure
int //New grade
XML-RPC (PHP structure)
[grade] => int
REST (POST parameters)
grade= int
A note to attach to the evidence
General structure
string Default to "null" //A note to attach to the evidence
XML-RPC (PHP structure)
[note] => string
REST (POST parameters)
note= string
Response
General structure
object {
usercompetencyid int //usercompetencyid
contextid int //contextid
action int //action
actionuserid int //actionuserid
descidentifier string //descidentifier
desccomponent string //desccomponent
desca string //desca
url string //url
grade int //grade
note string //note
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
actionuser object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
description string //description
gradename string //gradename
userdate string //userdate
candelete int //candelete
}
XML-RPC (PHP structure)
Array ( [usercompetencyid] => int [contextid] => int [action] => int [actionuserid] => int [descidentifier] => string [desccomponent] => string [desca] => string [url] => string [grade] => int [note] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [actionuser] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [description] => string [gradename] => string [userdate] => string [candelete] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="usercompetencyid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="action"> <VALUE>int</VALUE> </KEY> <KEY name="actionuserid"> <VALUE>int</VALUE> </KEY> <KEY name="descidentifier"> <VALUE>string</VALUE> </KEY> <KEY name="desccomponent"> <VALUE>string</VALUE> </KEY> <KEY name="desca"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="grade"> <VALUE>int</VALUE> </KEY> <KEY name="note"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="actionuser"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="gradename"> <VALUE>string</VALUE> </KEY> <KEY name="userdate"> <VALUE>string</VALUE> </KEY> <KEY name="candelete"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_competencies
Load a list of a competencies.
Arguments
filters (Required)
General structure
list of (
object {
column string //Column name to filter by
value string //Value to filter by. Must be exact match
}
)
XML-RPC (PHP structure)
[filters] => Array ( [0] => Array ( [column] => string [value] => string ) )
REST (POST parameters)
filters[0][column]= string filters[0][value]= string
Column to sort by.
General structure
string Default to "" //Column to sort by.
XML-RPC (PHP structure)
[sort] => string
REST (POST parameters)
sort= string
Sort direction. Should be either ASC or DESC
General structure
string Default to "" //Sort direction. Should be either ASC or DESC
XML-RPC (PHP structure)
[order] => string
REST (POST parameters)
order= string
Skip this number of records before returning results
General structure
int Default to "0" //Skip this number of records before returning results
XML-RPC (PHP structure)
[skip] => int
REST (POST parameters)
skip= int
Return this number of records at most.
General structure
int Default to "0" //Return this number of records at most.
XML-RPC (PHP structure)
[limit] => int
REST (POST parameters)
limit= int
Response
General structure
list of (
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_competencies_in_template
Load a list of a competencies for a given template.
Arguments
id (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
list of (
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_competency_frameworks
Load a list of a competency frameworks.
Arguments
sort (Default to "shortname")
Column to sort by.
General structure
string Default to "shortname" //Column to sort by.
XML-RPC (PHP structure)
[sort] => string
REST (POST parameters)
sort= string
Sort direction. Should be either ASC or DESC
General structure
string Default to "" //Sort direction. Should be either ASC or DESC
XML-RPC (PHP structure)
[order] => string
REST (POST parameters)
order= string
Skip this number of records before returning results
General structure
int Default to "0" //Skip this number of records before returning results
XML-RPC (PHP structure)
[skip] => int
REST (POST parameters)
skip= int
Return this number of records at most.
General structure
int Default to "0" //Return this number of records at most.
XML-RPC (PHP structure)
[limit] => int
REST (POST parameters)
limit= int
General structure
object {
contextid int Default to "0" //Context ID. Either use this value, or level and instanceid.
contextlevel string Default to "" //Context level. To be used with instanceid.
instanceid int Default to "0" //Context instance ID. To be used with level
}
XML-RPC (PHP structure)
[context] => Array ( [contextid] => int [contextlevel] => string [instanceid] => int )
REST (POST parameters)
context[contextid]= int context[contextlevel]= string context[instanceid]= int
What other contextes to fetch the frameworks from. (children, parents, self)
General structure
string Default to "children" //What other contextes to fetch the frameworks from. (children, parents, self)
XML-RPC (PHP structure)
[includes] => string
REST (POST parameters)
includes= string
Only visible frameworks will be returned if visible true
General structure
int Default to "" //Only visible frameworks will be returned if visible true
XML-RPC (PHP structure)
[onlyvisible] => int
REST (POST parameters)
onlyvisible= int
A query string to filter the results
General structure
string Default to "" //A query string to filter the results
XML-RPC (PHP structure)
[query] => string
REST (POST parameters)
query= string
Response
General structure
list of (
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //visible
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
contextid int //contextid
taxonomies string //taxonomies
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canmanage int //canmanage
competenciescount int //competenciescount
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [taxonomies] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canmanage] => int [competenciescount] => int [contextname] => string [contextnamenoprefix] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="taxonomies"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="competenciescount"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_course_competencies
List the competencies in a course
Arguments
id (Required)
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
list of (
object {
competency object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
coursecompetency object {
courseid int //courseid
competencyid int //competencyid
sortorder int //sortorder
ruleoutcome int //ruleoutcome
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [competency] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) [coursecompetency] => Array ( [courseid] => int [competencyid] => int [sortorder] => int [ruleoutcome] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="competency"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="coursecompetency"> <SINGLE> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="competencyid"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_plan_competencies
List the competencies in a plan
Arguments
id (Required)
The plan ID.
General structure
int //The plan ID.
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
list of (
object {
competency object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
usercompetency object {
userid int //userid
competencyid int //competencyid
status int //status
reviewerid int //reviewerid
proficiency int //proficiency
grade int //grade
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canrequestreview int //canrequestreview
canreview int //canreview
gradename string //gradename
isrequestreviewallowed int //isrequestreviewallowed
iscancelreviewrequestallowed int //iscancelreviewrequestallowed
isstartreviewallowed int //isstartreviewallowed
isstopreviewallowed int //isstopreviewallowed
isstatusidle int //isstatusidle
isstatusinreview int //isstatusinreview
isstatuswaitingforreview int //isstatuswaitingforreview
proficiencyname string //proficiencyname
reviewer object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
statusname string //statusname
url string //url
}
usercompetencyplan object {
userid int //userid
competencyid int //competencyid
proficiency int //proficiency
grade int //grade
planid int //planid
sortorder int //sortorder
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
gradename string //gradename
proficiencyname string //proficiencyname
}
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [competency] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) [usercompetency] => Array ( [userid] => int [competencyid] => int [status] => int [reviewerid] => int [proficiency] => int [grade] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canrequestreview] => int [canreview] => int [gradename] => string [isrequestreviewallowed] => int [iscancelreviewrequestallowed] => int [isstartreviewallowed] => int [isstopreviewallowed] => int [isstatusidle] => int [isstatusinreview] => int [isstatuswaitingforreview] => int [proficiencyname] => string [reviewer] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [statusname] => string [url] => string ) [usercompetencyplan] => Array ( [userid] => int [competencyid] => int [proficiency] => int [grade] => int [planid] => int [sortorder] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [gradename] => string [proficiencyname] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="competency"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="usercompetency"> <SINGLE> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="competencyid"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="reviewerid"> <VALUE>int</VALUE> </KEY> <KEY name="proficiency"> <VALUE>int</VALUE> </KEY> <KEY name="grade"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canrequestreview"> <VALUE>int</VALUE> </KEY> <KEY name="canreview"> <VALUE>int</VALUE> </KEY> <KEY name="gradename"> <VALUE>string</VALUE> </KEY> <KEY name="isrequestreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscancelreviewrequestallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstartreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstopreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstatusidle"> <VALUE>int</VALUE> </KEY> <KEY name="isstatusinreview"> <VALUE>int</VALUE> </KEY> <KEY name="isstatuswaitingforreview"> <VALUE>int</VALUE> </KEY> <KEY name="proficiencyname"> <VALUE>string</VALUE> </KEY> <KEY name="reviewer"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="statusname"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="usercompetencyplan"> <SINGLE> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="competencyid"> <VALUE>int</VALUE> </KEY> <KEY name="proficiency"> <VALUE>int</VALUE> </KEY> <KEY name="grade"> <VALUE>int</VALUE> </KEY> <KEY name="planid"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="gradename"> <VALUE>string</VALUE> </KEY> <KEY name="proficiencyname"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_templates
Load a list of a learning plan templates.
Arguments
sort (Default to "")
Column to sort by.
General structure
string Default to "" //Column to sort by.
XML-RPC (PHP structure)
[sort] => string
REST (POST parameters)
sort= string
Sort direction. Should be either ASC or DESC
General structure
string Default to "" //Sort direction. Should be either ASC or DESC
XML-RPC (PHP structure)
[order] => string
REST (POST parameters)
order= string
Skip this number of records before returning results
General structure
int Default to "0" //Skip this number of records before returning results
XML-RPC (PHP structure)
[skip] => int
REST (POST parameters)
skip= int
Return this number of records at most.
General structure
int Default to "0" //Return this number of records at most.
XML-RPC (PHP structure)
[limit] => int
REST (POST parameters)
limit= int
General structure
object {
contextid int Default to "0" //Context ID. Either use this value, or level and instanceid.
contextlevel string Default to "" //Context level. To be used with instanceid.
instanceid int Default to "0" //Context instance ID. To be used with level
}
XML-RPC (PHP structure)
[context] => Array ( [contextid] => int [contextlevel] => string [instanceid] => int )
REST (POST parameters)
context[contextid]= int context[contextlevel]= string context[instanceid]= int
What other contexts to fetch the templates from. (children, parents, self)
General structure
string Default to "children" //What other contexts to fetch the templates from. (children, parents, self)
XML-RPC (PHP structure)
[includes] => string
REST (POST parameters)
includes= string
If should list only visible templates
General structure
int Default to "" //If should list only visible templates
XML-RPC (PHP structure)
[onlyvisible] => int
REST (POST parameters)
onlyvisible= int
Response
General structure
list of (
object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_templates_using_competency
Load a list of a learning plan templates for a given competency.
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
list of (
object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_list_user_plans
List a user's learning plans.
Arguments
userid (Required)
The user ID
General structure
int //The user ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Response
General structure
list of (
object {
name string //name
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int //userid
templateid int //templateid
origtemplateid int //origtemplateid
status int //status
duedate int //duedate
reviewerid int //reviewerid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
statusname string //statusname
isbasedontemplate int //isbasedontemplate
canmanage int //canmanage
canrequestreview int //canrequestreview
canreview int //canreview
canbeedited int //canbeedited
isactive int //isactive
isdraft int //isdraft
iscompleted int //iscompleted
isinreview int //isinreview
iswaitingforreview int //iswaitingforreview
isreopenallowed int //isreopenallowed
iscompleteallowed int //iscompleteallowed
isunlinkallowed int //isunlinkallowed
isrequestreviewallowed int //isrequestreviewallowed
iscancelreviewrequestallowed int //iscancelreviewrequestallowed
isstartreviewallowed int //isstartreviewallowed
isstopreviewallowed int //isstopreviewallowed
isapproveallowed int //isapproveallowed
isunapproveallowed int //isunapproveallowed
duedateformatted string //duedateformatted
commentarea object {
component string //component
commentarea string //commentarea
itemid int //itemid
courseid int //courseid
contextid int //contextid
cid string //cid
autostart int //autostart
canpost int //canpost
canview int //canview
count int //count
collapsediconkey string //collapsediconkey
displaytotalcount int //displaytotalcount
displaycancel int //displaycancel
fullwidth int //fullwidth
linktext string //linktext
notoggle int //notoggle
template string //template
canpostorhascomments int //canpostorhascomments
}
reviewer object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
template object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
url string //url
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [statusname] => string [isbasedontemplate] => int [canmanage] => int [canrequestreview] => int [canreview] => int [canbeedited] => int [isactive] => int [isdraft] => int [iscompleted] => int [isinreview] => int [iswaitingforreview] => int [isreopenallowed] => int [iscompleteallowed] => int [isunlinkallowed] => int [isrequestreviewallowed] => int [iscancelreviewrequestallowed] => int [isstartreviewallowed] => int [isstopreviewallowed] => int [isapproveallowed] => int [isunapproveallowed] => int [duedateformatted] => string [commentarea] => Array ( [component] => string [commentarea] => string [itemid] => int [courseid] => int [contextid] => int [cid] => string [autostart] => int [canpost] => int [canview] => int [count] => int [collapsediconkey] => string [displaytotalcount] => int [displaycancel] => int [fullwidth] => int [linktext] => string [notoggle] => int [template] => string [canpostorhascomments] => int ) [reviewer] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) [url] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="templateid"> <VALUE>int</VALUE> </KEY> <KEY name="origtemplateid"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="reviewerid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="statusname"> <VALUE>string</VALUE> </KEY> <KEY name="isbasedontemplate"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canrequestreview"> <VALUE>int</VALUE> </KEY> <KEY name="canreview"> <VALUE>int</VALUE> </KEY> <KEY name="canbeedited"> <VALUE>int</VALUE> </KEY> <KEY name="isactive"> <VALUE>int</VALUE> </KEY> <KEY name="isdraft"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleted"> <VALUE>int</VALUE> </KEY> <KEY name="isinreview"> <VALUE>int</VALUE> </KEY> <KEY name="iswaitingforreview"> <VALUE>int</VALUE> </KEY> <KEY name="isreopenallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleteallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunlinkallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isrequestreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscancelreviewrequestallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstartreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstopreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <SINGLE> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="cid"> <VALUE>string</VALUE> </KEY> <KEY name="autostart"> <VALUE>int</VALUE> </KEY> <KEY name="canpost"> <VALUE>int</VALUE> </KEY> <KEY name="canview"> <VALUE>int</VALUE> </KEY> <KEY name="count"> <VALUE>int</VALUE> </KEY> <KEY name="collapsediconkey"> <VALUE>string</VALUE> </KEY> <KEY name="displaytotalcount"> <VALUE>int</VALUE> </KEY> <KEY name="displaycancel"> <VALUE>int</VALUE> </KEY> <KEY name="fullwidth"> <VALUE>int</VALUE> </KEY> <KEY name="linktext"> <VALUE>string</VALUE> </KEY> <KEY name="notoggle"> <VALUE>int</VALUE> </KEY> <KEY name="template"> <VALUE>string</VALUE> </KEY> <KEY name="canpostorhascomments"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="reviewer"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="template"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_move_down_competency
Re-order a competency.
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_move_up_competency
Re-order a competency.
Arguments
id (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_plan_cancel_review_request
Cancel the review of a plan.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_plan_request_review
Request for a plan to be reviewed.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_plan_start_review
Start the review of a plan.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_plan_stop_review
Stop the review of a plan.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_read_competency
Load a summary of a competency.
Arguments
id (Required)
Data base record id for the competency
General structure
int //Data base record id for the competency
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
XML-RPC (PHP structure)
Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_read_competency_framework
Load a summary of a competency framework.
Arguments
id (Required)
Data base record id for the framework
General structure
int //Data base record id for the framework
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int //visible
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
contextid int //contextid
taxonomies string //taxonomies
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canmanage int //canmanage
competenciescount int //competenciescount
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [taxonomies] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canmanage] => int [competenciescount] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="taxonomies"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="competenciescount"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_read_plan
Load a learning plan.
Arguments
id (Required)
Data base record id for the plan
General structure
int //Data base record id for the plan
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
name string //name
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int //userid
templateid int //templateid
origtemplateid int //origtemplateid
status int //status
duedate int //duedate
reviewerid int //reviewerid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
statusname string //statusname
isbasedontemplate int //isbasedontemplate
canmanage int //canmanage
canrequestreview int //canrequestreview
canreview int //canreview
canbeedited int //canbeedited
isactive int //isactive
isdraft int //isdraft
iscompleted int //iscompleted
isinreview int //isinreview
iswaitingforreview int //iswaitingforreview
isreopenallowed int //isreopenallowed
iscompleteallowed int //iscompleteallowed
isunlinkallowed int //isunlinkallowed
isrequestreviewallowed int //isrequestreviewallowed
iscancelreviewrequestallowed int //iscancelreviewrequestallowed
isstartreviewallowed int //isstartreviewallowed
isstopreviewallowed int //isstopreviewallowed
isapproveallowed int //isapproveallowed
isunapproveallowed int //isunapproveallowed
duedateformatted string //duedateformatted
commentarea object {
component string //component
commentarea string //commentarea
itemid int //itemid
courseid int //courseid
contextid int //contextid
cid string //cid
autostart int //autostart
canpost int //canpost
canview int //canview
count int //count
collapsediconkey string //collapsediconkey
displaytotalcount int //displaytotalcount
displaycancel int //displaycancel
fullwidth int //fullwidth
linktext string //linktext
notoggle int //notoggle
template string //template
canpostorhascomments int //canpostorhascomments
}
reviewer object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
template object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
url string //url
}
XML-RPC (PHP structure)
Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [statusname] => string [isbasedontemplate] => int [canmanage] => int [canrequestreview] => int [canreview] => int [canbeedited] => int [isactive] => int [isdraft] => int [iscompleted] => int [isinreview] => int [iswaitingforreview] => int [isreopenallowed] => int [iscompleteallowed] => int [isunlinkallowed] => int [isrequestreviewallowed] => int [iscancelreviewrequestallowed] => int [isstartreviewallowed] => int [isstopreviewallowed] => int [isapproveallowed] => int [isunapproveallowed] => int [duedateformatted] => string [commentarea] => Array ( [component] => string [commentarea] => string [itemid] => int [courseid] => int [contextid] => int [cid] => string [autostart] => int [canpost] => int [canview] => int [count] => int [collapsediconkey] => string [displaytotalcount] => int [displaycancel] => int [fullwidth] => int [linktext] => string [notoggle] => int [template] => string [canpostorhascomments] => int ) [reviewer] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) [url] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="templateid"> <VALUE>int</VALUE> </KEY> <KEY name="origtemplateid"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="reviewerid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="statusname"> <VALUE>string</VALUE> </KEY> <KEY name="isbasedontemplate"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canrequestreview"> <VALUE>int</VALUE> </KEY> <KEY name="canreview"> <VALUE>int</VALUE> </KEY> <KEY name="canbeedited"> <VALUE>int</VALUE> </KEY> <KEY name="isactive"> <VALUE>int</VALUE> </KEY> <KEY name="isdraft"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleted"> <VALUE>int</VALUE> </KEY> <KEY name="isinreview"> <VALUE>int</VALUE> </KEY> <KEY name="iswaitingforreview"> <VALUE>int</VALUE> </KEY> <KEY name="isreopenallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleteallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunlinkallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isrequestreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscancelreviewrequestallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstartreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstopreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <SINGLE> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="cid"> <VALUE>string</VALUE> </KEY> <KEY name="autostart"> <VALUE>int</VALUE> </KEY> <KEY name="canpost"> <VALUE>int</VALUE> </KEY> <KEY name="canview"> <VALUE>int</VALUE> </KEY> <KEY name="count"> <VALUE>int</VALUE> </KEY> <KEY name="collapsediconkey"> <VALUE>string</VALUE> </KEY> <KEY name="displaytotalcount"> <VALUE>int</VALUE> </KEY> <KEY name="displaycancel"> <VALUE>int</VALUE> </KEY> <KEY name="fullwidth"> <VALUE>int</VALUE> </KEY> <KEY name="linktext"> <VALUE>string</VALUE> </KEY> <KEY name="notoggle"> <VALUE>int</VALUE> </KEY> <KEY name="template"> <VALUE>string</VALUE> </KEY> <KEY name="canpostorhascomments"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="reviewer"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="template"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_read_template
Load a summary of a learning plan template.
Arguments
id (Required)
Data base record id for the template
General structure
int //Data base record id for the template
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
XML-RPC (PHP structure)
Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_read_user_evidence
Read an evidence of prior learning.
Arguments
id (Required)
The user evidence ID.
General structure
int //The user evidence ID.
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
General structure
object {
userid int //userid
name string //name
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
url string //url
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
canmanage int //canmanage
competencycount int //competencycount
competencies //competencies
list of (
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
)filecount int //filecount
files //files
list of (
object {
contextid int //contextid
component string //component
filearea string //filearea
itemid int //itemid
filepath string //filepath
filename string //filename
isdir int //isdir
timemodified int //timemodified
timecreated int //timecreated
filesize int //filesize
author string //author
license string //license
filenameshort string //filenameshort
filesizeformatted string //filesizeformatted
icon string //icon
timecreatedformatted string //timecreatedformatted
timemodifiedformatted string //timemodifiedformatted
url string //url
}
)hasurlorfiles int //hasurlorfiles
urlshort string //urlshort
}
XML-RPC (PHP structure)
Array ( [userid] => int [name] => string [description] => string [descriptionformat] => int [url] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [canmanage] => int [competencycount] => int [competencies] => Array ( [0] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) ) [filecount] => int [files] => Array ( [0] => Array ( [contextid] => int [component] => string [filearea] => string [itemid] => int [filepath] => string [filename] => string [isdir] => int [timemodified] => int [timecreated] => int [filesize] => int [author] => string [license] => string [filenameshort] => string [filesizeformatted] => string [icon] => string [timecreatedformatted] => string [timemodifiedformatted] => string [url] => string ) ) [hasurlorfiles] => int [urlshort] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="competencycount"> <VALUE>int</VALUE> </KEY> <KEY name="competencies"> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="filecount"> <VALUE>int</VALUE> </KEY> <KEY name="files"> <MULTIPLE> <SINGLE> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="filearea"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="filepath"> <VALUE>string</VALUE> </KEY> <KEY name="filename"> <VALUE>string</VALUE> </KEY> <KEY name="isdir"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="filesize"> <VALUE>int</VALUE> </KEY> <KEY name="author"> <VALUE>string</VALUE> </KEY> <KEY name="license"> <VALUE>string</VALUE> </KEY> <KEY name="filenameshort"> <VALUE>string</VALUE> </KEY> <KEY name="filesizeformatted"> <VALUE>string</VALUE> </KEY> <KEY name="icon"> <VALUE>string</VALUE> </KEY> <KEY name="timecreatedformatted"> <VALUE>string</VALUE> </KEY> <KEY name="timemodifiedformatted"> <VALUE>string</VALUE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="hasurlorfiles"> <VALUE>int</VALUE> </KEY> <KEY name="urlshort"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_remove_competency_from_course
Remove a competency from a course
Arguments
courseid (Required)
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_remove_competency_from_plan
Remove the competency from a learning plan
Arguments
planid (Required)
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_remove_competency_from_template
Remove a competency from a template
Arguments
templateid (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[templateid] => int
REST (POST parameters)
templateid= int
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_remove_related_competency
Remove a related competency
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The related competency id
General structure
int //The related competency id
XML-RPC (PHP structure)
[relatedcompetencyid] => int
REST (POST parameters)
relatedcompetencyid= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_reopen_plan
Reopen learning plan.
Arguments
planid (Required)
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Response
True if reopening learning plan was successful
General structure
int //True if reopening learning plan was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_reorder_course_competency
Move a course competency to a new relative sort order.
Arguments
courseid (Required)
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
The competency id we are moving
General structure
int //The competency id we are moving
XML-RPC (PHP structure)
[competencyidfrom] => int
REST (POST parameters)
competencyidfrom= int
The competency id we are moving to
General structure
int //The competency id we are moving to
XML-RPC (PHP structure)
[competencyidto] => int
REST (POST parameters)
competencyidto= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_reorder_plan_competency
Move a plan competency to a new relative sort order.
Arguments
planid (Required)
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
The competency id we are moving
General structure
int //The competency id we are moving
XML-RPC (PHP structure)
[competencyidfrom] => int
REST (POST parameters)
competencyidfrom= int
The competency id we are moving to
General structure
int //The competency id we are moving to
XML-RPC (PHP structure)
[competencyidto] => int
REST (POST parameters)
competencyidto= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_reorder_template_competency
Move a template competency to a new relative sort order.
Arguments
templateid (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[templateid] => int
REST (POST parameters)
templateid= int
The competency id we are moving
General structure
int //The competency id we are moving
XML-RPC (PHP structure)
[competencyidfrom] => int
REST (POST parameters)
competencyidfrom= int
The competency id we are moving to
General structure
int //The competency id we are moving to
XML-RPC (PHP structure)
[competencyidto] => int
REST (POST parameters)
competencyidto= int
Response
True if successful.
General structure
int //True if successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_request_review_of_user_evidence_linked_competencies
Send user evidence competencies in review
Arguments
id (Required)
The user evidence ID.
General structure
int //The user evidence ID.
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if all competencies were send to review
General structure
int //True if all competencies were send to review
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_search_competencies
Search a list of a competencies.
Arguments
searchtext (Required)
Text to search for
General structure
string //Text to search for
XML-RPC (PHP structure)
[searchtext] => string
REST (POST parameters)
searchtext= string
Competency framework id
General structure
int //Competency framework id
XML-RPC (PHP structure)
[competencyframeworkid] => int
REST (POST parameters)
competencyframeworkid= int
Response
General structure
list of (
object {
shortname string //shortname
idnumber string //idnumber
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int //sortorder
parentid int //parentid
path string //path
ruleoutcome int //ruleoutcome
ruletype string //ruletype
ruleconfig string //ruleconfig
scaleid int //scaleid
scaleconfiguration string //scaleconfiguration
competencyframeworkid int //competencyframeworkid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="sortorder"> <VALUE>int</VALUE> </KEY> <KEY name="parentid"> <VALUE>int</VALUE> </KEY> <KEY name="path"> <VALUE>string</VALUE> </KEY> <KEY name="ruleoutcome"> <VALUE>int</VALUE> </KEY> <KEY name="ruletype"> <VALUE>string</VALUE> </KEY> <KEY name="ruleconfig"> <VALUE>string</VALUE> </KEY> <KEY name="scaleid"> <VALUE>int</VALUE> </KEY> <KEY name="scaleconfiguration"> <VALUE>string</VALUE> </KEY> <KEY name="competencyframeworkid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_set_course_competency_ruleoutcome
Modify the ruleoutcome value for course competency
Arguments
coursecompetencyid (Required)
Data base record id for the course competency
General structure
int //Data base record id for the course competency
XML-RPC (PHP structure)
[coursecompetencyid] => int
REST (POST parameters)
coursecompetencyid= int
Ruleoutcome value
General structure
int //Ruleoutcome value
XML-RPC (PHP structure)
[ruleoutcome] => int
REST (POST parameters)
ruleoutcome= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_set_parent_competency
Set a new parent for a competency.
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The new competency parent id
General structure
int //The new competency parent id
XML-RPC (PHP structure)
[parentid] => int
REST (POST parameters)
parentid= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_template_has_related_data
Check if a template has related data
Arguments
id (Required)
The template id
General structure
int //The template id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the template has related data
General structure
int //True if the template has related data
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_template_viewed
Log event template viewed
Arguments
id (Required)
Data base record id for the template
General structure
int //Data base record id for the template
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
True if the log of the view was successful
General structure
int //True if the log of the view was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_unapprove_plan
Unapprove a plan.
Arguments
id (Required)
The plan ID
General structure
int //The plan ID
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_unlink_plan_from_template
Unlink a plan form it template.
Arguments
planid (Required)
Data base record id for the plan
General structure
int //Data base record id for the plan
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Response
True if the unlink was successful
General structure
int //True if the unlink was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_update_competency
Update a competency.
Arguments
competency (Required)
General structure
object {
shortname string Optional //shortname
idnumber string Optional //idnumber
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
sortorder int Optional //sortorder
parentid int Optional //parentid
path string Optional //path
ruleoutcome int Optional //ruleoutcome
ruletype string Optional //ruletype
ruleconfig string Optional //ruleconfig
scaleid int Optional //scaleid
scaleconfiguration string Optional //scaleconfiguration
competencyframeworkid int Optional //competencyframeworkid
id int //id
timecreated int Optional //timecreated
timemodified int Optional //timemodified
usermodified int Optional //usermodified
}
XML-RPC (PHP structure)
[competency] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [sortorder] => int [parentid] => int [path] => string [ruleoutcome] => int [ruletype] => string [ruleconfig] => string [scaleid] => int [scaleconfiguration] => string [competencyframeworkid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
competency[shortname]= string competency[idnumber]= string competency[description]= string competency[descriptionformat]= int competency[sortorder]= int competency[parentid]= int competency[path]= string competency[ruleoutcome]= int competency[ruletype]= string competency[ruleconfig]= string competency[scaleid]= int competency[scaleconfiguration]= string competency[competencyframeworkid]= int competency[id]= int competency[timecreated]= int competency[timemodified]= int competency[usermodified]= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_update_competency_framework
Update a competency framework.
Arguments
competencyframework (Required)
General structure
object {
shortname string Optional //shortname
idnumber string Optional //idnumber
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
visible int Optional //visible
scaleid int Optional //scaleid
scaleconfiguration string Optional //scaleconfiguration
contextid int Optional //The context id
contextlevel string Optional //The context level
instanceid int Optional //The Instance id
taxonomies string Optional //taxonomies
id int //id
timecreated int Optional //timecreated
timemodified int Optional //timemodified
usermodified int Optional //usermodified
}
XML-RPC (PHP structure)
[competencyframework] => Array ( [shortname] => string [idnumber] => string [description] => string [descriptionformat] => int [visible] => int [scaleid] => int [scaleconfiguration] => string [contextid] => int [contextlevel] => string [instanceid] => int [taxonomies] => string [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
competencyframework[shortname]= string competencyframework[idnumber]= string competencyframework[description]= string competencyframework[descriptionformat]= int competencyframework[visible]= int competencyframework[scaleid]= int competencyframework[scaleconfiguration]= string competencyframework[contextid]= int competencyframework[contextlevel]= string competencyframework[instanceid]= int competencyframework[taxonomies]= string competencyframework[id]= int competencyframework[timecreated]= int competencyframework[timemodified]= int competencyframework[usermodified]= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_update_course_competency_settings
Update the course competency settings
Arguments
courseid (Required)
Course id for the course to update
General structure
int //Course id for the course to update
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
General structure
object {
pushratingstouserplans int //New value of the setting
}
XML-RPC (PHP structure)
[settings] => Array ( [pushratingstouserplans] => int )
REST (POST parameters)
settings[pushratingstouserplans]= int
Response
True if the update was successful.
General structure
int //True if the update was successful.
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_update_plan
Updates a learning plan.
Arguments
plan (Required)
General structure
object {
name string Optional //name
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int Optional //userid
templateid int Optional //templateid
origtemplateid int Optional //origtemplateid
status int Optional //status
duedate int Optional //duedate
reviewerid int Optional //reviewerid
id int //id
timecreated int Optional //timecreated
timemodified int Optional //timemodified
usermodified int Optional //usermodified
}
XML-RPC (PHP structure)
[plan] => Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
plan[name]= string plan[description]= string plan[descriptionformat]= int plan[userid]= int plan[templateid]= int plan[origtemplateid]= int plan[status]= int plan[duedate]= int plan[reviewerid]= int plan[id]= int plan[timecreated]= int plan[timemodified]= int plan[usermodified]= int
Response
General structure
object {
name string //name
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
userid int //userid
templateid int //templateid
origtemplateid int //origtemplateid
status int //status
duedate int //duedate
reviewerid int //reviewerid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
statusname string //statusname
isbasedontemplate int //isbasedontemplate
canmanage int //canmanage
canrequestreview int //canrequestreview
canreview int //canreview
canbeedited int //canbeedited
isactive int //isactive
isdraft int //isdraft
iscompleted int //iscompleted
isinreview int //isinreview
iswaitingforreview int //iswaitingforreview
isreopenallowed int //isreopenallowed
iscompleteallowed int //iscompleteallowed
isunlinkallowed int //isunlinkallowed
isrequestreviewallowed int //isrequestreviewallowed
iscancelreviewrequestallowed int //iscancelreviewrequestallowed
isstartreviewallowed int //isstartreviewallowed
isstopreviewallowed int //isstopreviewallowed
isapproveallowed int //isapproveallowed
isunapproveallowed int //isunapproveallowed
duedateformatted string //duedateformatted
commentarea object {
component string //component
commentarea string //commentarea
itemid int //itemid
courseid int //courseid
contextid int //contextid
cid string //cid
autostart int //autostart
canpost int //canpost
canview int //canview
count int //count
collapsediconkey string //collapsediconkey
displaytotalcount int //displaytotalcount
displaycancel int //displaycancel
fullwidth int //fullwidth
linktext string //linktext
notoggle int //notoggle
template string //template
canpostorhascomments int //canpostorhascomments
}
reviewer object {
id int //id
email string //email
idnumber string //idnumber
phone1 string //phone1
phone2 string //phone2
department string //department
institution string //institution
fullname string //fullname
identity string //identity
profileurl string //profileurl
profileimageurl string //profileimageurl
profileimageurlsmall string //profileimageurlsmall
}
template object {
shortname string //shortname
description string //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int //duedate
visible int //visible
contextid int //contextid
id int //id
timecreated int //timecreated
timemodified int //timemodified
usermodified int //usermodified
duedateformatted string //duedateformatted
cohortscount int //cohortscount
planscount int //planscount
canmanage int //canmanage
canread int //canread
contextname string //contextname
contextnamenoprefix string //contextnamenoprefix
}
url string //url
}
XML-RPC (PHP structure)
Array ( [name] => string [description] => string [descriptionformat] => int [userid] => int [templateid] => int [origtemplateid] => int [status] => int [duedate] => int [reviewerid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [statusname] => string [isbasedontemplate] => int [canmanage] => int [canrequestreview] => int [canreview] => int [canbeedited] => int [isactive] => int [isdraft] => int [iscompleted] => int [isinreview] => int [iswaitingforreview] => int [isreopenallowed] => int [iscompleteallowed] => int [isunlinkallowed] => int [isrequestreviewallowed] => int [iscancelreviewrequestallowed] => int [isstartreviewallowed] => int [isstopreviewallowed] => int [isapproveallowed] => int [isunapproveallowed] => int [duedateformatted] => string [commentarea] => Array ( [component] => string [commentarea] => string [itemid] => int [courseid] => int [contextid] => int [cid] => string [autostart] => int [canpost] => int [canview] => int [count] => int [collapsediconkey] => string [displaytotalcount] => int [displaycancel] => int [fullwidth] => int [linktext] => string [notoggle] => int [template] => string [canpostorhascomments] => int ) [reviewer] => Array ( [id] => int [email] => string [idnumber] => string [phone1] => string [phone2] => string [department] => string [institution] => string [fullname] => string [identity] => string [profileurl] => string [profileimageurl] => string [profileimageurlsmall] => string ) [template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int [duedateformatted] => string [cohortscount] => int [planscount] => int [canmanage] => int [canread] => int [contextname] => string [contextnamenoprefix] => string ) [url] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="templateid"> <VALUE>int</VALUE> </KEY> <KEY name="origtemplateid"> <VALUE>int</VALUE> </KEY> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="reviewerid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="statusname"> <VALUE>string</VALUE> </KEY> <KEY name="isbasedontemplate"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canrequestreview"> <VALUE>int</VALUE> </KEY> <KEY name="canreview"> <VALUE>int</VALUE> </KEY> <KEY name="canbeedited"> <VALUE>int</VALUE> </KEY> <KEY name="isactive"> <VALUE>int</VALUE> </KEY> <KEY name="isdraft"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleted"> <VALUE>int</VALUE> </KEY> <KEY name="isinreview"> <VALUE>int</VALUE> </KEY> <KEY name="iswaitingforreview"> <VALUE>int</VALUE> </KEY> <KEY name="isreopenallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscompleteallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunlinkallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isrequestreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="iscancelreviewrequestallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstartreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isstopreviewallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="isunapproveallowed"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <SINGLE> <KEY name="component"> <VALUE>string</VALUE> </KEY> <KEY name="commentarea"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="courseid"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="cid"> <VALUE>string</VALUE> </KEY> <KEY name="autostart"> <VALUE>int</VALUE> </KEY> <KEY name="canpost"> <VALUE>int</VALUE> </KEY> <KEY name="canview"> <VALUE>int</VALUE> </KEY> <KEY name="count"> <VALUE>int</VALUE> </KEY> <KEY name="collapsediconkey"> <VALUE>string</VALUE> </KEY> <KEY name="displaytotalcount"> <VALUE>int</VALUE> </KEY> <KEY name="displaycancel"> <VALUE>int</VALUE> </KEY> <KEY name="fullwidth"> <VALUE>int</VALUE> </KEY> <KEY name="linktext"> <VALUE>string</VALUE> </KEY> <KEY name="notoggle"> <VALUE>int</VALUE> </KEY> <KEY name="template"> <VALUE>string</VALUE> </KEY> <KEY name="canpostorhascomments"> <VALUE>int</VALUE> </KEY> </SINGLE> </KEY> <KEY name="reviewer"> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="email"> <VALUE>string</VALUE> </KEY> <KEY name="idnumber"> <VALUE>string</VALUE> </KEY> <KEY name="phone1"> <VALUE>string</VALUE> </KEY> <KEY name="phone2"> <VALUE>string</VALUE> </KEY> <KEY name="department"> <VALUE>string</VALUE> </KEY> <KEY name="institution"> <VALUE>string</VALUE> </KEY> <KEY name="fullname"> <VALUE>string</VALUE> </KEY> <KEY name="identity"> <VALUE>string</VALUE> </KEY> <KEY name="profileurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurl"> <VALUE>string</VALUE> </KEY> <KEY name="profileimageurlsmall"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="template"> <SINGLE> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> <KEY name="description"> <VALUE>string</VALUE> </KEY> <KEY name="descriptionformat"> <VALUE>int</VALUE> </KEY> <KEY name="duedate"> <VALUE>int</VALUE> </KEY> <KEY name="visible"> <VALUE>int</VALUE> </KEY> <KEY name="contextid"> <VALUE>int</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="timecreated"> <VALUE>int</VALUE> </KEY> <KEY name="timemodified"> <VALUE>int</VALUE> </KEY> <KEY name="usermodified"> <VALUE>int</VALUE> </KEY> <KEY name="duedateformatted"> <VALUE>string</VALUE> </KEY> <KEY name="cohortscount"> <VALUE>int</VALUE> </KEY> <KEY name="planscount"> <VALUE>int</VALUE> </KEY> <KEY name="canmanage"> <VALUE>int</VALUE> </KEY> <KEY name="canread"> <VALUE>int</VALUE> </KEY> <KEY name="contextname"> <VALUE>string</VALUE> </KEY> <KEY name="contextnamenoprefix"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> <KEY name="url"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_update_template
Update a learning plan template.
Arguments
template (Required)
General structure
object {
shortname string Optional //shortname
description string Optional //description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
duedate int Optional //duedate
visible int Optional //visible
contextid int Optional //The context id
contextlevel string Optional //The context level
instanceid int Optional //The Instance id
id int //id
timecreated int Optional //timecreated
timemodified int Optional //timemodified
usermodified int Optional //usermodified
}
XML-RPC (PHP structure)
[template] => Array ( [shortname] => string [description] => string [descriptionformat] => int [duedate] => int [visible] => int [contextid] => int [contextlevel] => string [instanceid] => int [id] => int [timecreated] => int [timemodified] => int [usermodified] => int )
REST (POST parameters)
template[shortname]= string template[description]= string template[descriptionformat]= int template[duedate]= int template[visible]= int template[contextid]= int template[contextlevel]= string template[instanceid]= int template[id]= int template[timecreated]= int template[timemodified]= int template[usermodified]= int
Response
True if the update was successful
General structure
int //True if the update was successful
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_cancel_review_request
Cancel a review request.
Arguments
userid (Required)
The user ID
General structure
int //The user ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The competency ID
General structure
int //The competency ID
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_plan_viewed
Log the user competency plan viewed event.
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The user id
General structure
int //The user id
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Response
True if the event user competency plan viewed was logged
General structure
int //True if the event user competency plan viewed was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_request_review
Request a review.
Arguments
userid (Required)
The user ID
General structure
int //The user ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The competency ID
General structure
int //The competency ID
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_start_review
Start a review.
Arguments
userid (Required)
The user ID
General structure
int //The user ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The competency ID
General structure
int //The competency ID
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_stop_review
Stop a review.
Arguments
userid (Required)
The user ID
General structure
int //The user ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The competency ID
General structure
int //The competency ID
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
Response
The success
General structure
int //The success
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_viewed
Log the user competency viewed event.
Arguments
usercompetencyid (Required)
The user competency id
General structure
int //The user competency id
XML-RPC (PHP structure)
[usercompetencyid] => int
REST (POST parameters)
usercompetencyid= int
Response
True if the event user competency viewed was logged
General structure
int //True if the event user competency viewed was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_viewed_in_course
Log the user competency viewed in course event
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The user id
General structure
int //The user id
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The course id
General structure
int //The course id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Response
True if the event user competency viewed in course was logged
General structure
int //True if the event user competency viewed in course was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_competency_user_competency_viewed_in_plan
Log the user competency viewed in plan event.
Arguments
competencyid (Required)
The competency id
General structure
int //The competency id
XML-RPC (PHP structure)
[competencyid] => int
REST (POST parameters)
competencyid= int
The user id
General structure
int //The user id
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
The plan id
General structure
int //The plan id
XML-RPC (PHP structure)
[planid] => int
REST (POST parameters)
planid= int
Response
True if the event user competency viewed in plan was logged
General structure
int //True if the event user competency viewed in plan was logged
XML-RPC (PHP structure)
int
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>int</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_completion_get_activities_completion_status
Return the activities completion status for a user in a course.
Arguments
courseid (Required)
Course ID
General structure
int //Course ID
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
User ID
General structure
int //User ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Response
General structure
object {
statuses //List of activities status
list of (
//Activity
object {
cmid int //comment ID
modname string //activity module name
instance int //instance ID
state int //completion state value: 0 means incomplete, 1 complete, 2 complete pass, 3 complete fail
timecompleted int //timestamp for completed activity
tracking int //type of tracking: 0 means none, 1 manual, 2 automatic
overrideby int Optional //The user id who has overriden the status, or null
}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [statuses] => Array ( [0] => Array ( [cmid] => int [modname] => string [instance] => int [state] => int [timecompleted] => int [tracking] => int [overrideby] => int ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="statuses"> <MULTIPLE> <SINGLE> <KEY name="cmid"> <VALUE>int</VALUE> </KEY> <KEY name="modname"> <VALUE>string</VALUE> </KEY> <KEY name="instance"> <VALUE>int</VALUE> </KEY> <KEY name="state"> <VALUE>int</VALUE> </KEY> <KEY name="timecompleted"> <VALUE>int</VALUE> </KEY> <KEY name="tracking"> <VALUE>int</VALUE> </KEY> <KEY name="overrideby"> <VALUE>int</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_completion_get_course_completion_status
Returns course completion status.
Arguments
courseid (Required)
Course ID
General structure
int //Course ID
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
User ID
General structure
int //User ID
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
Response
Course completion status
General structure
//Course completion status
object {
completionstatus //Course status
object {
completed int //true if the course is complete, false otherwise
aggregation int //aggregation method 1 means all, 2 means any
completions list of (
//Completions
object {
type int //Completion criteria type
title string //Completion criteria Title
status string //Completion status (Yes/No) a % or number
complete int //Completion status (true/false)
timecompleted int //Timestamp for criteria completetion
details //details
object {
type string //Type description
criteria string //Criteria description
requirement string //Requirement description
status string //Status description, can be anything
}
}
)}
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [completionstatus] => Array ( [completed] => int [aggregation] => int [completions] => Array ( [0] => Array ( [type] => int [title] => string [status] => string [complete] => int [timecompleted] => int [details] => Array ( [type] => string [criteria] => string [requirement] => string [status] => string ) ) ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="completionstatus"> <SINGLE> <KEY name="completed"> <VALUE>int</VALUE> </KEY> <KEY name="aggregation"> <VALUE>int</VALUE> </KEY> <KEY name="completions"> <MULTIPLE> <SINGLE> <KEY name="type"> <VALUE>int</VALUE> </KEY> <KEY name="title"> <VALUE>string</VALUE> </KEY> <KEY name="status"> <VALUE>string</VALUE> </KEY> <KEY name="complete"> <VALUE>int</VALUE> </KEY> <KEY name="timecompleted"> <VALUE>int</VALUE> </KEY> <KEY name="details"> <SINGLE> <KEY name="type"> <VALUE>string</VALUE> </KEY> <KEY name="criteria"> <VALUE>string</VALUE> </KEY> <KEY name="requirement"> <VALUE>string</VALUE> </KEY> <KEY name="status"> <VALUE>string</VALUE> </KEY> </SINGLE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_completion_mark_course_self_completed
Update the course completion status for the current user (if course self-completion is enabled).
Arguments
courseid (Required)
Course ID
General structure
int //Course ID
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Response
General structure
object {
status int //status, true if success
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [status] => int [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_completion_override_activity_completion_status
Update completion status for a user in an activity by overriding it.
Arguments
userid (Required)
user id
General structure
int //user id
XML-RPC (PHP structure)
[userid] => int
REST (POST parameters)
userid= int
course module id
General structure
int //course module id
XML-RPC (PHP structure)
[cmid] => int
REST (POST parameters)
cmid= int
the new activity completion state
General structure
int //the new activity completion state
XML-RPC (PHP structure)
[newstate] => int
REST (POST parameters)
newstate= int
Response
General structure
object {
cmid int //The course module id
userid int //The user id to which the completion info belongs
state int //The current completion state.
timecompleted int //time of completion
overrideby int //The user id who has overriden the status, or null
tracking int //type of tracking: 0 means none, 1 manual, 2 automatic
}
XML-RPC (PHP structure)
Array ( [cmid] => int [userid] => int [state] => int [timecompleted] => int [overrideby] => int [tracking] => int )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="cmid"> <VALUE>int</VALUE> </KEY> <KEY name="userid"> <VALUE>int</VALUE> </KEY> <KEY name="state"> <VALUE>int</VALUE> </KEY> <KEY name="timecompleted"> <VALUE>int</VALUE> </KEY> <KEY name="overrideby"> <VALUE>int</VALUE> </KEY> <KEY name="tracking"> <VALUE>int</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_completion_update_activity_completion_status_manually
Update completion status for the current user in an activity, only for activities with manual tracking.
Arguments
cmid (Required)
course module id
General structure
int //course module id
XML-RPC (PHP structure)
[cmid] => int
REST (POST parameters)
cmid= int
activity completed or not
General structure
int //activity completed or not
XML-RPC (PHP structure)
[completed] => int
REST (POST parameters)
completed= int
Response
General structure
object {
status int //status, true if success
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [status] => int [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="status"> <VALUE>int</VALUE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_check_updates
Check if there is updates affecting the user for the given course and contexts.
Arguments
courseid (Required)
Course id to check
General structure
int //Course id to check
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
Instances to check
General structure
//Instances to check
list of (
object {
contextlevel string //The context level for the file location. Only module supported right now.
id int //Context instance id
since int //Check updates since this time stamp
}
)
XML-RPC (PHP structure)
[tocheck] => Array ( [0] => Array ( [contextlevel] => string [id] => int [since] => int ) )
REST (POST parameters)
tocheck[0][contextlevel]= string tocheck[0][id]= int tocheck[0][since]= int
Check only for updates in these areas
General structure
Default to "Array ( ) " //Check only for updates in these areas
list of (
string //Area name: configuration, fileareas, completion, ratings, comments, gradeitems, outcomes
)
XML-RPC (PHP structure)
[filter] => Array ( [0] => string )
REST (POST parameters)
filter[0]= string
Response
General structure
object {
instances list of (
object {
contextlevel string //The context level
id int //Instance id
updates list of (
object {
name string //Name of the area updated.
timeupdated int Optional //Last time was updated
itemids Optional //The ids of the items updated
list of (
int //Instance id
)}
)}
)warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [instances] => Array ( [0] => Array ( [contextlevel] => string [id] => int [updates] => Array ( [0] => Array ( [name] => string [timeupdated] => int [itemids] => Array ( [0] => int ) ) ) ) ) [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="instances"> <MULTIPLE> <SINGLE> <KEY name="contextlevel"> <VALUE>string</VALUE> </KEY> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="updates"> <MULTIPLE> <SINGLE> <KEY name="name"> <VALUE>string</VALUE> </KEY> <KEY name="timeupdated"> <VALUE>int</VALUE> </KEY> <KEY name="itemids"> <MULTIPLE> <VALUE>int</VALUE> </MULTIPLE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </MULTIPLE> </KEY> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_course_create_categories
Create course categories
Arguments
categories (Required)
General structure
list of (
object {
name string //new category name
parent int Default to "0" //the parent category id inside which the new category will be created - set to 0 for a root category
idnumber string Optional //the new category idnumber
description string Optional //the new category description
descriptionformat int Default to "1" //description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
theme string Optional //the new category theme. This option must be enabled on moodle
}
)
XML-RPC (PHP structure)
[categories] => Array ( [0] => Array ( [name] => string [parent] => int [idnumber] => string [description] => string [descriptionformat] => int [theme] => string ) )
REST (POST parameters)
categories[0][name]= string categories[0][parent]= int categories[0][idnumber]= string categories[0][description]= string categories[0][descriptionformat]= int categories[0][theme]= string
Response
General structure
list of (
object {
id int //new category id
name string //new category name
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [id] => int [name] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="name"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_create_courses
Create new courses
Arguments
courses (Required)
courses to create
General structure
//courses to create
list of (
object {
fullname string //full name
shortname string //course short name
categoryid int //category id
idnumber string Optional //id number
summary string Optional //summary
summaryformat int Default to "1" //summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
format string Default to "weeks" //course format: weeks, topics, social, site,..
showgrades int Default to "1" //1 if grades are shown, otherwise 0
newsitems int Default to "5" //number of recent items appearing on the course page
startdate int Optional //timestamp when the course start
enddate int Optional //timestamp when the course end
numsections int Optional //(deprecated, use courseformatoptions) number of weeks/topics
maxbytes int Default to "0" //largest size of file that can be uploaded into the course
showreports int Default to "0" //are activity report shown (yes = 1, no =0)
visible int Optional //1: available to student, 0:not available
hiddensections int Optional //(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students
groupmode int Default to "0" //no group, separate, visible
groupmodeforce int Default to "0" //1: yes, 0: no
defaultgroupingid int Default to "0" //default grouping id
enablecompletion int Optional //Enabled, control via completion and activity settings. Disabled, not shown in activity settings.
completionnotify int Optional //1: yes 0: no
lang string Optional //forced course language
forcetheme string Optional //name of the force theme
courseformatoptions Optional //additional options for particular course format
list of (
object {
name string //course format option name
value string //course format option value
}
)}
)
XML-RPC (PHP structure)
[courses] => Array ( [0] => Array ( [fullname] => string [shortname] => string [categoryid] => int [idnumber] => string [summary] => string [summaryformat] => int [format] => string [showgrades] => int [newsitems] => int [startdate] => int [enddate] => int [numsections] => int [maxbytes] => int [showreports] => int [visible] => int [hiddensections] => int [groupmode] => int [groupmodeforce] => int [defaultgroupingid] => int [enablecompletion] => int [completionnotify] => int [lang] => string [forcetheme] => string [courseformatoptions] => Array ( [0] => Array ( [name] => string [value] => string ) ) ) )
REST (POST parameters)
courses[0][fullname]= string courses[0][shortname]= string courses[0][categoryid]= int courses[0][idnumber]= string courses[0][summary]= string courses[0][summaryformat]= int courses[0][format]= string courses[0][showgrades]= int courses[0][newsitems]= int courses[0][startdate]= int courses[0][enddate]= int courses[0][numsections]= int courses[0][maxbytes]= int courses[0][showreports]= int courses[0][visible]= int courses[0][hiddensections]= int courses[0][groupmode]= int courses[0][groupmodeforce]= int courses[0][defaultgroupingid]= int courses[0][enablecompletion]= int courses[0][completionnotify]= int courses[0][lang]= string courses[0][forcetheme]= string courses[0][courseformatoptions][0][name]= string courses[0][courseformatoptions][0][value]= string
Response
General structure
list of (
object {
id int //course id
shortname string //short name
}
)
XML-RPC (PHP structure)
Array ( [0] => Array ( [id] => int [shortname] => string ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <MULTIPLE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_delete_categories
Delete course categories
Arguments
categories (Required)
General structure
list of (
object {
id int //category id to delete
newparent int Optional //the parent category to move the contents to, if specified
recursive int Default to "0" //1: recursively delete all contents inside this category, 0 (default): move contents to newparent or current parent category (except if parent is root)
}
)
XML-RPC (PHP structure)
[categories] => Array ( [0] => Array ( [id] => int [newparent] => int [recursive] => int ) )
REST (POST parameters)
categories[0][id]= int categories[0][newparent]= int categories[0][recursive]= int
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_delete_courses
Deletes all specified courses
Arguments
courseids (Required)
General structure
list of (
int //course ID
)
XML-RPC (PHP structure)
[courseids] => Array ( [0] => int )
REST (POST parameters)
courseids[0]= int
Response
General structure
object {
warnings Optional //list of warnings
list of (
//warning
object {
item string Optional //item
itemid int Optional //item id
warningcode string //the warning code can be used by the client app to implement specific behaviour
message string //untranslated english message to explain the warning
}
)}
XML-RPC (PHP structure)
Array ( [warnings] => Array ( [0] => Array ( [item] => string [itemid] => int [warningcode] => string [message] => string ) ) )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="warnings"> <MULTIPLE> <SINGLE> <KEY name="item"> <VALUE>string</VALUE> </KEY> <KEY name="itemid"> <VALUE>int</VALUE> </KEY> <KEY name="warningcode"> <VALUE>string</VALUE> </KEY> <KEY name="message"> <VALUE>string</VALUE> </KEY> </SINGLE> </MULTIPLE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_delete_modules
Deletes all specified module instances
Arguments
cmids (Required)
Array of course module IDs
General structure
//Array of course module IDs
list of (
int //course module ID
)
XML-RPC (PHP structure)
[cmids] => Array ( [0] => int )
REST (POST parameters)
cmids[0]= int
Response
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_duplicate_course
Duplicate an existing course (creating a new one).
Arguments
courseid (Required)
course to duplicate id
General structure
int //course to duplicate id
XML-RPC (PHP structure)
[courseid] => int
REST (POST parameters)
courseid= int
duplicated course full name
General structure
string //duplicated course full name
XML-RPC (PHP structure)
[fullname] => string
REST (POST parameters)
fullname= string
duplicated course short name
General structure
string //duplicated course short name
XML-RPC (PHP structure)
[shortname] => string
REST (POST parameters)
shortname= string
duplicated course category parent
General structure
int //duplicated course category parent
XML-RPC (PHP structure)
[categoryid] => int
REST (POST parameters)
categoryid= int
duplicated course visible, default to yes
General structure
int Default to "1" //duplicated course visible, default to yes
XML-RPC (PHP structure)
[visible] => int
REST (POST parameters)
visible= int
0
General structure
list of (
object {
name string //The backup option name: "activities" (int) Include course activites (default to 1 that is equal to yes), "blocks" (int) Include course blocks (default to 1 that is equal to yes), "filters" (int) Include course filters (default to 1 that is equal to yes), "users" (int) Include users (default to 0 that is equal to no), "enrolments" (int) Include enrolment methods (default to 1 - restore only with users), "role_assignments" (int) Include role assignments (default to 0 that is equal to no), "comments" (int) Include user comments (default to 0 that is equal to no), "userscompletion" (int) Include user course completion information (default to 0 that is equal to no), "logs" (int) Include course logs (default to 0 that is equal to no), "grade_histories" (int) Include histories (default to 0 that is equal to no)
value string //the value for the option 1 (yes) or 0 (no)
}
)
XML-RPC (PHP structure)
[options] => Array ( [0] => Array ( [name] => string [value] => string ) )
REST (POST parameters)
options[0][name]= string options[0][value]= string
Response
General structure
object {
id int //course id
shortname string //short name
}
XML-RPC (PHP structure)
Array ( [id] => int [shortname] => string )
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <SINGLE> <KEY name="id"> <VALUE>int</VALUE> </KEY> <KEY name="shortname"> <VALUE>string</VALUE> </KEY> </SINGLE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
No
core_course_edit_module
Performs an action on course module (change visibility, duplicate, delete, etc.)
Arguments
action (Required)
action: hide, show, stealth, duplicate, delete, moveleft, moveright, group...
General structure
string //action: hide, show, stealth, duplicate, delete, moveleft, moveright, group...
XML-RPC (PHP structure)
[action] => string
REST (POST parameters)
action= string
course module id
General structure
int //course module id
XML-RPC (PHP structure)
[id] => int
REST (POST parameters)
id= int
section to return to
General structure
int Default to "null" //section to return to
XML-RPC (PHP structure)
[sectionreturn] => int
REST (POST parameters)
sectionreturn= int
Response
html to replace the current module with
General structure
string //html to replace the current module with
XML-RPC (PHP structure)
string
REST
<?xml version="1.0" encoding="UTF-8" ?> <RESPONSE> <VALUE>string</VALUE> </RESPONSE>
Error message
REST
<?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception"> <MESSAGE>Invalid parameter value detected</MESSAGE> <DEBUGINFO></DEBUGINFO> </EXCEPTION>
Restricted to logged-in users
Yes
Callable from AJAX
Yes
core_course_edit_section
Performs an action on course section (change visibility, set marker, delete)
Arguments
action (Required)
action: hide, show, stealth, setmarker, removemarker
General structure
string //action: hide, show, stealth, setmarker, removemarker