• Home
• ››Frequently Asked Questions

How to Use REST API to Add and Track Users in a Classroom

 

ProProfs Training Maker allows you to use REST API to register, authenticate, and track learners for your courses and quizzes. This API application enables the utilization of three distinct processes:

1. Register New Users in a Classroom

• NEW VERSION
• OLD VERSION

2. Track User Progress For Each Assignment
3. Classroom User Authentication

 

Register New Users In a Classroom

Add new users to your classroom using their Email or ID with the help of this API method.

 

 NEW VERSION

 

Endpoint URL

POST- https://api.proprofs.com/classroom/v3/create/register

 

Note: Endpoint URL is Case-sensitive and without forward-slash ( / ) at the end.

 

Request Method

POST

 

Request Format

JSON

 

Request Parameters

 

Name	Required	Type	Description
token	Yes	String	Your private API key for the FAQ. The API key is available at: Settings > In-App Help > API key
username	Yes	String	ProProfs username
email	Yes (Either Email or ID is required)	String	User's unique Email
id	Yes (Either Email or ID is required	String	User's unique ID
fname	No	String	First name of the user
lname	No	String	Last name of the user
password	No	String	Password for the user to log in under a classroom. If missing, an auto-generated password will be assigned.
phone	No	String	Phone No. of user
address	No	String	User's address
city	No	String	City
state	No	String	State
country	No	String	Country
zip	No	String	Zip
status	No	String	Status ("active" / "inactive" / "delete")
expire	No	String	Date when the user's access will expire. The date format should be mm/dd/yyyy
assignments	No	Object	URL encoded link of the assignment.   Sample quiz assignment link: https://www.proprofs.com/quiz-school/ugc/story.php?title=customer-service-training-quiz-template-3334wt   URL encoded version: https%3A%2F%2Fwww.proprofs.com%2Fquiz-school%2Fugc%2Fstory.php%3Ftitle%3Dcustomer-service-training-quiz-template-3334wt   Sample course assignment link: https://www.proprofs.com/training/course/?title=business-training   URL encoded version: https%3A%2F%2Fwww.proprofs.com%2Ftraining%2Fcourse%2F%3Ftitle%3Dbusiness-training   Sample Learning Path Private Code: 162XX9XX
group	No	Object	You can include up to 5 groups while registering the user.

 

Sample Code | JSON

 

 

The request JSON object contains information about the user, group, subgroup, and the courses that are to be assigned. Since a JSON string is significant, we should divide it into different chunks for better understanding.

 

Request Parameters for user information

 

 

Request Parameters for the group information

 

 

 

Name	Required	Type	Description
group_name	No	String	The name of the group. The user will get assigned to the group if the group already exists. Otherwise, a new group will be created, and the user will assign it.
group_status	No (default: active)	Boolean	The value should be active or inactive. The group with inactive status will not allow classroom access to their members (users).
assignments	No	Object	The list of quizzes and course links that you want to assign to the group. The link should be URL encoded, and the total number of assignments shouldn't exceed more than 50. The assignment limit of 50 is applicable globally on the request. So, no matter whether we have consumed all 50 assignments to a group or divided them among multiple groups/subgroups/users.
is_group_admin	No (default: 0)	Boolean	The value should be 0 or 1. Status 1 will make this user a group administrator for the group.
can_add_new_user	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) will have permission to add a new user from the web portal and assign that user to the group.
can_assign_user_to_group	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) can see the list of users available in the classroom and assign them to the group.
can_assign_assignments	No (default: 0)	Boolean	The value should be 0 or 1. With status 1, the user (group administrator) can add assignments to the group.
can_grade_reports	No (default: 0)	Boolean	The value should be 0 or 1. With status 1, the user (group administrator) can grade reports.
can_remove_user_from_group	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) can remove members from the group.
can_delete_user	No (default: 0)	Boolean	The value should be 0 or 1. The user (group administrator) with status 1 will have permission to delete the user from the classroom. Note: Delete is permanent, and you'll not be able to get it back once deleted.
is_part_of	No (default: 0)	Boolean	The value should be 0 or 1. Status 1 will make this user a member of the group.
subgroup	No (default: 0)	Object	You can include up to 25 subgroups while registering the user. The subgroup limit of 25 is applicable globally on the request. So, no matter whether you have consumed all subgroups within a group or divided among the multiple groups.

 

