Skip to main content

[API Endpoint] Frameworks

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

Options

None, all Frameworks are always returned.

Sample Object

{
    id: 1200,
    name: 'NYC Framework',
    bounds: [
        {
            min: 1,
            max: 1.8,
            precision: 1
        }, {
            min: 1.8,
            max: 2.6,
            precision: 1
        }, {
            min: 2.6,
            max: 3.4,
            precision: 1
        }, {
            min: 3.4,
            max: 4,
            precision: 1
        }
    ],
    scale: {
        '1': 'Ineffective',
        '2': 'Developing',
        '3': 'Effective',
        '4': 'Highly Effective'
    }
}

Dictionary

  • id: Integer, internal ID for the object
  • name: String, name of the Framework
  • bounds: Array of Objects, optional, contains the bounding values for scores. If the score value falls between the min or max, then the associated scale label and value will be used. This offers a way of customizing the range than an average score will fall into.
  • scale: Object, contains a mapping of score value and label. In this scale, there is a score (or rating) of 1 with the label 'Ineffective'. Note that some scales have no score.

Related articles