Record daily attendance for many students

Record up to 200 daily-attendance records in one request. Requires an access token from an API client with the attendance-daily scope (see Authentication). The body is a JSON array of the same records accepted by POST /attendance/daily, with the same matching, code mapping, and idempotency rules. The response carries one result per record, in request order, each with the record’s index and, on failure, the HTTP status and error code the single-record endpoint would have returned. The response is 200 when every record succeeded and 207 when any failed. An invalid record fails on its own; an unexpected server error (500) fails every record for the same date, which is safe to resend. Records for the same student and date are applied in request order, so the last one wins. Send larger reconciliations in chunks of at most 200 records.

POST

attendance

daily

bulk

Record daily attendance for many students

curl --request POST \
  --url https://api.teachwithscout.com/v1/attendance/daily/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "studentId": "<string>",
    "date": "<string>",
    "attendanceCode": "<string>",
    "arrivalTime": "<string>",
    "comment": "<string>"
  }
]
'

import requests

url = "https://api.teachwithscout.com/v1/attendance/daily/bulk"

payload = [
    {
        "studentId": "<string>",
        "date": "<string>",
        "attendanceCode": "<string>",
        "arrivalTime": "<string>",
        "comment": "<string>"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      studentId: '<string>',
      date: '<string>',
      attendanceCode: '<string>',
      arrivalTime: '<string>',
      comment: '<string>'
    }
  ])
};

fetch('https://api.teachwithscout.com/v1/attendance/daily/bulk', 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/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'studentId' => '<string>',
        'date' => '<string>',
        'attendanceCode' => '<string>',
        'arrivalTime' => '<string>',
        'comment' => '<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://api.teachwithscout.com/v1/attendance/daily/bulk"

	payload := strings.NewReader("[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]")

	req, _ := http.NewRequest("POST", 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.post("https://api.teachwithscout.com/v1/attendance/daily/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teachwithscout.com/v1/attendance/daily/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "summary": {
    "recorded": 123,
    "updated": 123,
    "duplicate": 123,
    "failed": 123
  },
  "results": [
    {
      "index": 123,
      "status": "recorded",
      "studentId": "<string>",
      "date": "<string>",
      "scoutStudentId": "<string>",
      "mappedStatus": "Absent",
      "error": {
        "status": 123,
        "code": "<string>",
        "message": "<string>"
      }
    }
  ]
}

{
  "summary": {
    "recorded": 123,
    "updated": 123,
    "duplicate": 123,
    "failed": 123
  },
  "results": [
    {
      "index": 123,
      "status": "recorded",
      "studentId": "<string>",
      "date": "<string>",
      "scoutStudentId": "<string>",
      "mappedStatus": "Absent",
      "error": {
        "status": 123,
        "code": "<string>",
        "message": "<string>"
      }
    }
  ]
}

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

{
  "status": 403,
  "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.

Body

application/json

Required array length: 1 - 200 elements

studentId

string

required

The student the record is for. Accepts the OneRoster identifier (student number), the state identifier (e.g. SSID), or the Scout student id (OneRoster sourcedId).

date

string

required

The school day, as YYYY-MM-DD. Must not be in the future.

attendanceCode

string

required

The day's attendance status. Accepts Scout status names (case-insensitive) — Present, Late, ExcusedLate, Absent, ExcusedAbsence, LeftEarly — or common letter codes: P, T/L (tardy), A, E/EA (excused absence), ET/TE (excused tardy), LE (left early).

arrivalTime

string | null

When the student arrived, as 24-hour local time (HH:mm or HH:mm:ss) on the record's date, read as Pacific time. Stored as a timestamp and returned by the attendance reads; also used as the attendance log description when no comment is given. Not used to compute late minutes.

comment

string | null

Free-text note, stored as the attendance log description.

Response

Every record was recorded, updated, or already current.

Outcome of a bulk daily-attendance request.

summary

object

required

Count of records by outcome.

Show child attributes

results

object[]

required

One result per request record, in request order.

Show child attributes

⌘I

Record daily attendance for many students

curl --request POST \
  --url https://api.teachwithscout.com/v1/attendance/daily/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "studentId": "<string>",
    "date": "<string>",
    "attendanceCode": "<string>",
    "arrivalTime": "<string>",
    "comment": "<string>"
  }
]
'

import requests

url = "https://api.teachwithscout.com/v1/attendance/daily/bulk"

payload = [
    {
        "studentId": "<string>",
        "date": "<string>",
        "attendanceCode": "<string>",
        "arrivalTime": "<string>",
        "comment": "<string>"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      studentId: '<string>',
      date: '<string>',
      attendanceCode: '<string>',
      arrivalTime: '<string>',
      comment: '<string>'
    }
  ])
};

fetch('https://api.teachwithscout.com/v1/attendance/daily/bulk', 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/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'studentId' => '<string>',
        'date' => '<string>',
        'attendanceCode' => '<string>',
        'arrivalTime' => '<string>',
        'comment' => '<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://api.teachwithscout.com/v1/attendance/daily/bulk"

	payload := strings.NewReader("[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]")

	req, _ := http.NewRequest("POST", 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.post("https://api.teachwithscout.com/v1/attendance/daily/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teachwithscout.com/v1/attendance/daily/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"studentId\": \"<string>\",\n    \"date\": \"<string>\",\n    \"attendanceCode\": \"<string>\",\n    \"arrivalTime\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "summary": {
    "recorded": 123,
    "updated": 123,
    "duplicate": 123,
    "failed": 123
  },
  "results": [
    {
      "index": 123,
      "status": "recorded",
      "studentId": "<string>",
      "date": "<string>",
      "scoutStudentId": "<string>",
      "mappedStatus": "Absent",
      "error": {
        "status": 123,
        "code": "<string>",
        "message": "<string>"
      }
    }
  ]
}

{
  "summary": {
    "recorded": 123,
    "updated": 123,
    "duplicate": 123,
    "failed": 123
  },
  "results": [
    {
      "index": 123,
      "status": "recorded",
      "studentId": "<string>",
      "date": "<string>",
      "scoutStudentId": "<string>",
      "mappedStatus": "Absent",
      "error": {
        "status": 123,
        "code": "<string>",
        "message": "<string>"
      }
    }
  ]
}

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

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

Get started

Endpoints

Record daily attendance for many students

Authorizations

Body

Response