API Schema Reference

Overview

This reference topic documents the security schemes and schemas used in the API for generating educational measurement graphs.

bearerAuth

Defines the authentication scheme using a bearer token.

Example:

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT"
}
            

targetRange

Defines a range of measures with minimum and maximum values and a label.

{ "value": 1500 }

{ "value": 1300 }

Example:

{
  "max": { "value": 1500 },
  "min": { "value": 1300 },
  "label": "More Difficult Target"
}
            

targetRangesResponse

Defines an object of target ranges corresponding to request targetRanges.

Example:

{
  "harderRange": {
    "max": { "value": 1500 },
    "min": { "value": 1300 },
    "label": "More Difficult Target"
  },
  "easierRange": {
    "max": { "value": 1300 },
    "min": { "value": 1100 },
    "label": "Less Difficult Target"
  }
}
            

additionalOptionsTargetRangesResponse

Defines target ranges corresponding to additionalOptions.

Example:

{
  "communityCollegeReadinessRange": {
    "max": { "value": 1370 },
    "min": { "value": 1200 },
    "label": "Community College Readiness Range"
  },
  "universityReadinessRange": {
    "max": { "value": 1480 },
    "min": { "value": 1300 },
    "label": "University Readiness Range"
  }
}
            

finalMeasures

Defines estimated and target measures.

{ "value": 1000, "display": "1000L" }

{ "value": 1200, "display": "1200L" }

Example:

{
  "estimate": { "value": 1000, "display": "1000L" },
  "target": { "value": 1200, "display": "1200L" }
}
            

measureDisplayAndValue

Defines a measure with value and display string.

Example:

{
  "value": -100,
  "display": "BR100L"
}
            

additionalOptions

Defines an array of configuration options for graph rendering, dependent on scale.

Example:

[
  "recommendedGrowthPath",
  "universityReadinessRange"
]
            

graphSize

Specifies the size of the rendered graph image.

Example:

"desktop"

language

Specifies the language for graph labels.

Example:

"english"

scale

Specifies the measurement framework.

Example:

"lexile"

chart

Defines base64-encoded SVG image data.

Example:

"string placeholder for brevity of base64-encoded chart."

lexileMeasure

Defines a numeric measure for the Lexile framework.

Example:

1000

quantileMeasure

Defines a numeric measure for the Quantile framework.

Example:

1000

measures

Defines an array of student observations.

Example:

[
  {
    "testDate": { "month": 5, "year": 2023 },
    "schoolYearStart": { "month": 8, "year": 2022 },
    "grade": 5,
    "measure": 1000
  }
]
            

measureField

Defines an integer measure based on scale.

Example:

1000

dateField

Defines a date object with month and year.

Example:

{
  "month": 5,
  "year": 2023
}
            

serverError

Defines a server-side error response.

[{ "code": "error", "detail": "A server error occurred.", "attr": null }]

clientError

Defines a client-side error response.

[{ "code": "not_authenticated", "detail": "Authentication credentials were 
not provided.", "attr": null }]

validationError

Defines a validation error response.

[{ "code": "required", "detail": "Scale is required", "attr": "scale" }]

codes

Defines an array of codes indicating graph generation and range alignment.

Example:

[
  "withinWRR"
]
            

authToken

Defines authentication credentials.

Example:

{
  "clientId": "abcdefg",
  "clientSecret": "hijklmnopqrstuvwxyz"
}