BTA

BTA REST API Documentation

Your api_token will be emailed to you when you completed the partnership agreement.
Results Data in JSON Format

Usage

Register a student and create their student portal by making the studentregister request. This will return their unique student ID number so you can use for the other requests like retrieving a student, adding a course to their student portal and assigning them an exam voucher so they can take the exam through our BTA Student Portal. They will use their voucher to register on the website and schedule their exam date and time.

When a student orders a course, make the addcourse request. You will need their student id and course id to add their student portal. You get the course ids by making the courses request.

Endpoints

Register Student	Retrieve All Students	Retrieve A Student	Retrieve All Courses	Retrieve A Course
Add Course	Completed Courses	Completed a Course	Last Logins	Exams
Last Login	All Student Course Percentages	A Student's Course Percentage	Retrieve All Students Courses	Retrieve A Student's Course

Register and Create Student Portal Access

POST
URL: https://www.btacertified.com/api/v1/studentregister

HEADER:
Authorization api_token

PARAMS:

first_name
last_name
email
custom_code (optional)
password
send_email (1 or 0 - Default is set to 0)

RESULTS

						[
						    [
						        {
						            "id": STUDENT_ID,
						            "name": "STUDENT NAME",
						            "email": "STUDENT EMAIL"
						        }
						    ]
						]

Retreive Students

POST
URL: https://www.btacertified.com/api/v1/students

HEADER:
Authorization api_token

RESULTS

						[
						    [
						        {
						            "id": STUDENT_ID,
						            "name": "STUDENT NAME",
						            "email": "STUDENT EMAIL",
						            "custom_code": "9999" (or NULL if empty)
						        }
						    ]
						]

Retreive A Student

POST
URL: https://www.btacertified.com/api/v1/student

HEADER:
Authorization api_token

PARAMS:

student_id

RESULTS

						[
						    [
						        {
						            "id": STUDENT_ID,
						            "name": "STUDENT NAME",
						            "email": "STUDENT EMAIL",
						            "custom_code": "9999" (or NULL if empty)
						        }
						    ]
						]

Retreive Courses

POST
URL: https://www.btacertified.com/api/v1/courses

HEADER:
Authorization api_token

RESULTS

						[
						    [
		
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Overview: Business Foundations",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Architecture",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Ethereum Developer",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Hyperledger Developer",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Security",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Corda",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        }
						    ]
						]

Retreive a Course

POST
URL: https://www.btacertified.com/api/v1/course

HEADER:
Authorization api_token

PARAMS:

course_id

RESULTS

						[
						    [
		
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Overview: Business Foundations",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        }
						    ]
						]

Retreive All Students Courses

POST
URL: https://www.btacertified.com/api/v1/studentcourses

HEADER:
Authorization api_token

PARAMS:

student_id

						[
						    [
		
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Overview: Business Foundations",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Architecture",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Ethereum Developer",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Hyperledger Developer",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Security",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        },
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Corda",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        }
						    ]
						]

Retreive a Student's Course

POST
URL: https://www.btacertified.com/api/v1/studentcourse

HEADER:
Authorization api_token

PARAMS:

student_id
course_id

RESULTS

						[
						    [
		
						        {
						            "course_id": YOUR_COURSE_ID,
						            "course_name": "YOUR COMPANY NAME Blockchain Overview: Business Foundations",
									"course_lab_link": URL,
									"course_code": URL,
									"slide_link": URL,
									"labguide_link":URL,
									"studyguide_link": URL
						        }
						    ]
						]

Student Add Course

POST
URL: https://www.btacertified.com/api/v1/addcourse

HEADER:
Authorization api_token

PARAMS:

student_id
course_id
ondemand (1 or 0) 1 = ondemand is true and will display in the ondemand section only. 0 = is false and will show up in the instructor-led section only in the student portal

RESULTS

						['message' => 'success']

Retreive the students that have completed their courses

