REMIC Portal API
Welcome to REMIC's Portal API documentation. This API allows users to pull student data including LMS groups, affiliate code, and quiz grades. Below you will find all of our API endpoints that provide various functionality. If you need help with anything, please reach out to jjbooth@remic.ca for assistance. To get started with REMIC's Portal API, you will need an API key. Happy coding!
API Key
The API Key is directly connected to a user of our Portal reporting system. When a Portal user is created, that user is given permissions to view sets of users based on LMS groups and/or Affiliate Code (or perhaps other criteria). An API request will have the same permissions of the user to which the key is attached.
Please note: This is a private API and access is only available to REMIC partners.
To create a key, you will need access to the Portal API icon in Portal. If you do not see this icon, please contact jjbooth@remic.ca and provide the name or email address of the Portal user who will be attached to the API calls.
On this page you will be able to generate an API key. Keep this key private! Anyone with access to that key will be able to view student data associated with the Portal account. The API key will need to be used in a header called APIKEY. When sending the key, please make sure it is sent exactly as provided, with 64 mixed-case alpha-numeric characters, and that there are no spaces at the beginning or end, or your requests may not work.
API URLs
Our API has direct access to our live system, and at this time it provides reporting only and cannot make changes to accounts. All API calls will follow the same basic format:
https://portalapi.remic.ca/{version}/{command}/?{parameters}
Requests and Responses
Once you have the API key and URL, you may begin making requests. All responses will be in JSON format.
Response Code
All HTTP responses will return with a status code of 200, and developers should rely on the response_code parameter to determine whether there was an error with the call. The response codes are as follows:
- Success
- API key failure
- Other failure
The corresponding error field will contain details of the error if the response code is not 1.
Contact
If you encounter any issues with the REMIC API, please contact J.J. Booth, our Director of IT, using this email: jjbooth@remic.ca
Endpoints
Here you will find the list of all available API endpoints and how to use them.
List HLLQP Students
GET/v1/listhllqpstudents
https://portalapi.remic.ca/v1/listhllqpstudents/?start=YYYY-MM-DD&end=YYYY-MM-DD
This endpoint returns a list of HLLQP students who enrolled between the start date and the end date and provides a lot of information about each student.
Please note that the API will return a maximum of 1000 student records per call. It is advisable to limit the data ranges to ensure you are not missing data.
HEADERS
| APIKEY | PRTAPIGWBdOHLnZsXYdeyZYmvCWyBZFVImiRQnsD53qQsvaUC4kYlxkeSry9sxykAPI Key provided by REMIC through the Portal interface (This is a non-functional sample key) |
BODY
| start (optional) | 2023-01-01The first date of enrollment. Students selected will have an enrollment that starts later than 0 seconds after midnight on this date (ie. 2023-01-01 at 0:00:00). If this parameter is omitted, the enrollment start date will be the date the server went online. |
| end (optional) | 2023-02-01The last date of enrollment. Students selected will have an enrollment that started up to 1 second before midnight on the following date (ie. 2023-02-01 at 23:59:59). If this parameter is omitted, the enrollment start date will be the time the request was made. |
Example Request
curl --location 'https://portalapi.remic.ca/v1/listhllqpstudents/?start=2023-02-01&end=2023-03-01' \
--header 'APIKEY: PRTAPIGWBdOHLnZsXYdeyZYmvCWyBZFVImiRQnsD53qQsvaUC4kYlxkeSry9sxyk'Example Response
{
"authuser": "John Instructor",
"response_code": 1,
"details": "Getting the enrolled HLLQP students.",
"First Date": "2023-02-01T00:00:00-05:00",
"Last Date": "2023-03-01T23:59:59-05:00",
"students": [
{
"UserID": 41234,
"First Name": "Patrick",
"Last Name": "Smith",
"Email": "patricksmith@fakeemail.com",
"Enrollment Start": "2023-02-02T11:02:13-05:00",
"Enrollment End": "2024-02-02T11:02:13-05:00",
"Affiliate Code": "ab-cd",
"Group Membership": [
{
"Group ID": "151",
"Group Name": "online"
},
{
"Group ID": "999",
"Group Name": "ab-cd"
}
],
"Quizzes": [
{
"Quiz ID": "91",
"Quiz Name": "Certification Exam (E)",
"Start Time": "2023-02-20T12:34:30-05:00",
"Exam Total Time": "51m 1s",
"Exam State": "FINISHED",
"Quiz Max Score": 20,
"Grade To Pass": "12",
"Student Grade": "12",
"PassFail": "PASS"
},
{
"Quiz ID": "89",
"Quiz Name": "Certification Exam (A&S)",
"Start Time": "2023-02-21T12:12:37-05:00",
"Exam Total Time": "1h 1m 55s",
"Exam State": "FINISHED",
"Quiz Max Score": 30,
"Grade To Pass": "18",
"Student Grade": "27",
"PassFail": "PASS"
}
]
},
{
"UserID": 21331,
"First Name": "Dave",
"Last Name": "Jones",
"Email": "davidjones@fakestudent.com",
"Enrollment Start": "2023-02-02T10:53:56-05:00",
"Enrollment End": "2024-02-19T18:43:18-05:00",
"Affiliate Code": "ab-cd",
"Group Membership": [
{
"Group ID": "151",
"Group Name": "online"
}
],
"Quizzes": [
{
"Quiz ID": "91",
"Quiz Name": "Certification Exam (E)",
"Start Time": "2023-02-05T21:47:23-05:00",
"Exam Total Time": "59m 9s",
"Exam State": "FINISHED",
"Quiz Max Score": 20,
"Grade To Pass": "12",
"Student Grade": "8",
"PassFail": "FAIL"
},
{
"Quiz ID": "91",
"Quiz Name": "Certification Exam (E)",
"Start Time": "2023-02-06T22:52:09-05:00",
"Exam Total Time": "1h 0m ",
"Exam State": "FINISHED",
"Quiz Max Score": 20,
"Grade To Pass": "12",
"Student Grade": "10",
"PassFail": "FAIL"
}
]
}
],
"Records Returned": 2,
"script_start_time": "2023-03-03T11:38:36-05:00",
"script_execution_time_seconds": 1.4948558807373047
}