Versions Compared

Old Version 9

changes.mady.by.user Ian Christopher

Saved on

compared with

New Version 10

changes.mady.by.user Ian Christopher

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Item POST

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

Details:

Note the assessmentItemCategoryDescriptor element on line 7. The Assessment Item Category

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 assessmentIdentifier assessmentTitle on line 34. 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). Note the companion namespace on line 4 
  • 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. 


Code Block
languagejs
themeRDark
titleassessmentItemassessment, for a POST
linenumberstrue
{
	"assessmentReference": {
		    "assessmentIdentifier": "MP01774fa3-06f1-201347fe-Mathematics8801-Seventh gradec8b1e65057f2",
    		"namespace": "uri://grandbend.edu/",
	},
	"identificationCode": "DBRDY_18_7_1435",
	"assessmentItemCategoryDescriptor    "assessmentCategoryDescriptor": "uri://ed-fi.org/AssessmentItemCategoryDescriptor#ShortAssessmentCategoryDescriptor#Benchmark answertest",
  	  "itemTextassessmentTitle": "Solve3rd Grade 2Reading 1/21st +Six 1 1/6Weeks 2012-2013",
	"maxRawScore    "assessmentVersion": 12020,
	"learningStandards": [ 		{ 		"learningStandardReference": { 		"learningStandardIdmaxRawScore": "CC10.5.NF.1"
			}
		},
      ] 
}

Example Objective Assessment POST

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

Details:

  • Excellent point one...
  • Excellent point two...
  • Were you aware point three...
Code Block
languagejs
themeRDark
titleobjectiveAssessment
linenumberstrue
{"revisionDate": "2020-09-19",
    "assessmentReferencecontentStandard": {
      "assessmentIdentifiertitle": "MP-2013-Mathematics-Seventh grade",
 State Essential Knowledge and Skills"
    },
    "namespaceacademicSubjects": "uri://grandbend.edu"[
    },  {
  "identificationCode": "Seventh grade Mathematics-37",     "academicSubjectDescriptor": "uri://ed-fi.org/AcademicSubjectDescriptor#MathematicsAcademicSubjectDescriptor#English Language Arts",
    "maxRawScore": 3, }
   "percentOfAssessment": 0.1176 ],
    "assessmentItemsassessedGradeLevels": [
      {
        "assessmentItemReferencegradeLevelDescriptor": {           "identificationCode": "DBRDY_18_7_1418"uri://ed-fi.org/GradeLevelDescriptor#Third grade"
        }
      }],
    "identificationCodes": [
{         "assessmentItemReference": {
          "identificationCodeassessmentIdentificationSystemDescriptor": "DBRDY_18_7_1419"
        }
      },
      {
        "assessmentItemReference": {uri://grandbend.edu/AssessmentIdentificationSystemDescriptor#TestWhiz",
           "identificationCode": "DBRDY_18_7_1420"
        }01774fa3-06f1-47fe-8801-c8b1e65057f2"
       }
    ],
    "learningStandardslanguages": [

   {         "learningStandardReference": {
            "learningStandardIdlanguageDescriptor": "CC.5.NF.1"
        }uri://ed-fi.org/LanguageDescriptor#eng"
      }
    ],
    "performanceLevels": [
         {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Mastery",
            "maximumScore": "38.0",
            "minimumScore": "35.5",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
         },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Some Mastery",
            "maximumScore": "25.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": "01.5",
            "minimumScore": "0",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
      }
    ],
    "scores": [
      {
        "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
        "maximumScore": "310",
        "minimumScore": "0",
        "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#DecimalResultDatatypeTypeDescriptor#Integer"
      }
    ]
  },

Example

Objective

Assessment Item POST

Below is an example of an idealized example objective assessment for a recently revised third-grade reading level assessment from the 2012-2013 academic year. 

Details:

  • Excellent point one...
  • Excellent point two...
  • Were you aware point three...

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. 


Code Block
languagejs
themeRDark
titleassessment, for a POSTassessmentItem
linenumberstrue
{
	"assessmentReference": {
  		"assessmentIdentifier": "01774fa3MP-06f12013-47fe-8801-c8b1e65057f2Mathematics-Seventh grade",
    		"namespace": "uri://grandbend.edu/"
	},
	"identificationCode":    "assessmentCategoryDescriptor"DBRDY_18_7_1435",
	"assessmentItemCategoryDescriptor": "uri://ed-fi.org/AssessmentCategoryDescriptor#BenchmarkAssessmentItemCategoryDescriptor#Short testanswer",
    "assessmentTitle	"itemText": "3rdSolve Grade2 Reading1/2 1st+ Six Weeks 2012-20131 1/6",
	"maxRawScore": 1,
  	"assessmentVersionlearningStandards": 2020,[
		{
		"learningStandardReference": {
 		"maxRawScorelearningStandardId": 10"CC.5,.NF.1"
			}
		}
      "revisionDate": "2020-09-19",] 
}

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. 


Code Block
languagejs
themeRDark
titleobjectiveAssessment
linenumberstrue
{
    "contentStandardassessmentReference": {
      "titleassessmentIdentifier": "State Essential Knowledge and Skills"
MP-2013-Mathematics-Seventh grade",
   },     "academicSubjectsnamespace": ["uri://grandbend.edu"
    },
 {   "identificationCode": "Seventh grade Mathematics-37",
    "academicSubjectDescriptor": "uri://ed-fi.org/AcademicSubjectDescriptor#English Language ArtsAcademicSubjectDescriptor#Mathematics",
    "maxRawScore": 3,
}     ]"percentOfAssessment": 0.1176,
    "assessedGradeLevelsassessmentItems": [
      {
        "gradeLevelDescriptorassessmentItemReference": {
 "uri://ed-fi.org/GradeLevelDescriptor#Third grade         "identificationCode": "DBRDY_18_7_1418"
        }
      ],},
      {
        "identificationCodes": [assessmentItemReference": {
          "identificationCode": "DBRDY_18_7_1419"
        }
      },
      {
        "assessmentIdentificationSystemDescriptorassessmentItemReference": "uri://grandbend.edu/AssessmentIdentificationSystemDescriptor#TestWhiz", {
          "identificationCode": "01774fa3-06f1-47fe-8801-c8b1e65057f2"DBRDY_18_7_1420"
        }
      }
    ],
    "languageslearningStandards": [
    {
        "learningStandardReference": {
            "languageDescriptorlearningStandardId": "uri://ed-fi.org/LanguageDescriptor#eng"
 CC.5.NF.1"
        }
    }
    ],
    "performanceLevels": [
         {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Mastery",
            "maximumScore": "8.03",
            "minimumScore": "5.53",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
         },
        {
            "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
            "performanceLevelDescriptor": "uri://grandbend.edu/PerformanceLevelDescriptor#Some Mastery",
            "maximumScore": "5.52",
            "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.50",
            "minimumScore": "0",
            "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#Decimal"
      }
    ],
    "scores": [
      {
        "assessmentReportingMethodDescriptor": "uri://ed-fi.org/AssessmentReportingMethodDescriptor#Raw score",
        "maximumScore": "103",
        "minimumScore": "0",
        "resultDatatypeTypeDescriptor": "uri://ed-fi.org/ResultDatatypeTypeDescriptor#IntegerResultDatatypeTypeDescriptor#Decimal"
      }
    ]  
},


Standard home:

Include Page
_Sidebar-AssessOutS3API
_Sidebar-AssessOutS3API

This page:

Table of Contents