POST
URL: https://www.btacertified.com/api/v1/coursescompleted

HEADER:
Authorization api_token

RESULTS

					[
						[
							{
								"name": "STUDENT_NAME",
								"course_name": "Blockchain Overview: Business Foundations"
							},
							{
								"name": "STUDENT_NAME",
								"course_name": "Blockchain Overview: Business Foundations"
							},
							{
								"name": "STUDENT_NAME",
								"course_name": "Blockchain Overview: Business Foundations"
							},
							{
								"name": "STUDENT_NAME",
								"course_name": "Blockchain Overview: Business Foundations"
							},
							{
								"name": "STUDENT_NAME",
								"course_name": "Blockchain Overview: Business Foundations"
							}
						]
					]

Retreive a single student's that have completed their course

POST
URL: https://www.btacertified.com/api/v1/coursecompleted

HEADER:
Authorization api_token

student_id
course_id

RESULTS

						{
							"message": "Course Completed"
						}

						or 

						{
							"message": "Course Not Completed"
						}

Retreive all students last logins

POST
URL: https://www.btacertified.com/api/v1/lastlogins

HEADER:
Authorization api_token

RESULTS

						[
							{
								"name": "STUDENT_NAME",
								"last_login_at": "2018-07-05 00:41:19",
								"last_login_ip": null
							},
							{
								"name": "STUDENT_NAME",
								"last_login_at": "2018-06-05 00:21:11",
								"last_login_ip": null
							}
						]

Retreive a single student's last login

POST
URL: https://www.btacertified.com/api/v1/lastlogin

HEADER:
Authorization api_token

student_id

RESULTS

						[
							{
								"name": "STUDENT_NAME",
								"last_login_at": "2018-07-05 00:41:19",
								"last_login_ip": null
							}
						]

Retreive all student's percentage completed for their courses

POST
URL: https://www.btacertified.com/api/v1/coursesprogress

HEADER:
Authorization api_token

RESULTS

					[
						{
							"course_name": "Blockchain Architecture",
							"user_name": "STUDENT_NAME",
							"percentage_completed": "1.0"
						},
						{
							"course_name": "Blockchain Architecture",
							"user_name": "STUDENT_NAME",
							"percentage_completed": "0.50"
						}
					]

The percentage complete of the Enrollment. A number between 0.0 and 1.0. For example, to represent a percentage complete of 75%, this value would be 0.75.

Retreive a single student's percentage completed for their course

POST
URL: https://www.btacertified.com/api/v1/courseprogress

HEADER:
Authorization api_token

student_id
course_id

RESULTS

					[
						{
							"course_name": "Blockchain Architecture",
							"user_name": "STUDENT_NAME",
							"percentage_completed": "1.0"
						}
					]

The percentage complete of the Enrollment. A number between 0.0 and 1.0. For example, to represent a percentage complete of 75%, this value would be 0.75.

Retreive Exams

POST
URL: https://www.btacertified.com/api/v1/exams

HEADER:
Authorization api_token

RESULTS

					[
							[
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBBF"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBDE"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBSA"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBHD"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBSP"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Recertification Exam CBSA"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam French CBBF"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam French CBSA"
								},
								{
									"thinkific_course_id": THINKIFIC_COURSE_ID,
									"name": "Certification Exam CBPM"
								}
							]
						]

Retreive an Exam

POST
URL: https://www.btacertified.com/api/v1/exam

HEADER:
Authorization api_token

PARAMS:

thinkific_course_id

RESULTS

						[
						    [
		
						        {
						            "thinkific_course_id": THINKIFIC_COURSE_ID,
						            "name": "Certification Exam CBBF"
						        }
						    ]
						]

Assign an Exam to a Student

POST
URL: https://www.btacertified.com/api/v1/assignexam

HEADER:
Authorization api_token

PARAMS:

student_id
thinkific_course_id

RESULTS

						[
						    [
		
						        {
						            "message": "success",
						        }
						    ]
						]