Request Parameters for the subgroup information

 

 

Name	Required	Type	Description
subgroup_name	No (default: 0)	String	The name of the subgroup. If the subgroup exists, the user will be assigned to the subgroup. Otherwise, a new subgroup will be created, and then the user will get assigned to it.
subgroup_status	No (default: active)	String	The value should be active or inactive. The subgroup with inactive status will not allow classroom access to their members (users).
assignments	No	Object	The list of quizzes and course links that you want to assign to the subgroup. The link should be URL encoded, and the total number of assignments shouldn't exceed more than 50. The assignment limit of 50 is applicable globally on the request. So, no matter whether we have consumed all 50 assignments to a group or divided them among multiple groups/subgroups/users.
is_group_admin	No (default: 0)	Boolean	The value should be 0 or 1. Status 1 will make this user a group administrator for the subgroup.
can_add_new_user	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) will have permission to add a new user from the web portal and assign that user to the subgroup.
can_grade_reports	No (default: 0)	Boolean	The value should be 0 or 1. With status 1, the user (group administrator) can grade reports.
can_remove_user_from_group	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) can remove members from the subgroup.
can_delete_user	No (default: 0)	Boolean	The value should be 0 or 1. The user (group administrator) with status 1 will have permission to delete the user from the classroom. Note: Delete is permanent, and you'll not be able to get it back once deleted.
can_assign_user_to_group	No (default: 0)	Boolean	The value should be 0 or 1. If the status is set to 1, the user (group administrator) can see the list of users available in the classroom and assign them to the subgroup.
can_assign_assignments	No (default: 0)	Boolean	The value should be 0 or 1. With status 1, the user (group administrator) can add assignments to the subgroup.
is_part_of	No (default: 0)	Boolean	The value should be 0 or 1. Status 1 will make this user a member of the group.

 

Response Format

JSON

 

Example Response [Success]

 

 

Response Fields	Description
status	success when the user added or updated successfully.
uid	The unique reference ID of the user post-registration.
email	The user email who just added/updated.
id	The user ID who just added/updated.
action	created or updated based on the action performed.

 

Example Response [Failed]

 

 

Response Fields	Description
status	error when the operation failed.
description	The error text describes the error.

 

 OLD VERSION

 

Endpoint URL
https://www.proprofs.com/api/classroom/v1/user/register/

 

Request Method
POST

 

Request Format
JSON

 

URL Parameters

 

Example Request

POST https://www.proprofs.com/api/classroom/v1/user/register/
Accept: application/json
Content-Type: application/json
{  
    "token": "3f39bfe3d52efe4a975ce19eb1e9db4e",
    "username": "johnsmith",
    "email": "johnsmith@example.com",
    "id": 1024,
    "fname": "John",
                "lname": "Smith",
                "password": "rdsxc234edsx",
                "phone": "555-555-5555",
                "address": "100 MAIN ST",
                "city": "PHOENIX",
                "state": "AZ",
                "country": "USA",
                "zip": "85123",
                "status": "active",
                "expire": "12/31/2015",
                "group": ["sales","finance","marketing"],

                "group_status": ["active","active","inactive"],

                "sub_group": ["inbound","credit","digital"],

                "quiz_assignment: ["http%3A%2F%2Fwww.proprofs.com%2Fquiz-school%2Fstory.php%3Ftitle%3Dhalloween-quizz", "http%3A%2F%2Fwww.proprofs.com%2Fquiz-school%2Fstory.php%3Ftitle%3Dhalloween-quizz", "http%3A%2F%2Fwww.proprofs.com%2Fquiz-school%2Fstory.php%3Ftitle%3Dhalloween-quizz"]
      }

 

Response Format
JSON

 

Response on Success

 

Example Response
Content-Type: application/json
{  
    "status": "SUCCESS",
    "email": "johnsmith@example.com",
    "id": "1024"
    }

 

Responses on Error

 

Error Codes and Descriptions

 

Example Error Response

 

