Skip to main content

[API Endpoint] Framework

Samantha L Cook
Updated 
https://teachboost.com/api/v1/framework/{ID}
  • ID: Integer, required, the ID of the Framework.
  • 10 requests are allowed every 60 seconds.

Options

None, all Framework data is always returned.

Sample Object

N.B. This response does not return an items field. Instead, the Framework data is returned in the response under the field framework.

{
    id: 1200,
    name: 'NYC Framework',
    description: '8 city-wide components',
    competencies: {
        '380-1': {
            id: '380-1',
            code: '1',
            name: 'Planning and Preparation',
            parent: null
        },
        '380-1.1': {
            id: '380-1.1',
            code: '1a',
            name: 'Knowledge of Content and Pedagogy',
            parent: '380-1'
        }
        ...
    ],
    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
  • description: String, descripton of the Framework
  • competencies: Object of Objects
    • id: String, internal ID for the Competency
    • code: String, localized display code
    • name: String, name of the Competency
    • parent: String, reference the internal ID of the parent Competency, NULL if there is no parent
  • 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 that an average score will fall into.
  • scale: Object, contains a mapping of score value and label. In the example scale above, there is a score (or rating) of 1 that has the label 'Ineffective'. Note that some scales do not have scores.

Related articles