Get all classes - Timeback Docs (Beta)

Get all classes

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

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

fetch('https://platform.dev.timeback.com/rostering/1.0/classes', 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",
  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"

	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")

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

{
  "classes": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "classCode": "<string>",
      "classType": "<string>",
      "grades": [
        "<string>"
      ],
      "subjects": [
        "<string>"
      ],
      "periods": [
        "<string>"
      ],
      "course": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "school": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "terms": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "metadata": {},
      "location": "<string>",
      "subjectCodes": [
        "<string>"
      ],
      "resources": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "total": 123
}

GET

rostering

1.0

classes

Get all classes

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

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

fetch('https://platform.dev.timeback.com/rostering/1.0/classes', 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",
  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"

	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")

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

{
  "classes": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "classCode": "<string>",
      "classType": "<string>",
      "grades": [
        "<string>"
      ],
      "subjects": [
        "<string>"
      ],
      "periods": [
        "<string>"
      ],
      "course": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "school": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      },
      "terms": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ],
      "metadata": {},
      "location": "<string>",
      "subjectCodes": [
        "<string>"
      ],
      "resources": [
        {
          "href": "<string>",
          "sourcedId": "<string>",
          "type": "academicSession"
        }
      ]
    }
  ],
  "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.

Query Parameters

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

classes

object[]

required

Array of class 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