This page contains the full OpenAPI spec listing for the proposed Ed-Fi RFC 2 - Assessment Data Collection API.
Change History
- June 7, 2016: Initial Draft
- Ed-Fi Assessment Data Collection API v2.0.json
{
"swagger": "2.0",
"info": {
"title": "Ed-Fi Assessment Data Collection API",
"version": "2.0"
},
"basePath": "/v2.0",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/assessments": {
"get": {
"description": "Gets a resource using its natural key. Semantics: - If all natural key fields are provided, a single resource should be returned, or no resource if a match is not found. - If no natural key fields are provided, all resources are returned. - If one or more natural key field is provided AND not all key fields are required, then the resources returned are filtered to those that have field values that match those provided.",
"operationId": "assessment_getByPrimaryKey",
"parameters": [
{
"name": "title",
"in": "query",
"description": "The title or name of the assessment. NEDM- Assessment Title",
"required": false,
"type": "string"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example- Adult Prekindergarten First grade Second grade, etc.",
"required": false,
"type": "string"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM- Assessment Content, Academic Subject",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"description": "The version identifier for the assessment.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Resource retrieved",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
},
"post": {
"summary": "Creates or updates a resource.",
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource identifier in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the key values provided, and update or create the resource appropriately.",
"operationId": "assessment_post",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"description": "An assessment resource",
"schema": {
"$ref": "#/definitions/assessment"
}
}
],
"responses": {
"201": {
"description": "Resource created"
}
}
},
"delete": {
"summary": "Delete a assessment using its natural key.",
"operationId": "assessment_deleteByPrimaryKey",
"parameters": [
{
"name": "title",
"in": "query",
"description": "The title or name of the assessment. NEDM- Assessment Title",
"required": true,
"type": "string"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example- Adult Prekindergarten First grade Second grade, etc.",
"required": true,
"type": "string"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM- Assessment Content, Academic Subject",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"description": "The version identifier for the assessment.",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "Resource deleted"
}
}
}
},
"/assessments/{id}": {
"get": {
"summary": "Retrieves a resource by the specified resource identifier.",
"operationId": "assessment_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A resource identifier specifying the resource to be updated.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource retrieved",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
},
"put": {
"summary": "Update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation.",
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource identifier is provided in the JSON body, it will be ignored as well.",
"operationId": "assessment_put",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A resource identifier specifying the resource to be updated.",
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"description": "An assessment resource",
"schema": {
"$ref": "#/definitions/assessment"
}
}
],
"responses": {
"204": {
"description": "Resource updated"
}
}
},
"delete": {
"summary": "Delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "assessment_delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A resource identifier specifying the resource to be deleted.",
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource deleted"
}
}
}
},
"/studentAssessments": {
"get": {
"description": "Gets a resource using its natural key. Semantics: - If all natural key fields are provided, a single resource should be returned, or no resource if a match is not found. - If no natural key fields are provided, all resources are returned. - If one or more natural key field is provided AND not all key fields are required, then the resources returned are filtered to those that have field values that match those provided.",
"operationId": "getStudentAssessmentByKey_",
"parameters": [
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique alpha-numeric code assigned to a student."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"required": false,
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"required": false,
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "administrationDate",
"in": "query",
"required": false,
"type": "string",
"format": "date",
"description": "The month(s), day(s), and year on which an assessment is administered or first day of administration if over multiple days."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"$ref": "#/definitions/studentAssessment"
}
}
}
},
"post": {
"summary": "Creates or updates a resource.",
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource identifier in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the key values provided, and update or create the resource appropriately.",
"operationId": "postStudentAssessments_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"x-is-map": false,
"description": "The JSON representation of the \"studentAssessment\" resource to be created or updated.",
"schema": {
"$ref": "#/definitions/studentAssessment"
}
}
],
"responses": {
"200": {
"description": "The resource was created. "
}
}
},
"delete": {
"description": "Deleted a specific resource using the values of the resource's natural key.",
"operationId": "deleteStudentAssessmentByKey_",
"parameters": [
{
"name": "studentUniqueId",
"in": "query",
"required": true,
"type": "string",
"description": "A unique alpha-numeric code assigned to a student."
},
{
"name": "assessmentTitle",
"in": "query",
"required": true,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"required": true,
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"required": true,
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
{
"name": "version",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "administrationDate",
"in": "query",
"required": true,
"type": "string",
"format": "date",
"description": "The month(s), day(s), and year on which an assessment is administered or first day of administration if over multiple days."
}
],
"responses": {
"204": {
"description": "The resource was successfully deleted."
}
}
}
},
"/studentAssessments/{id}": {
"get": {
"description": "Retrieves a specific resource using the resource identifier.",
"operationId": "getStudentAssessmentsById_",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "A resource identifier specifying the resource to be retrieved."
}
],
"responses": {
"200": {
"description": "The resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/studentAssessment"
}
}
}
},
"put": {
"summary": "Update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation.",
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource identifier is provided in the JSON body, it will be ignored as well.",
"operationId": "putStudentAssessment_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "A resource identifier specifying the resource to be updated."
},
{
"name": "body",
"in": "body",
"required": true,
"description": "An assessment resource",
"schema": {
"$ref": "#/definitions/studentAssessment"
}
}
],
"responses": {
"201": {
"description": "The resource was created. "
}
}
},
"delete": {
"description": "Deletes an existing resource using the resource identifier.",
"operationId": "deleteStudentAssessmentById_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "A resource identifier specifying the resource to be deleted."
}
],
"responses": {
"204": {
"description": "The resource was successfully deleted."
}
}
}
},
"/objectiveAssessments": {
"get": {
"operationId": "getObjectiveAssessmentByKey",
"description": "Gets a resource using its natural key. Semantics: - If all natural key fields are provided, a single resource should be returned, or no resource if a match is not found. - If no natural key fields are provided, all resources are returned. - If one or more natural key field is provided AND not all key fields are required, then the resources returned are filtered to those that have field values that match those provided.",
"parameters": [
{
"in": "query",
"name": "assessmentTitle",
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title",
"required": false
},
{
"in": "query",
"name": "academicSubjectDescriptor",
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject",
"required": false
},
{
"in": "query",
"name": "assessedGradeLevelDescriptor",
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ...",
"required": false
},
{
"in": "query",
"name": "version",
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version",
"required": false
},
{
"in": "query",
"name": "identificationCode",
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.",
"required": false
}
],
"responses": {
"200": {
"description": "Resource retrieved",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/objectiveAssessment"
}
}
}
}
},
"post": {
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postObjectiveAssessment_",
"parameters": [
{
"in": "body",
"name": "objectiveAssessment",
"description": "The JSON representation of the objectiveAssessment resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/objectiveAssessment"
}
}
],
"responses": {
"201": {
"description": "Resource created"
}
}
},
"delete": {
"operationId": "deleteObjectiveAssessmentByKey",
"summary": "Delete an objectiveAssessment using its natural key.",
"parameters": [
{
"in": "query",
"name": "assessmentTitle",
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title",
"required": true
},
{
"in": "query",
"name": "academicSubjectDescriptor",
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject",
"required": true
},
{
"in": "query",
"name": "assessedGradeLevelDescriptor",
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ...",
"required": true
},
{
"in": "query",
"name": "version",
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version",
"required": true
},
{
"in": "query",
"name": "identificationCode",
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity.",
"required": true
}
],
"responses": {
"204": {
"description": "Resource deleted"
}
}
}
},
"/objectiveAssessments/{id}": {
"get": {
"operationId": "getObjectiveAssessmentsById",
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"parameters": [
{
"in": "path",
"name": "id",
"description": "A resource identifier specifying the resource to be retrieved.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource retrieved",
"schema": {
"type": "object",
"$ref": "#/definitions/objectiveAssessment"
}
}
}
},
"put": {
"operationId": "putObjectiveAssessment",
"summary": "Updates or creates a resource based on the resource identifier.",
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"parameters": [
{
"in": "path",
"name": "id",
"description": "A resource identifier specifying the resource to be updated.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"description": "An objectiveAssessment resource",
"schema": {
"$ref": "#/definitions/objectiveAssessment"
}
}
],
"responses": {
"204": {
"description": "Resource updated"
}
}
},
"delete": {
"operationId": "deleteObjectiveAssessmentById",
"summary": "Deletes an existing resource using the resource identifier.",
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"parameters": [
{
"in": "path",
"name": "id",
"description": "A resource identifier specifying the resource to be deleted.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource deleted"
}
}
}
},
"/assessmentItems": {
"get": {
"description": "Gets a resource using its natural key. Semantics: - If all natural key fields are provided, a single resource should be returned, or no resource if a match is not found. - If no natural key fields are provided, all resources are returned. - If one or more natural key field is provided AND not all key fields are required, then the resources returned are filtered to those that have field values that match those provided.",
"operationId": "assessment_getByPrimaryKey",
"produces": [
"application/json"
],
"parameters": [
{
"name": "assessmentTitle",
"in": "query",
"type": "string",
"required": false,
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"type": "string",
"required": false,
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"type": "string",
"required": false,
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
{
"name": "version",
"in": "query",
"type": "integer",
"required": false,
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "identificationCode",
"in": "query",
"type": "string",
"required": false,
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/assessmentItem"
}
}
}
},
"post": {
"description": "Creates or updates resources based on the natural key values of the supplied resource.",
"operationId": "postAssessmentItems_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "assessmentItem",
"in": "body",
"required": true,
"description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.",
"schema": {
"$ref": "#/definitions/assessmentItem"
}
}
],
"responses": {
"201": {
"description": ""
}
}
},
"delete": {
"summary": "Delete a assessmentItem using its natural key.",
"operationId": "assessmentItem_deleteByPrimaryKey",
"parameters": [
{
"name": "assessmentTitle",
"in": "query",
"description": "The title or name of the assessment. NEDM- Assessment Title",
"required": true,
"type": "string"
},
{
"name": "assessedGradeLevelDescriptor",
"in": "query",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example- Adult Prekindergarten First grade Second grade, etc.",
"required": true,
"type": "string"
},
{
"name": "academicSubjectDescriptor",
"in": "query",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM- Assessment Content, Academic Subject",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"description": "The version identifier for the assessment.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "identificationCode",
"in": "query",
"type": "string",
"required": true,
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
}
],
"responses": {
"204": {
"description": "Resource deleted"
}
}
}
},
"/assessmentItems/{id}": {
"get": {
"description": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"operationId": "getAssessmentItemsById_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true,
"description": "A resource identifier specifying the resource to be retrieved."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/assessmentItem"
}
}
}
},
"put": {
"description": "Updates or creates a resource based on the resource identifier.",
"operationId": "putAssessmentItem_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true,
"description": "A resource identifier specifying the resource to be updated."
},
{
"name": "assessmentItem",
"in": "body",
"required": true,
"description": "The JSON representation of the \"assessmentItem\" resource to be updated.",
"schema": {
"$ref": "#/definitions/assessmentItem"
}
}
],
"responses": {
"204": {
"description": ""
}
}
},
"delete": {
"description": "Deletes an existing resource using the resource identifier.",
"operationId": "deleteAssessmentItemById_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true,
"description": "A resource identifier specifying the resource to be deleted."
}
],
"responses": {
"204": {
"description": ""
}
}
}
}
},
"definitions": {
"assessment": {
"required": [
"id",
"title",
"assessedGradeLevelDescriptor",
"academicSubjectDescriptor",
"version"
],
"properties": {
"id": {
"type": "string",
"description": "The resource ID"
},
"title": {
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
"assessedGradeLevelDescriptor": {
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
"academicSubjectDescriptor": {
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
"version": {
"type": "integer",
"description": "The version identifier for the assessment."
},
"categoryDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"lowestAssessedGradeLevelDescriptor": {
"type": "string",
"description": "If the test assessment spans a range of grades, then this attribute holds the lowest grade assessed. If only one grade level is assessed, then this attribute is omitted. For example: Adult Prekindergarten First grade Second grade ..."
},
"form": {
"type": "string",
"description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc."
},
"revisionDate": {
"type": "string",
"format": "date-time",
"description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially."
},
"maxRawScore": {
"type": "integer",
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum."
},
"nomenclature": {
"type": "string",
"description": "Reflects the common nomenclature for an element."
},
"periodDescriptor": {
"type": "string",
"description": "The ID of the Assessment Period Descriptor"
},
"namespace": {
"type": "string",
"description": "Namespace for the Assessment."
},
"contentStandard": {
"$ref": "#/definitions/assessmentContentStandard"
},
"identificationCodes": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentIdentificationCode" },
"description": "An unordered collection of assessmentIdentificationCodes. A unique number or alphanumeric code assigned to an assessment by a school, school system, a state, or other agency or entity."
},
"languages": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentLanguage" },
"description": "An unordered collection of assessmentLanguages. An indication of the languages in which the Assessment is designed."
},
"performanceLevels": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentPerformanceLevel" },
"description": "An unordered collection of assessmentPerformanceLevels. Definition of the performance levels and the associated cut scores. Three styles are supported: 1. Specification of performance level by minimum and maximum score 2. Specification of performance level by cut score, using only minimum score 3. Specification of performance level without any mapping to scores ."
},
"programs": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentProgram" },
"description": "An unordered collection of assessmentPrograms. The programs associated with the Assessment."
},
"scores": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentScore" },
"description": "An unordered collection of assessmentScores. Definition of the scores to be expected from this assessment."
},
"sections": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentSection" },
"description": "An unordered collection of assessmentSections. The section(s) to which the Assessment is associated."
}
}
},
"assessmentLanguage": {
"required": [
"languageDescriptor"
],
"properties": {
"languageDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
}
},
"assessmentScore": {
"required": [
"assessmentReportingMethodType"
],
"properties": {
"assessmentReportingMethodType": {
"type": "string",
"description": "Key for AssessmentReportingMethod"
},
"minimumScore": {
"type": "string",
"description": "The minimum score possible on the assessment."
},
"maximumScore": {
"type": "string",
"description": "The maximum score possible on the assessment."
},
"resultDatatypeType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
}
},
"assessmentContentStandard": {
"required": [
"title"
],
"properties": {
"mandatingEducationOrganizationReference": {
"$ref": "#/definitions/educationOrganizationReference"
},
"title": {
"type": "string",
"description": "The name of the content standard, for example Common Core."
},
"version": {
"type": "string",
"description": "The version identifier for the content."
},
"uri": {
"type": "string",
"description": "The public web site address (URL), file, or ftp locator."
},
"publicationDate": {
"type": "string",
"format": "date-time",
"description": "The date on which this content was first published."
},
"publicationYear": {
"type": "integer",
"description": "The year at which this content was first published."
},
"publicationStatusType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"beginDate": {
"type": "string",
"format": "date-time",
"description": "The beginning of the period during which this learning standard document is intended for use."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The end of the period during which this learning standard document is intended for use."
},
"authors": {
"type": "array",
"items": { "$ref": "#/definitions/assessmentContentStandardAuthor" },
"description": "An unordered collection of assessmentContentStandardAuthors. The person or organization chiefly responsible for the intellectual content of the standard."
}
}
},
"educationOrganizationReference": {
"required": [
"educationOrganizationId"
],
"properties": {
"educationOrganizationId": {
"type": "integer",
"description": "EducationOrganization Identity Column"
}
}
},
"assessmentContentStandardAuthor": {
"required": [
"author"
],
"properties": {
"author": {
"type": "string",
"description": "The person or organization chiefly responsible for the intellectual content of the standard."
}
}
},
"assessmentIdentificationCode": {
"required": [
"assessmentIdentificationSystemDescriptor",
"identificationCode"
],
"properties": {
"assessmentIdentificationSystemDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"assigningOrganizationIdentificationCode": {
"type": "string",
"description": "The organization code or name assigning the assessment identification code."
},
"identificationCode": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
}
}
},
"assessmentPerformanceLevel": {
"required": [
"performanceLevelDescriptor",
"assessmentReportingMethodType"
],
"properties": {
"performanceLevelDescriptor": {
"type": "string",
"description": "The performance level(s) defined for the assessment."
},
"assessmentReportingMethodType": {
"type": "string",
"description": "Key for AssessmentReportingMethod"
},
"minimumScore": {
"type": "string",
"description": "The minimum score required to make the indicated level of performance."
},
"maximumScore": {
"type": "string",
"description": "The maximum score to make the indicated level of performance."
},
"resultDatatypeType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
}
},
"assessmentSection": {
"required": [
"sectionReference"
],
"properties": {
"sectionReference": {
"$ref": "#/definitions/sectionReference"
}
}
},
"sectionReference": {
"required": [
"schoolId",
"classPeriodName",
"classroomIdentificationCode",
"localCourseCode",
"termDescriptor",
"schoolYear",
"uniqueSectionCode",
"sequenceOfCourse"
],
"properties": {
"schoolId": {
"type": "integer",
"description": "School Identity Column"
},
"classPeriodName": {
"type": "string",
"description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules). NEDM: Class Period"
},
"classroomIdentificationCode": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity."
},
"localCourseCode": {
"type": "string",
"description": "The local code assigned by the LEA or Campus that identifies the organization of subject matter and related learning experiences provided for the instruction of students."
},
"termDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"schoolYear": {
"type": "integer",
"description": "The identifier for the school year."
},
"uniqueSectionCode": {
"type": "string",
"description": "A unique identifier for the Section, that is defined by the classroom, the subjects taught, and the instructors that are assigned."
},
"sequenceOfCourse": {
"type": "integer",
"description": "When a Section is part of a sequence of parts for a course, the number if the sequence. If the course has only one part, the value of this Section attribute should be 1."
}
}
},
"assessmentProgram": {
"required": [
"programReference"
],
"properties": {
"programReference": {
"$ref": "#/definitions/programReference"
}
}
},
"programReference": {
"required": [
"educationOrganizationId",
"type",
"name"
],
"properties": {
"educationOrganizationId": {
"type": "integer",
"format": "int32",
"description": "EducationOrganization Identity Column"
},
"type": {
"type": "string",
"description": "Key for Program"
},
"name": {
"type": "string",
"description": "The formal name of the program of instruction, training, services or benefits available through federal, state, or local agencies."
}
}
},
"studentAssessment": {
"title": "studentAssessment",
"type": "object",
"required": [
"id",
"assessmentReference",
"studentReference",
"administrationDate"
],
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the resource."
},
"assessmentReference": {
"type": "object",
"description": "A reference to the related Assessment resource.",
"$ref": "#/definitions/assessmentReference"
},
"studentReference": {
"type": "object",
"description": "A reference to the related Student resource.",
"$ref": "#/definitions/studentReference"
},
"administrationDate": {
"type": "string",
"format": "date",
"description": "The month(s), day(s), and year on which an assessment is administered or first day of administration if over multiple days."
},
"administrationEndDate": {
"type": "string",
"format": "date",
"description": "Assessment Administration End Date, if administered over multiple days."
},
"serialNumber": {
"type": "string",
"description": "The unique number for the assessment form or answer document."
},
"administrationLanguageDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"administrationEnvironmentType": {
"description": "The environment in which the test was administered. For example: Electronic Classroom Testing Center ... ...."
},
"retestIndicatorType": {
"type": "string",
"description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ..."
},
"reasonNotTestedType": {
"type": "string",
"description": "The primary reason student is not tested. For example: Absent Refusal by parent Refusal by student Medical waiver Illness Disruptive behavior LEP Exempt ..."
},
"whenAssessedGradeLevelDescriptor": {
"type": "string",
"description": "The grade level of a student when assessed."
},
"eventCircumstanceType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"eventDescription": {
"type": "string",
"description": "Describes special events that occur before during or after the assessment session that may impact use of results."
},
"accommodations": {
"description": "An unordered collection of studentAssessmentAccommodations. The specific type of special variation used in how an examination is presented, how it is administered or how the test taker is allowed to respond. This generally refers to changes that do not substantially alter what the examination measures. The proper use of accommodations does not substantially change academic level or performance criteria (e.g., Braille, Enlarged Monitor View, Extra Time, Large Print, Setting, Oral Administration).",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentAccommodation"
}
},
"items": {
"description": "An unordered collection of studentAssessmentItems. This entity represents the student's response to an assessment item and the item-level scores such as correct, incorrect, or met standard.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentItem"
}
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentPerformanceLevels. Indicates the various levels or thresholds for the performance achieved by the student on the assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentPerformanceLevel"
}
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentScoreResults. A meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentScoreResult"
}
},
"studentObjectiveAssessments": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessments. This entity holds the score and or performance levels earned for an objective assessment by a student.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentStudentObjectiveAssessment"
}
}
}
},
"assessmentReference": {
"title": "assessmentReference",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
"assessedGradeLevelDescriptor": {
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
"academicSubjectDescriptor": {
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
"version": {
"type": "integer",
"description": "The version identifier for the assessment."
}
},
"required": [
"title",
"assessedGradeLevelDescriptor",
"academicSubjectDescriptor",
"version"
]
},
"studentReference": {
"title": "studentReference",
"type": "object",
"properties": {
"studentUniqueId": {
"type": "string",
"description": "A unique alpha-numeric code assigned to a student."
}
},
"required": [
"studentUniqueId"
]
},
"studentAssessmentPerformanceLevel": {
"title": "studentAssessmentPerformanceLevel",
"type": "object",
"required": [
"performanceLevelDescriptor"
],
"properties": {
"performanceLevelDescriptor": {
"type": "string",
"description": "The ID of the Performance Level Descriptor"
},
"performanceLevelMet": {
"type": "boolean",
"description": "Optional indicator of whether the performance level was met."
}
}
},
"studentAssessmentAccommodation": {
"title": "studentAssessmentAccommodation",
"type": "object",
"properties": {
"accommodationDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"accommodationDescriptor"
]
},
"studentAssessmentScoreResult": {
"title": "studentAssessmentScoreResult",
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"type": "string",
"description": "The name of the analytic score. For example: Percentile Quantile measure Lexile measure Vertical scale score TPM score ... ..."
},
"result": {
"type": "string",
"description": "A meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc."
},
"resultDatatypeType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"assessmentReportingMethodType",
"result",
"resultDatatypeType"
]
},
"studentAssessmentItem": {
"title": "studentAssessmentItem",
"type": "object",
"properties": {
"assessmentItemReference": {
"type": "object",
"description": "A reference to the related AssessmentItem resource.",
"$ref": "#/definitions/assessmentItemReference"
},
"assessmentResponse": {
"description": "A student's response to a stimulus on a test."
},
"responseIndicatorType": {
"type": "string",
"description": "Indicator of the response. For example: Nonscorable response Ineffective response Effective response Partial response ..."
},
"assessmentItemResultType": {
"type": "string",
"description": "The analyzed result of a student''s response to an assessment item.. For example: Correct Incorrect Met standard ..."
},
"rawScoreResult": {
"type": "integer",
"description": "A meaningful raw score of the performance of an individual on an assessment item."
},
"timeAssessed": {
"type": "string",
"description": "The overall time a student actually spent during the AssessmentItem."
},
"descriptiveFeedback": {
"type": "string",
"description": "The formative descriptive feedback that was given to a learner in response to the results from a scored/evaluated assessment item."
}
},
"required": [
"assessmentItemReference",
"assessmentItemResultType"
]
},
"assessmentItemReference": {
"title": "assessmentItemReference",
"type": "object",
"properties": {
"assessmentTitle": {
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
"academicSubjectDescriptor": {
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
"assessedGradeLevelDescriptor": {
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
"version": {
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
"identificationCode": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
}
},
"required": [
"assessmentTitle",
"academicSubjectDescriptor",
"assessedGradeLevelDescriptor",
"version",
"identificationCode"
]
},
"studentAssessmentStudentObjectiveAssessment": {
"title": "studentAssessmentStudentObjectiveAssessment",
"type": "object",
"properties": {
"objectiveAssessmentReference": {
"type": "object",
"description": "A reference to the related ObjectiveAssessment resource.",
"$ref": "#/definitions/objectiveAssessmentReference"
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentPerformanceLevels. The performance level(s) achieved for the objective assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentStudentObjectiveAssessmentPerformanceLevel"
}
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentScoreResults. A meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessmentStudentObjectiveAssessmentScoreResult"
}
}
},
"required": [
"objectiveAssessmentReference"
]
},
"objectiveAssessmentReference": {
"title": "objectiveAssessmentReference",
"type": "object",
"properties": {
"assessmentTitle": {
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
"academicSubjectDescriptor": {
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment. NEDM: Assessment Content, Academic Subject"
},
"assessedGradeLevelDescriptor": {
"type": "string",
"description": "The typical grade level for which an assessment is designed. If the test assessment spans a range of grades, then this attribute holds the highest grade assessed. If only one grade level is assessed, then only this attribute is used. For example: Adult Prekindergarten First grade Second grade ..."
},
"version": {
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
"identificationCode": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
}
},
"required": [
"assessmentTitle",
"academicSubjectDescriptor",
"assessedGradeLevelDescriptor",
"version",
"identificationCode"
]
},
"studentAssessmentStudentObjectiveAssessmentScoreResult": {
"title": "studentAssessmentStudentObjectiveAssessmentScoreResult",
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"type": "string",
"description": "Key for AssessmentReportingMethod"
},
"result": {
"type": "string",
"description": "The value of a meaningful raw score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc."
},
"resultDatatypeType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"assessmentReportingMethodType",
"result",
"resultDatatypeType"
]
},
"studentAssessmentStudentObjectiveAssessmentPerformanceLevel": {
"title": "studentAssessmentStudentObjectiveAssessmentPerformanceLevel",
"type": "object",
"properties": {
"performanceLevelDescriptor": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"performanceLevelMet": {
"type": "boolean",
"description": "Indicator of whether the student met the designated performance level."
}
},
"required": [
"performanceLevelDescriptor",
"performanceLevelMet"
]
},
"objectiveAssessment": {
"required": [
"id",
"assessmentReference",
"identificationCode"
],
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the resource."
},
"assessmentReference": {
"type": "object",
"$ref": "#/definitions/assessmentReference",
"description": "A reference to the related Assessment resource."
},
"parentObjectiveAssessmentReference": {
"type": "object",
"$ref": "#/definitions/objectiveAssessmentReference",
"description": "A reference to the related ObjectiveAssessment resource."
},
"identificationCode": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
},
"maxRawScore": {
"type": "integer",
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum."
},
"percentOfAssessment": {
"type": "number",
"description": "The percentage of the Assessment that tests this objective."
},
"nomenclature": {
"type": "string",
"description": "Reflects the common nomenclature for an element."
},
"description": {
"type": "string",
"description": "A detailed description of the entity."
},
"assessmentItems": {
"type": "array",
"items": { "$ref": "#/definitions/objectiveAssessmentAssessmentItem" },
"description": "An unordered collection of objectiveAssessmentAssessmentItems. References individual test items, if appropriate."
},
"learningObjectives": {
"type": "array",
"items": { "$ref": "#/definitions/objectiveAssessmentLearningObjective" },
"description": "An unordered collection of objectiveAssessmentLearningObjectives. References the Learning Objective(s) the Objective Assessment tests."
},
"learningStandards": {
"type": "array",
"items": { "$ref": "#/definitions/objectiveAssessmentLearningStandard" },
"description": "An unordered collection of objectiveAssessmentLearningStandards. Learning Standard tested by this objective assessment."
},
"performanceLevels": {
"type": "array",
"items": { "$ref": "#/definitions/objectiveAssessmentPerformanceLevel" },
"description": "An unordered collection of objectiveAssessmentPerformanceLevels. Definition of the performance levels and the associated cut scores. Three styles are supported: 1. Specification of performance level by minimum and maximum score 2. Specification of performance level by cut score, using only minimum score 3. Specification of performance level without any mapping to scores."
}
}
},
"objectiveAssessmentLearningObjective": {
"required": [
"learningObjectiveReference"
],
"properties": {
"learningObjectiveReference": {
"$ref": "#/definitions/learningObjectiveReference"
}
}
},
"learningObjectiveReference": {
"required": [
"objective",
"academicSubjectDescriptor",
"objectiveGradeLevelDescriptor"
],
"properties": {
"objective": {
"type": "string",
"description": "The designated title of the learning objective."
},
"academicSubjectDescriptor": {
"type": "string",
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment."
},
"objectiveGradeLevelDescriptor": {
"type": "string",
"description": "The grade level for which the learning objective is targeted,"
}
}
},
"objectiveAssessmentLearningStandard": {
"required": [
"learningStandardReference"
],
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/learningStandardReference"
}
}
},
"learningStandardReference": {
"required": [
"learningStandardId"
],
"properties": {
"learningStandardId": {
"type": "string",
"description": "A unique number or alphanumeric code assigned to a Learning Standard."
}
}
},
"objectiveAssessmentAssessmentItem": {
"required": [
"assessmentItemReference"
],
"properties": {
"assessmentItemReference": {
"$ref": "#/definitions/assessmentItemReference"
}
}
},
"objectiveAssessmentPerformanceLevel": {
"required": [
"performanceLevelDescriptor",
"assessmentReportingMethodType"
],
"properties": {
"performanceLevelDescriptor": {
"type": "string",
"description": "The ID of the Performance Level Descriptor"
},
"assessmentReportingMethodType": {
"type": "string",
"description": "Key for AssessmentReportingMethod"
},
"minimumScore": {
"type": "string",
"description": "The minimum score required to make the indicated level of performance."
},
"maximumScore": {
"type": "string",
"description": "The maximum score to make the indicated level of performance."
},
"resultDatatypeType": {
"type": "string",
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
}
},
"assessmentItem": {
"title": "assessmentItem",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier of the resource."
},
"assessmentReference": {
"description": "A reference to the related Assessment resource.",
"$ref": "#/definitions/assessmentReference"
},
"identificationCode": {
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity."
},
"categoryType": {
"description": "Category or type of the assessment item. For example: Multiple choice Analytic Prose ...."
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum."
},
"correctResponse": {
"description": "The correct response for the assessment item."
},
"expectedTimeAssessed": {
"description": "The duration of time allotted for the AssessmentItem."
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element."
},
"learningStandards": {
"description": "An unordered collection of assessmentItemLearningStandards. Learning Standard tested by this item.",
"type": "array",
"items": {
"$ref": "#/definitions/assessmentItemLearningStandard"
}
}
},
"required": [
"id",
"assessmentReference",
"identificationCode",
"categoryType",
"maxRawScore",
"correctResponse",
"expectedTimeAssessed",
"nomenclature",
"learningStandards"
]
},
"assessmentItemLearningStandard": {
"title": "assessmentItemLearningStandard",
"type": "object",
"properties": {
"learningStandardReference": {
"description": "A reference to the related LearningStandard resource.",
"$ref": "#/definitions/learningStandardReference"
}
},
"required": [
"learningStandardReference"
]
}
}
}