Ed-Fi Assessment Outcomes API for Suite 3 - Example Data

This section contains example data for many of the key operations. Guidance is non-normative, for informational and illustrative purposes. Examples are created using a fictional Grand Bend ISD.

Example POST Data

This section provides examples of data sent from the API client to an API host.

Example Assessment POST

The Assessment entity represents a tool, instrument, process, or exhibition composed of a systematic sampling for measuring a student's competence, knowledge, skills, or behavior. An assessment can be used to measure differences in individuals or groups and changes in performance from one occasion to the next. Below is an example showing assessment data for a third-grade reading level assessment.

Details:

Note the academicSubjectDescriptor element on line 14. The Academic Subject Descriptor is one of the descriptors in this standard that must adhere to the default Ed-Fi values. Accordingly, the value is one of the Ed-Fi descriptor values, and illustrates the typical pattern for Ed-Fi descriptors.
Contrast this with performanceLevelDescriptor element on line 36 (and others). This element also requires the client system use a specific set of values, but this value set is typically maintained by the host system (in this example, the fictional Grand Bend ISD).

assessment

{
    "assessmentIdentifier": "01774fa3-06f1-47fe-8801-c8b1e65057f2",
    "namespace": "uri://grandbend.edu/",
    "assessmentCategoryDescriptor": "uri://ed-fi.org/AssessmentCategoryDescriptor#Benchmark test",
    "assessmentTitle": "3rd Grade Reading 1st Six Weeks 2012-2013",
    "assessmentVersion": 2020,
    "maxRawScore": 10.5,
    "revisionDate": "2020-09-19",
    "contentStandard": {
      "title": "State Essential Knowledge and Skills"
    },
    "academicSubjects": [
      {
        "academicSubjectDescriptor": "uri://ed-fi.org/AcademicSubjectDescriptor#English Language Arts"
      }
    ],
    "assessedGradeLevels": [
      {
        "gradeLevelDescriptor": "uri://ed-fi.org/GradeLevelDescriptor#Third grade"
      }
    ],
    "identificationCodes": [
      {
        "assessmentIdentificationSystemDescriptor": "uri://grandbend.edu/AssessmentIdentificationSystemDescriptor#TestWhiz",
        "identificationCode": "01774fa3-06f1-47fe-8801-c8b1e65057f2"
      }
    ],
    "languages": [
      {
        "languageDescriptor": "uri://ed-fi.org/LanguageDescriptor#eng"
      }
    ],
    "performanceLevels": [
         {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Mastery",
            "maximumScore": "8.0",
            "minimumScore": "5.5",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
         },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Some Mastery",
            "maximumScore": "5.5",
            "minimumScore": "1.5",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
        },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#No Mastery",
            "maximumScore": "1.5",
            "minimumScore": "0",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
      }
    ],
    "scores": [
      {
        "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
        "maximumScore": "10",
        "minimumScore": "0",
        "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Integer"
      }
    ]
  },

Example Objective Assessment POST

The Objective Assessment entity represents subtests that assess specific learning objectives.

Details:

Note that Objective Assessment entities require a reference to the Assessment entity to which the objective assessment belongs. The identifier may be a unique number or, as in line 3 of this example, a unique alphanumeric code.
Objective Assessment entities often contain references to Assessment Item entities that test the learning objectives represented by the entity (i.e., the individual test items making up the subtest). In this example, a collection of references to Assessment Item entities begins on line 10.
Objective Assessment entities may contain references to learning standards evaluated by the subtest. In line 27 of this example, a collection containing one learning standard is referenced. Worth noting is that Assessment Items may also reference learning standards. This means that that standard allows for an Objective Assessment to infer its associated Learning Standards from the collection of referenced Assessment Item entities. But, if a learning standard is present on the Objective Assessment, it should be understood as the relevant value such as when the Objective Assessment learning standard is a higher-level, general expression of more specific standards on the Assessment Items.

objectiveAssessment

{
    "assessmentReference": {
      "assessmentIdentifier": "MP-2013-Mathematics-Seventh grade",
      "namespace": "uri://grandbend.edu"
    },
    "identificationCode": "Seventh grade Mathematics-37",
    "academicSubjectDescriptor": "uri://ed-fi.org/AcademicSubjectDescriptor#Mathematics",
    "maxRawScore": 3,
    "percentOfAssessment": 0.1176,
    "assessmentItems": [
      {
        "assessmentItemReference": {
          "identificationCode": "DBRDY_18_7_1418"
        }
      },
      {
        "assessmentItemReference": {
          "identificationCode": "DBRDY_18_7_1419"
        }
      },
      {
        "assessmentItemReference": {
          "identificationCode": "DBRDY_18_7_1420"
        }
      }
    ],
    "learningStandards": [
    {
        "learningStandardReference": {
            "learningStandardId": "CC.5.NF.1"
        }
    }
    ],
    "performanceLevels": [
         {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Mastery",
            "maximumScore": "3",
            "minimumScore": "3",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
         },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Some Mastery",
            "maximumScore": "2",
            "minimumScore": "1",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
        },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#No Mastery",
            "maximumScore": "0",
            "minimumScore": "0",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
      }
    ],
    "scores": [
      {
        "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
        "maximumScore": "3",
        "minimumScore": "0",
        "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
      }
    ]  
}

Example Assessment Item POST

The Assessment Item entity represents one of many single measures that make up an assessment (i.e., the individual items on a test, quiz, or other type of assessment instrument).

Details:

Note that Assessment Item entities require a reference to the Assessment entity to which the objective assessment belongs. The identifier may be a unique number or, as in line 3 of this example, a unique alphanumeric code.

assessmentItem

{
	"assessmentReference": {
		"assessmentIdentifier": "MP-2013-Mathematics-Seventh grade",
		"namespace": "uri://grandbend.edu"
	},
	"identificationCode": "DBRDY_18_7_1435",
	"assessmentItemCategoryDescriptor": "uri://ed-fi.org/AssessmentItemCategoryDescriptor#Short answer",
	"itemText": "Solve 2 1/2 + 1 1/6",
	"maxRawScore": 1,
	"learningStandards": [
		{
		"learningStandardReference": {
		"learningStandardId": "CC.5.NF.1"
			}
		}
    ] 
}

Standard home:

Ed-Fi Assessment Outcomes API for Suite 3

Standard content:

This page: