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

Below is an example showing assessment data for a third-grade reading level assessment from the 2012-2013 academic year.

Details:

Note that, on line 8, the assessment was revised as recently as 2020, although it was created for the 2012-2013 academic year.
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 assessmentTitle on line 4. 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).
Although the test is a reading comprehension exam, its language code is still enumerated on line 31 – assessment language coding is independent of the type of test it is and instead refers to the language in which it is administered to students.

assessment, for a POST

{
    "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 Assessment Item POST

The Assessment Item entity represents one of many single measures that make up an assessment.

Details:

Note that assessment items are intrinsically tied to assessment entities and are not independent. They refer to their parent assessment entities and can refer to other Item or Objective POST entities.
Assessment Item POSTs are optional and are not a required element. Instead, they can be added to supplement mapping for LearningStandards entities.

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"
			}
		}
    ] 
}

Example Objective Assessment POST

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

Details:

Like assessmentItems, objectiveAssessment entities are subsets of assessments and are not standalone, instead referring to their parent entities and related Objective and Item entities. Similarly, they are an optional element to include if necessary.
However, objectiveAssessment entities are broader in scope than assessmentItems, in that they can include large sections (which may include multiple Items) of an Assessment that deal with a specific learning objective.

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"
      }
    ]  
}

Standard home:

Ed-Fi Assessment Outcomes API for Suite 3

Standard content:

This page: