Skip to main content

[API Endpoint] Summatives

Samantha L Cook
Updated 
https://teachboost.com/api/v1/summatives
  • 15 requests are allowed every 60 seconds.

Options

  • offset: Integer, default is 0
    • You can filter results by setting a starting point using this "offset" option; for instance, to return "only summatives after the 1000th form"
      Default is 0
      Format: --data "offset=1000"
  • limit: Integer,
    • Set the total number of forms to return using the "limit" option; for instance, to return only the first 10 summatives
    • Default and max is 50
    • Format: --data "limit=50"
  • start_date: DateTime
  • end_date: DateTime
  • profile_id: Integer *REQUIRED*
    • Limit the result set to only summatives from a specific profile ID (integer -- see document on Summative Profiles) 
    • Format: --data "profile_id=133"
  • time_period: integer, e.g. "2020"

Sample Object

{
  "id": 14410,
  "group_id": 10,
  "user_id": 67990,
  "profile_id": 61,
  "period": "2020",
  "score": null,
  "score_label": null,
  "is_complete": false,
  "is_released": false,
  "completed_on": null,
  "released_on": null,
  "last_modified": "2020-11-30 16:31:29",
  "created_on": "2020-11-30 16:31:29",
  "inputs": {
    "0-0": 1.88
  },
  "intro": "",
  "profile_name": "Non-Tenured Teacher Summative Assessment",
  "buckets": [
    {
      "id": "0",
      "name": "Student Test Results",
      "weight": "100.000",
      "form_types": [],
      "rows": [
        {
          "id": "0",
          "type": "user_input",
          "label": "End of year score results",
          "weight": "100.000",
          "rating_id": null,
          "competency_id": null,
          "data": [
            1.88
          ],
          "records": [],
          "score": 1.88,
          "score_label": "",
          "total_weight": 1,
          "total_score": 1.88,
          "real_weight": 1,
          "real_score": 1.88
        }
      ],
      "score": 1.88,
      "completion": 1,
      "total_score": 1.88,
      "total_weight": 1
    }
  ],
  "computed_score": 1.88,
  "computed_score_label": "Rating 2",
  "signatures": [
        {
          "user_id": "10000",
          "name": "Michael V. Gioia",
          "signed_on": "2021-12-22 14:34:57"
        }
      ],
      "signature_count": 1
}

Dictionary

  • id: Integer, internal ID of the Object
  • group_id: Integer, ID of Group this Summative was created within
  • user_id: Integer, internal ID of the topic of the Summative
  • profile_id: Integer, internal ID of the Summative Profile this Object was created on
  • period: Integer, school year created
  • is_complete: Bool, whether the summative has been completed
  • is_released: Bool, whether the summative has been shared with topic
  • computed_score: Integer, final calculated summative score of all buckets
  • computed_score_label: String, corresponding rating label for final computed score
  • signatures
    • user_id: Integer, internal ID of user who has signed the summative
    • name: String, full name of user who has signed summative
    • signed_on: DateTime, when user signed summative
    • signature_count: Integer, count of user signatures applied to the summative

Related articles