Get students in a class

curl --request GET \
  --url https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "users": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "userIds": [
        {
          "type": "<string>",
          "identifier": "<string>"
        }
      ],
      "enabledUser": "true",
      "givenName": "<string>",
      "familyName": "<string>",
      "roles": [
        {
          "roleType": "primary",
          "role": "aide",
          "org": {
            "href": "<string>",
            "sourcedId": "<string>",
            "type": "academicSession"
          },
          "userProfile": "<string>",
          "beginDate": "<string>",
          "endDate": "<string>",
          "admissionDate": "2023-12-25"
        }
      ],
      "userProfiles": [
        {
          "profileId": "<string>",
          "profileType": "<string>",
          "vendorId": "<string>",
          "applicationId": "<string>",
          "description": "<string>",
          "dateCreated": "2023-11-07T05:31:56Z",
          "credentials": [
            {
              "username": "<string>",
              "password": "<string>",
              "identity": "<string>"
            }
          ]
        }
      ],
      "email": "<string>",
      "agents": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "grades": [
        "<string>"
      ],
      "resources": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "metadata": {},
      "userMasterIdentifier": "<string>",
      "username": "<string>",
      "middleName": "<string>",
      "preferredFirstName": "<string>",
      "preferredMiddleName": "<string>",
      "preferredLastName": "<string>",
      "primaryOrg": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "identifier": "<string>",
      "sms": "<string>",
      "phone": "<string>",
      "password": "<string>"
    }
  ],
  "offset": 123,
  "limit": 123,
  "total": 123
}

GET

rostering

1.0

classes

{sourcedId}

students

Get students in a class

curl --request GET \
  --url https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/rostering/1.0/classes/{sourcedId}/students")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "users": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "userIds": [
        {
          "type": "<string>",
          "identifier": "<string>"
        }
      ],
      "enabledUser": "true",
      "givenName": "<string>",
      "familyName": "<string>",
      "roles": [
        {
          "roleType": "primary",
          "role": "aide",
          "org": {
            "href": "<string>",
            "sourcedId": "<string>",
            "type": "academicSession"
          },
          "userProfile": "<string>",
          "beginDate": "<string>",
          "endDate": "<string>",
          "admissionDate": "2023-12-25"
        }
      ],
      "userProfiles": [
        {
          "profileId": "<string>",
          "profileType": "<string>",
          "vendorId": "<string>",
          "applicationId": "<string>",
          "description": "<string>",
          "dateCreated": "2023-11-07T05:31:56Z",
          "credentials": [
            {
              "username": "<string>",
              "password": "<string>",
              "identity": "<string>"
            }
          ]
        }
      ],
      "email": "<string>",
      "agents": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "grades": [
        "<string>"
      ],
      "resources": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "metadata": {},
      "userMasterIdentifier": "<string>",
      "username": "<string>",
      "middleName": "<string>",
      "preferredFirstName": "<string>",
      "preferredMiddleName": "<string>",
      "preferredLastName": "<string>",
      "primaryOrg": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "identifier": "<string>",
      "sms": "<string>",
      "phone": "<string>",
      "password": "<string>"
    }
  ],
  "offset": 123,
  "limit": 123,
  "total": 123
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

sourcedId

string

required

Unique identifier of the class

Query Parameters

asOfDate

string<date>

Optional ISO-8601 date. When supplied, only students enrolled in the class as of that date are returned (enrollment begin_date/end_date window); omitted returns all.

limit

integer

default:10

Maximum number of items to return

Required range: 1 <= x <= 100

offset

integer

default:0

Number of items to skip

Required range: x >= 0

filter

string

Filter results using OneRoster syntax: filter= Predicates: = (equals), != (not equals), ~ (contains), >, >=, <, <= Logical operators: AND, OR (max 2 predicates per OneRoster spec) Available fields: sourcedId, status, email, familyName, givenName, middleName, username, enabledUser, identifier, roles Example: filter=email='john@example.com'

sort

string

Field to sort by

orderBy

enum<string>

default:ASC

Sort direction

Available options:

ASC,

DESC

fields

string

Comma-separated list of fields to include in the response. Available fields: sourcedId, status, dateLastModified, username, enabledUser, givenName, familyName, middleName, email, phone, sms, identifier, roles, grades, agents, userIds, userMasterIdentifier, preferredFirstName, preferredMiddleName, preferredLastName, primaryOrg.sourcedId, primaryOrg.type, userProfiles, userProfiles.profileId, userProfiles.profileType, userProfiles.vendorId, userProfiles.applicationId

Response

Successful operation

Paginated list of OneRoster users

users

object[]

required

Array of user objects

Show child attributes

offset

integer

required

Number of items skipped in the result set

limit

integer

required

Maximum number of items returned

total

integer

required

Total number of items available

⌘I