Content-Type: application/json
 {
                "status": "ERROR",
                "code": "ERR1001",
                "error": "API key is invalid"
}

Live example in PHP
This example will help you register the user in the classroom using ProProfs API.

    function sendRequest($json)  
    {  
        $curl_obj = curl_init();
        curl_setopt($curl_obj, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($curl_obj, CURLOPT_URL, "https://www.proprofs.com/api/classroom/v1/user/register/");
        curl_setopt($curl_obj, CURLOPT_POSTFIELDS, $json);  
        curl_setopt($curl_obj, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl_obj, CURLOPT_POST, 1);
        curl_setopt($curl_obj, CURLOPT_HEADER, 0);  
        return curl_exec($curl_obj);  
    }
   
      $request_array = array();
   
      $request_array["token"] = "Your API Key";
      $request_array["username"] = "Your ProProfs Username";
      $request_array["email"] = "john@proprofs.com";
      $request_array["id"] = "12345";
      $request_array["fname"] = "John";
      $request_array["lname"] = "Smith";
      $request_array["password"] = "john101";
      $request_array["phone"] = "555-555-5555";
      $request_array["address"] = "151 Street Suit";
      $request_array["city"] = "Santa Monica";
      $request_array["state"] = "CA";
      $request_array["country"] = "United States";
      $request_array["zip"] = "90401";
      $request_array["status"] = "active";

      $request_array["expire"] = "12/31/2015";

 

      // User will be member of three groups Marketing,  Sales and Support.
      $group_array = array("Marketing", "Sales", "Support");

      $request_array["group"] = $group_array;

      

       // User will be group admin for Sales and Support groups only.

      $group_admin_array = array("0", "1", "1");

      $request_array["is_group_admin"] =  $group_admin_array;

 

      // User can add new users under classroom only when acting as group admin for Sales and Support groups.

      $add_user_permission = array("0", "1", "1");

      $request_array["can_add_new_user"] = $add_user_permission;

 

      $json_request_string = json_encode( $request_array);
      echo sendRequest($json_request_string);

?>

 

Track User Progress For Each Assignment

Track each user's progress against assignments with the help of this API method.

 

Endpoint URL
https://www.proprofs.com/api/classroom/v1/reports/users/

 

Request Method
POST

 

Request Format
JSON

 

URL Parameters

 

Example Request
POST https://www.proprofs.com/api/classroom/v1/reports/users/
Accept: application/json
Content-Type: application/json
{  
    "token": "3f39cfe3d52efe4a275be19eb1e9db4e",
    "username": "johnsmith",
    "start": 1,
    "num": 100
}

 

Response Format
JSON

 

Response on Success

 

Example Response

Content-Type: application/json           
{
        "status":"SUCCESS",
        "userCount":1500,
        "result":[
        {
         "email":"john@example.net",
         "id":"RE101",
         "name":"JOHN SMITH",
         "group":[
            "Media",
            "Advertising",
            "Marketing"
         ],
         "assignment":[
          {
             "type":"course",
             "title":"Comparative Media Studies",
             "status":"Completed",
             "progress":"100",

             "assignedOnDate":"02/15/2016",

             "percentCompleted":"90"
          },
          {
             "type":"quiz",
             "title":"Unit quizzes on comparative media",
             "status":"Pending",
             "progress":"0",

             "assignedOnDate":"02/15/2016",

             "percentCompleted":"90"
          }
          ]
        }
      ]
    }

Responses on Error

 

Error Codes and Descriptions

 

Example Error Response

Content-Type: application/json

 {

                "status": "ERROR",

                "code": "ERR1001",

                "error": "API key is invalid"

             }

 
Supported Country Names

Afghanistan, Albania, Algeria, Andorra, Angola, Antigua & Deps, Argentina, Armenia, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bhutan, Bolivia, Bosnia Herzegovina, Botswana, Brazil","Brunei, Bulgaria, Burkina, Burundi, Cambodia, Cameroon, Canada, Cape Verdi, Central African Rep, Chad, Chile, China, Colombia, Comoros, Congo, Congo {Democratic Rep}, Costa Rica, Croatia, Cuba, Cyprus, Czech Republic, Denmark, Djibouti, Dominica, Dominican Republic, East Timor, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Fiji, Finland, France, Gabon, Gambia, Georgia, German, Ghana, Greece, Grenada, Guatemala, Guinea, Guinea-Bissau, Guyana, Haiti, Honduras, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland {Republic}, Israel, Italy, Ivory Coast, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Korea North, Korea South, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macedonia, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Mauritania, Mauritius, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Morocco, Mozambique, Myanmar {Burma}, Namibia, Nauru, Nepal, Netherlands, New Zealand, Nicaragua, Niger, Nigeria, Norway, Oman, Pakistan, Palau, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russian Federation, Rwanda, St Kitts & Nevis, St Lucia, St Vincent & Gr/dines, Samoa, San Marino, Sao Tome & Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, Spain, Sri Lanka, Sudan, Suriname, Swaziland, Sweden, Switzerland, Syria, Taiwan, Tajikistan ,Tanzania, Thailand, Togo, Tonga, Trinidad & Tobago, Tunisia, Turkey, Turkmenistan, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu, Vatican City, Venezuela, Vietnam, Yemen, Zambia, Zimbabwe

 

Classroom User Authentication

Authenticate users in the classroom using this API. It supports two modes of authentication.

 

• Authentication using Email/Username only.

If the request contains only an email or a username, we'll detect the learner's availability in the classroom.  

 

• Authentication using both Email and Password

If email, username, and password are present in API, we'll detect learners' availability in the classroom and authenticate it using their password.

 

Endpoint URL

https://www.proprofs.com/api/classroom/v1/user/auth/

 

Request Method

POST

 

Request Format

JSON

 

URL Parameters

 

 

Example Request

 

POST-https://www.proprofs.com/api/classroom/v1/user/auth/

Accept: application/json

Content-Type: application/json

{  

   "token": "3f39bfe3d52efe4a975ce19eb1e9db4e",

   "username": "johnsmith",

   "email_or_ID": "johnsmith@example.com",

   "password": "rdsxc234edsx"   

            }

 

Response Format

JSON

 

Response on Success

 

 

Example Response

Content-Type: application/json           

{

       "status":"SUCCESS",

       "result":[

         {

        "email":"john@example.net",

        "ID":"RE101",

        "name":"JOHN SMITH",

        "user_status":"active",

         "expiry_date":"05/22/2015",

        "group":[

           "Media",

           "Advertising",

           "Marketing"

        ],

        "assignment":[

         {

            "type":"course",

            "title":"Comparative Media Studies",

"unique_title":"comparative_media_studies",

            "progress":"Completed"

         },

         {

            "type":"quiz",

            "title":"Unit quizzes on comparative media",

"unique_title":"unit_quizzes_on_comparative_media",

            "progress":"Pending"

         }

          ]

       }

     ]

          }

 

    

    Responses on Error

 

 

Error Codes and Descriptions

 

 

    Example Error Response

    Content-Type: application/json

{

       "status": "ERROR",

       "code": "ERR2001",

       "error": "Request method must be POST"

            }

 

Live example in PHP

This example will help you authenticate users in the classroom using ProProfs REST API.

 

<?php

function sendRequest($json)

   {  

       $curl_obj = curl_init();

       curl_setopt($curl_obj, CURLOPT_SSL_VERIFYPEER, false);

       curl_setopt($curl_obj, CURLOPT_URL, "https://www.proprofs.com/api/classroom/v1/user/auth/");

       curl_setopt($curl_obj, CURLOPT_POSTFIELDS, $json);  

       curl_setopt($curl_obj, CURLOPT_RETURNTRANSFER, 1);

       curl_setopt($curl_obj, CURLOPT_POST, 1);

       curl_setopt($curl_obj, CURLOPT_HEADER, 0);  

       return curl_exec($curl_obj);  

   }

  

     $request_array = array();

 

     $request_array["token"] = "Your API Key";

     $request_array["username"] = "Your ProProfs Username";

     $request_array["email_or_ID"] = "john@proprofs.com";

     $request_array["password"] = "3aa801d5d85e77ce9f2e431d8bf5fd73";  

               $json_request_string = json_encode( $request_array);

   echo sendRequest($json_request_string);

    ?>