Get a class by ID

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

import requests

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

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}', 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}",
  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}"

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

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

{
  "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"
    }
  ]
}

GET

rostering

1.0

classes

{sourcedId}

Get a class by ID

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

import requests

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

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}', 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}",
  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}"

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

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

{
  "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"
    }
  ]
}

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

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

Class information in the OneRoster format

sourcedId

string

required

Unique identifier for the class

status

enum<string>

required

Status of an entity in the system

Available options:

active,

tobedeleted,

inactive

dateLastModified

string<date-time>

required

Timestamp of when the class was last modified

title

string

required

Title or name of the class

classCode

string

required

Code used to identify the class

classType

string

required

Type of class (scheduled, homeroom, etc.)

grades

string[]

required

Array of grade levels associated with the class

subjects

string[]

required

Array of subjects covered in the class

periods

string[]

required

Array of time periods when the class is scheduled

course

object

required

Course information associated with the class

Show child attributes

school

object

required

School information associated with the class

Show child attributes

terms

object[]

required

Academic sessions (terms) associated with the class

Show child attributes

metadata

object | null

Additional metadata associated with the class

location

string | null

Physical location where the class is held

subjectCodes

string[] | null

Array of subject codes for the class

resources

object[]

Array of resources associated with the class

Show child attributes

⌘I