Product: Partner Portal 

Audience: Partner Administrator & Developer

Overview

• cURL
• Node
• Ruby
• JavaScript
• Python
• Sample Result

GET - https://nodeapi.classlink.com/v2/my/students

cURL

curl --request GET \
  --url https://nodeapi.classlink.com/v2/my/students \
  --header 'authorization: Bearer {bearer_token}'

Node

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://nodeapi.classlink.com/v2/my/students',
  headers: {authorization: 'Bearer {bearer_token}'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://nodeapi.classlink.com/v2/my/students")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer {bearer_token}'

response = http.request(request)
puts response.read_body

JavaScript

const data = null;

const xhr = new XMLHttpRequest();

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://nodeapi.classlink.com/v2/my/students");
xhr.setRequestHeader("authorization", "Bearer {bearer_token}");

xhr.send(data);

Python

import requests

url = "https://nodeapi.classlink.com/v2/my/students"

headers = {"authorization": "Bearer {bearer_token}"}

response = requests.request("GET", url, headers=headers)

print(response.text)

Shows Linked Students

If a parent registers for ClassLink, this endpoint will display a list of any linked student accounts.

Sample Result

JSON

{
  "status": 1,
  "response": [
    {
      "UserId": 1797039,
      "DisplayName": "_Dev Template",
      "FirstName": "_Dev",
      "LastName": "Template",
      "Email": "devtemplate14042016190420601@Demo.local",
      "UserName": "devtemplate",
      "ParentRedeemCode": "DEM-9b9485e5-3d42-4be2-b7a7-b744",
      "IsDefault": 1
    },
    {
      "UserId": 1505509,
      "DisplayName": "1234567890123456789012345",
      "FirstName": "1234567890123456789012345",
      "LastName": "",
      "Email": "123456789012345678901234527102015061058353@Demo.local",
      "UserName": "1234567890123456789012345",
      "ParentRedeemCode": "DEM-28988cab1f13-b744-b7a7-b744-053655459845",
      "IsDefault": 0
    }
  ]
}