Get organization by ID

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

import requests

url = "https://platform.dev.timeback.com/rostering/1.0/orgs/{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/orgs/{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/orgs/{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/orgs/{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/orgs/{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

{
  "organization": {
    "sourcedId": "<string>",
    "status": "active",
    "dateLastModified": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "type": "department",
    "identifier": "<string>",
    "metadata": {
      "privacyPolicyUrl": "<string>",
      "appStoreEnabled": true,
      "consentManagementEnabled": true,
      "credentialImportMode": "enabled",
      "cameraMicDefault": "always_on",
      "populationScope": "production"
    },
    "parent": {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "academicSession"
    },
    "children": [
      {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      }
    ]
  }
}

GET

rostering

1.0

orgs

{sourcedId}

Get organization by ID

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

import requests

url = "https://platform.dev.timeback.com/rostering/1.0/orgs/{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/orgs/{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/orgs/{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/orgs/{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/orgs/{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

{
  "organization": {
    "sourcedId": "<string>",
    "status": "active",
    "dateLastModified": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "type": "department",
    "identifier": "<string>",
    "metadata": {
      "privacyPolicyUrl": "<string>",
      "appStoreEnabled": true,
      "consentManagementEnabled": true,
      "credentialImportMode": "enabled",
      "cameraMicDefault": "always_on",
      "populationScope": "production"
    },
    "parent": {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "academicSession"
    },
    "children": [
      {
        "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 organization

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

organization

object

required

Organization information in the OneRoster format

Show child attributes

⌘I