Create a new student
curl --request PUT \
--url https://platform.dev.timeback.com/rostering/1.0/students \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"student": {
"sourcedId": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"primaryOrg": {
"sourcedId": "<string>",
"type": "org",
"href": "<string>"
},
"grades": [
"<string>"
],
"metadata": {},
"userMasterIdentifier": "<string>",
"middleName": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"demographics": {
"birthDate": "2023-12-25"
},
"identifier": "<string>",
"email": "<string>",
"sms": "<string>",
"phone": "<string>",
"password": "<string>"
}
}
'import requests
url = "https://platform.dev.timeback.com/rostering/1.0/students"
payload = { "student": {
"sourcedId": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"primaryOrg": {
"sourcedId": "<string>",
"type": "org",
"href": "<string>"
},
"grades": ["<string>"],
"metadata": {},
"userMasterIdentifier": "<string>",
"middleName": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"demographics": { "birthDate": "2023-12-25" },
"identifier": "<string>",
"email": "<string>",
"sms": "<string>",
"phone": "<string>",
"password": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
student: {
sourcedId: '<string>',
username: '<string>',
givenName: '<string>',
familyName: '<string>',
primaryOrg: {sourcedId: '<string>', type: 'org', href: '<string>'},
grades: ['<string>'],
metadata: {},
userMasterIdentifier: '<string>',
middleName: '<string>',
preferredFirstName: '<string>',
preferredMiddleName: '<string>',
preferredLastName: '<string>',
pronouns: '<string>',
demographics: {birthDate: '2023-12-25'},
identifier: '<string>',
email: '<string>',
sms: '<string>',
phone: '<string>',
password: '<string>'
}
})
};
fetch('https://platform.dev.timeback.com/rostering/1.0/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/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'student' => [
'sourcedId' => '<string>',
'username' => '<string>',
'givenName' => '<string>',
'familyName' => '<string>',
'primaryOrg' => [
'sourcedId' => '<string>',
'type' => 'org',
'href' => '<string>'
],
'grades' => [
'<string>'
],
'metadata' => [
],
'userMasterIdentifier' => '<string>',
'middleName' => '<string>',
'preferredFirstName' => '<string>',
'preferredMiddleName' => '<string>',
'preferredLastName' => '<string>',
'pronouns' => '<string>',
'demographics' => [
'birthDate' => '2023-12-25'
],
'identifier' => '<string>',
'email' => '<string>',
'sms' => '<string>',
'phone' => '<string>',
'password' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.dev.timeback.com/rostering/1.0/students"
payload := strings.NewReader("{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://platform.dev.timeback.com/rostering/1.0/students")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.dev.timeback.com/rostering/1.0/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"student": {
"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>"
}
}Students
Create a new student
Creates a new student in the system
PUT
/
rostering
/
1.0
/
students
Create a new student
curl --request PUT \
--url https://platform.dev.timeback.com/rostering/1.0/students \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"student": {
"sourcedId": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"primaryOrg": {
"sourcedId": "<string>",
"type": "org",
"href": "<string>"
},
"grades": [
"<string>"
],
"metadata": {},
"userMasterIdentifier": "<string>",
"middleName": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"demographics": {
"birthDate": "2023-12-25"
},
"identifier": "<string>",
"email": "<string>",
"sms": "<string>",
"phone": "<string>",
"password": "<string>"
}
}
'import requests
url = "https://platform.dev.timeback.com/rostering/1.0/students"
payload = { "student": {
"sourcedId": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"primaryOrg": {
"sourcedId": "<string>",
"type": "org",
"href": "<string>"
},
"grades": ["<string>"],
"metadata": {},
"userMasterIdentifier": "<string>",
"middleName": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"demographics": { "birthDate": "2023-12-25" },
"identifier": "<string>",
"email": "<string>",
"sms": "<string>",
"phone": "<string>",
"password": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
student: {
sourcedId: '<string>',
username: '<string>',
givenName: '<string>',
familyName: '<string>',
primaryOrg: {sourcedId: '<string>', type: 'org', href: '<string>'},
grades: ['<string>'],
metadata: {},
userMasterIdentifier: '<string>',
middleName: '<string>',
preferredFirstName: '<string>',
preferredMiddleName: '<string>',
preferredLastName: '<string>',
pronouns: '<string>',
demographics: {birthDate: '2023-12-25'},
identifier: '<string>',
email: '<string>',
sms: '<string>',
phone: '<string>',
password: '<string>'
}
})
};
fetch('https://platform.dev.timeback.com/rostering/1.0/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/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'student' => [
'sourcedId' => '<string>',
'username' => '<string>',
'givenName' => '<string>',
'familyName' => '<string>',
'primaryOrg' => [
'sourcedId' => '<string>',
'type' => 'org',
'href' => '<string>'
],
'grades' => [
'<string>'
],
'metadata' => [
],
'userMasterIdentifier' => '<string>',
'middleName' => '<string>',
'preferredFirstName' => '<string>',
'preferredMiddleName' => '<string>',
'preferredLastName' => '<string>',
'pronouns' => '<string>',
'demographics' => [
'birthDate' => '2023-12-25'
],
'identifier' => '<string>',
'email' => '<string>',
'sms' => '<string>',
'phone' => '<string>',
'password' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.dev.timeback.com/rostering/1.0/students"
payload := strings.NewReader("{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://platform.dev.timeback.com/rostering/1.0/students")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.dev.timeback.com/rostering/1.0/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"student\": {\n \"sourcedId\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"primaryOrg\": {\n \"sourcedId\": \"<string>\",\n \"type\": \"org\",\n \"href\": \"<string>\"\n },\n \"grades\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"userMasterIdentifier\": \"<string>\",\n \"middleName\": \"<string>\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"demographics\": {\n \"birthDate\": \"2023-12-25\"\n },\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"password\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"student": {
"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>"
}
}Authorizations
OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.
Body
application/json
Student object to be created
Show child attributes
Show child attributes
Response
Student created successfully
User information in the OneRoster format
Show child attributes
Show child attributes
⌘I