Best Practices

The most efficient data retrieval is to pull all the data for a district with the following seven calls:

/orgs?limit=1000000
/users?limit=1000000
/demographics?limit=1000000
/courses?limit=1000000
/classes?limit=1000000
/enrollments?limit=1000000
/academicSessions?limit=1000000

NOTE: For a large district this will return very large files.

You can first find out how many records will be return for each call by passing limit=0 and examining the returned header "X-Total-Count".

curl https://oneroster-api.triand.com/ims/oneroster/rostering/v1p2/users?limit=0 \
  -H 'Accept: application/json' \
  -D headers.txt \
  -H "Authorization: Bearer {{token from OAuthd2}}"

// Response: 
{"users":[]}

// Contents of headers.txt
HTTP/2 200 
date: Mon, 14 Mar 2022 08:48:55 GMT
content-type: application/json
content-length: 12
x-total-count: 4308
apigw-requestid: O90qbi22vHcESpA=