Setting Up Your API

Setting Up Your API

We advise the use of a developer to help you setup your API connection. We will offer an example of how to CREATE NEW USER on your LMS (core_user_create_users)

Let's review only the required REST (POST parameters):

  1. wsfunction=core_user_create_users
  2. users[0][username]= string (String required to set username of profile)
  3. users[0][auth]= string (String default to "manual")
  4. users[0][password]= string (String required to set user password)
  5. users[0][firstname]= string (String required to define user first name)
  6. users[0][lastname]= string (String required to define user last name)
  7. users[0][email]= string (String required to define user email address)

Sample URL: 

https://courses.yoursite.com/webservice/rest/server.php?wstoken=XXXXXXXXXXXXXXX 

&wsfunction=core_user_create_users

&users[0][createpassword]=0

&users[0][username]=johndoe

&users[0][auth]=manual

&users[0][password]=YourPassword00

&users[0][firstname]=John

&users[0][lastname]=Doe

&users[0][email]=johndoe@yourdomain.com

Bringing this altogether:

https://courses.yoursite.com/webservice/rest/server.php?wstoken=XXXXXXXXXXXXXXX&wsfunction=core_user_create_users&users[0][createpassword]=0&users[0][username]=johndoe&users[0][auth]=manual&users[0][password]=YourPassword00&users[0][firstname]=John&users[0][lastname]=Doe&users[0][email]=johndoe@yourdomain.com

    • Related Articles

    • User Segments API

      Cohort = User Segment core_cohort_add_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 ...

    • Generate your API Key

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

    • User API

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

    • Enrollment API

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

    • Messaging API

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