Web services

General structure

object {
users list of ( 
object {
id int   //ID of the user
username string  Optional //The username
firstname string  Optional //The first name(s) of the user
lastname string  Optional //The family name of the user
fullname string   //The fullname of the user
email string  Optional //An email address - allow email as root@localhost
address string  Optional //Postal address
phone1 string  Optional //Phone 1
phone2 string  Optional //Phone 2
icq string  Optional //icq number
skype string  Optional //skype id
yahoo string  Optional //yahoo id
aim string  Optional //aim id
msn string  Optional //msn number
department string  Optional //department
institution string  Optional //institution
idnumber string  Optional //An arbitrary ID code number perhaps from the institution
interests string  Optional //user interests (separated by commas)
firstaccess int  Optional //first access to the site (0 if never)
lastaccess int  Optional //last access to the site (0 if never)
auth string  Optional //Auth plugins include manual, ldap, etc
suspended int  Optional //Suspend user account, either false to enable user login or true to disable it
confirmed int  Optional //Active user: 1 if confirmed, 0 otherwise
lang string  Optional //Language code such as "en", must exist on server
calendartype string  Optional //Calendar type such as "gregorian", must exist on server
theme string  Optional //Theme name such as "standard", must exist on server
timezone string  Optional //Timezone code such as Australia/Perth, or 99 for default
mailformat int  Optional //Mail format code is 0 for plain text, 1 for HTML etc
description string  Optional //User profile description
descriptionformat int  Optional //int format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
city string  Optional //Home city of the user
url string  Optional //URL of the user
country string  Optional //Home country code of the user, such as AU or CZ
profileimageurlsmall string   //User image profile URL - small version
profileimageurl string   //User image profile URL - big version
customfields  Optional //User custom fields (also known as user profile fields)
list of ( 
object {
type string   //The type of the custom field - text field, checkbox...
value string   //The value of the custom field
name string   //The name of the custom field
shortname string   //The shortname of the custom field - to be able to build the field class in the code
} 
)preferences  Optional //Users preferences
list of ( 
object {
name string   //The name of the preferences
value string   //The value of the preference
} 
)} 
)warnings  Optional //list of warnings
list of ( 
  //warning
object {
item string  Optional //always set to 'key'
itemid int  Optional //faulty key name
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
} 
)}