List daily attendance for a school

Attendance records for one school on one school day, for kiosks and reconciliation. Covers students with a school enrollment at the school that is active on the date. By default only exceptions are returned (every status except present); pass includePresent=true for the full day. A student with no record has not had attendance taken. Pass since to pull only records written after a time (for hourly delta pulls); cleared records drop out of the results rather than being reported. Requires API token authentication with the attendance-daily scope.

GET

attendance

daily

curl --request GET \
  --url https://api.teachwithscout.com/v1/attendance/daily \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.teachwithscout.com/v1/attendance/daily', 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://api.teachwithscout.com/v1/attendance/daily",
  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://api.teachwithscout.com/v1/attendance/daily"

	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://api.teachwithscout.com/v1/attendance/daily")

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

{
  "records": [
    {
      "studentId": "<string>",
      "scoutStudentId": "<string>",
      "date": "<string>",
      "attendanceCode": "<string>",
      "attendanceCodeDescription": "<string>",
      "status": "present",
      "excused": true,
      "lastModified": "<string>",
      "minutesLate": 123,
      "arrivalTime": "<string>",
      "source": "vendor",
      "enteredBy": "<string>"
    }
  ]
}

{
  "status": 400,
  "message": "<string>"
}

{
  "status": 403,
  "message": "<string>"
}

{
  "status": 404,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer access token from POST /oauth/token (OAuth 2.0 client credentials; the OneRoster /ims/oneroster/v1p1/token and /v1p2/token URLs are aliases). Send it as Authorization: Bearer <access_token>. Tokens expire after 1 hour and carry your API client's granted scopes — an endpoint outside them returns 403.

Query Parameters

schoolId

string

required

The Scout school id (the OneRoster schools sourcedId).

date

string

required

The school day, YYYY-MM-DD.

includePresent

boolean

Include present students too. Defaults to false (exceptions only).

since

string

Only records last written after this time (ISO 8601).

limit

integer

Page size, 1–1000. Defaults to 100.

offset

integer

Number of records to skip. Defaults to 0.

Response

A page of records, ordered by Scout student id. The X-Total-Count header carries the total across all pages.

A page of daily attendance records.

records

object[]

required

Show child attributes

⌘I

List daily attendance for a school

curl --request GET \
  --url https://api.teachwithscout.com/v1/attendance/daily \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.teachwithscout.com/v1/attendance/daily', 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://api.teachwithscout.com/v1/attendance/daily",
  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://api.teachwithscout.com/v1/attendance/daily"

	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://api.teachwithscout.com/v1/attendance/daily")

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

{
  "records": [
    {
      "studentId": "<string>",
      "scoutStudentId": "<string>",
      "date": "<string>",
      "attendanceCode": "<string>",
      "attendanceCodeDescription": "<string>",
      "status": "present",
      "excused": true,
      "lastModified": "<string>",
      "minutesLate": 123,
      "arrivalTime": "<string>",
      "source": "vendor",
      "enteredBy": "<string>"
    }
  ]
}

{
  "status": 400,
  "message": "<string>"
}

{
  "status": 403,
  "message": "<string>"
}

{
  "status": 404,
  "message": "<string>"
}

Get started

Endpoints

List daily attendance for a school

Authorizations

Query Parameters

Response