...
- June 7, 2016: Initial Draft
- Ed-Fi-Assessment-API-v2.-0.json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"swagger": "2.0",
"info": {
"version": "2.0",
"title": "Ed-Fi Assessment API"
},
"tags": [
{ "name": "assessments",
"description": "This entity represents a tool, instrument, process, or exhibition composed of a systematic sampling of behavior 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."
},
{ "name": "localEducationAgencies",
"description": " This entity represents an administrative unit at the local level which exists primarily to operate schools or to contract for educational services. It includes school districts, charter schools, charter management organizations, or other local administrative organizations."
},
{ "name": "programs",
"description": "This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services, or benefits through federal, state, or local agencies. Programs may also include organized extracurricular activities for students."
},
{ "name": "schools",
"description": "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups."
},
{ "name": "sections",
"description": "This entity represents a setting in which organized instruction of course content is provided, in-person or otherwise, to one or more students for a given period of time. A course offering may be offered to more than one section."
},
{ "name": "staffs",
"description": "This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. For example, this includes: 1. An \"employee\" who performs services under the direction of the employing institution or agency is compensated for such services by the employer and is eligible for employee benefits and wage or salary tax withholdings 2. A \"contractor\" or \"consultant\" who performs services for an agreed upon fee or an employee of a management service contracted to work on site 3. A \"volunteer\" who performs services on a voluntary and uncompensated basis 4. An in-kind service provider 5. An independent contractor or businessperson working at a school site."
},
{ "name": "studentAssessments",
"description": "This entity represents the analysis or scoring of a student's response on an assessment. The analysis results in a value that represents a student's performance on a set of items on a test."
},
{ "name": "students",
"description": "This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution."
}
],
"basePath": "/v2.0/assessment",
"securityDefinitions": {},
"schemes": [
"http","https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/assessments": {
"get": {
"tags": [
"assessments"
],
"description": "Retrieves all assessments. If natural key fields are required, those are used to filter the results.",
"operationId": "getAssessmentsByKey_",
"produces": [
"application/json"
],
"parameters": [
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the assessment."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/assessments/{id}": {
"get": {
"tags": [
"assessments"
],
"description": "Retrieves a specific resource using the resource's identifier.",
"operationId": "getAssessmentsById_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/localEducationAgencies/{localEducationAgency_id}/assessments": {
"get": {
"tags": [
"localEducationAgencies"
],
"description": "Retrieves resources using the associated LocalEducationAgency resource's identifier.",
"operationId": "getAssessmentsByLocalEducationAgency_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/schools/{school_id}/assessments": {
"get": {
"tags": [
"schools"
],
"description": "Retrieves resources using the associated School resource's identifier.",
"operationId": "getAssessmentsBySchool_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "school_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/staffs/{staff_id}/assessments": {
"get": {
"tags": [
"staffs"
],
"description": "Retrieves resources using the associated Staff resource's identifier.",
"operationId": "getAssessmentsByStaff_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "staff_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/sections/{section_id}/assessments": {
"get": {
"tags": [
"sections"
],
"description": "Retrieves resources using the associated Section resource's identifier.",
"operationId": "getAssessmentsBySection_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "section_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/programs/{program_id}/assessments": {
"get": {
"tags": [
"programs"
],
"description": "Retrieves resources using the associated Program resource's identifier.",
"operationId": "getAssessmentsByProgram_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/students/{student_id}/assessments": {
"get": {
"tags": [
"students"
],
"description": "Retrieves resources using the associated Student resource's identifier.",
"operationId": "getAssessmentsByStudent_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "student_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"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": "title",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string",
"description": "The version identifier for the assessment."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assessment"
}
}
}
}
}
},
"/studentAssessments": {
"get": {
"tags": [
"studentAssessments"
],
"description": "Retrieves all studentAssessments. If natural key fields are required, those are used to filter the results.",
"operationId": "getStudentAssessmentsByKey_",
"produces": [
"application/json"
],
"parameters": [
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/studentAssessments/{id}": {
"get": {
"tags": [
"studentAssessments"
],
"description": "Retrieves a specific resource using the resource's identifier.",
"operationId": "getStudentAssessmentsById_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/localEducationAgencies/{localEducationAgency_id}/studentAssessments": {
"get": {
"tags": [
"localEducationAgencies"
],
"description": "Retrieves resources using the associated LocalEducationAgency resource's identifier.",
"operationId": "getStudentAssessmentsByLocalEducationAgency_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/schools/{school_id}/studentAssessments": {
"get": {
"tags": [
"schools"
],
"description": "Retrieves resources using the associated School resource's identifier.",
"operationId": "getStudentAssessmentsBySchool_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "school_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/staffs/{staff_id}/studentAssessments": {
"get": {
"tags": [
"staffs"
],
"description": "Retrieves resources using the associated Staff resource's identifier.",
"operationId": "getStudentAssessmentsByStaff_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "staff_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/sections/{section_id}/studentAssessments": {
"get": {
"tags": [
"sections"
],
"description": "Retrieves resources using the associated Section resource's identifier.",
"operationId": "getStudentAssessmentsBySection_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "section_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/programs/{program_id}/studentAssessments": {
"get": {
"tags": [
"programs"
],
"description": "Retrieves resources using the associated Program resource's identifier.",
"operationId": "getStudentAssessmentsByProgram_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
},
"/students/{student_id}/studentAssessments": {
"get": {
"tags": [
"students"
],
"description": "Retrieves resources using the associated Student resource's identifier.",
"operationId": "getStudentAssessmentsByStudent_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "student_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates how many items should be skipped before returning results."
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"description": "Indicates the maximum number of items that should be returned in the results (defaults to 25)."
},
{
"name": "fields",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\")."
},
{
"name": "q",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\")."
},
{
"name": "assessment_id",
"in": "query",
"required": false,
"type": "string",
"description": "The unique identifier of the associated Assessment."
},
{
"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."
},
{
"name": "assessmentTitle",
"in": "query",
"required": false,
"type": "string",
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
{
"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": "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": "version",
"in": "query",
"required": false,
"type": "integer",
"description": "The version identifier for the test assessment. NEDM: Assessment Version"
},
{
"name": "studentUniqueId",
"in": "query",
"required": false,
"type": "string",
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment"
}
}
}
}
}
}
},
"definitions": {
"assessment": {
"title": "assessment",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier of the resource."
},
"title": {
"description": "The title or name of the assessment. NEDM: Assessment Title"
},
"academicSubjectDescriptor": {
"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": {
"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": {
"description": "The version identifier for the assessment."
},
"categoryDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"form": {
"description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc."
},
"periodDescriptor": {
"description": "The ID of the Assessment Period Descriptor"
},
"lowestAssessedGradeLevelDescriptor": {
"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 ..."
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum."
},
"namespace": {
"description": "Namespace for the Assessment."
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element."
},
"revisionDate": {
"description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially."
},
"identificationCodes": {
"description": "An unordered collection of assessmentIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_assessmentIdentificationCode"
}
},
"performanceLevels": {
"description": "An unordered collection of assessmentPerformanceLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_assessmentPerformanceLevel"
}
},
"objectiveAssessments": {
"description": "An unordered collection of objectiveAssessments. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment"
}
}
},
"required": [
"id",
"title",
"academicSubjectDescriptor",
"assessedGradeLevelDescriptor",
"version",
"categoryDescriptor",
"form",
"periodDescriptor",
"lowestAssessedGradeLevelDescriptor",
"maxRawScore",
"namespace",
"nomenclature",
"revisionDate",
"identificationCodes",
"performanceLevels",
"objectiveAssessments"
]
},
"assessment_assessmentIdentificationCode": {
"title": "assessment_assessmentIdentificationCode",
"type": "object",
"properties": {
"assigningOrganizationIdentificationCode": {
"description": "The organization code or name assigning the assessment identification code."
},
"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."
}
},
"required": [
"assigningOrganizationIdentificationCode",
"identificationCode"
]
},
"assessment_assessmentPerformanceLevel": {
"title": "assessment_assessmentPerformanceLevel",
"type": "object",
"properties": {
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance."
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance."
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"minimumScore",
"maximumScore",
"resultDatatypeType"
]
},
"assessment_objectiveAssessment": {
"title": "assessment_objectiveAssessment",
"type": "object",
"properties": {
"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."
},
"description": {
"description": "A detailed description of the entity."
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum."
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element."
},
"percentOfAssessment": {
"description": "The percentage of the Assessment that tests this objective."
},
"performanceLevels": {
"description": "An unordered collection of objectiveAssessmentPerformanceLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentPerformanceLevel"
}
},
"learningObjectives": {
"description": "An unordered collection of objectiveAssessmentLearningObjectives. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentLearningObjective"
}
},
"learningStandards": {
"description": "An unordered collection of objectiveAssessmentLearningStandards. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentLearningStandard"
}
}
},
"required": [
"identificationCode",
"description",
"maxRawScore",
"nomenclature",
"percentOfAssessment",
"performanceLevels",
"learningObjectives",
"learningStandards"
]
},
"assessment_objectiveAssessment_objectiveAssessmentPerformanceLevel": {
"title": "assessment_objectiveAssessment_objectiveAssessmentPerformanceLevel",
"type": "object",
"properties": {
"performanceLevelDescriptor": {
"description": "The ID of the Performance Level Descriptor"
},
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod"
},
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance."
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance."
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"performanceLevelDescriptor",
"assessmentReportingMethodType",
"minimumScore",
"maximumScore",
"resultDatatypeType"
]
},
"assessment_objectiveAssessment_objectiveAssessmentLearningObjective": {
"title": "assessment_objectiveAssessment_objectiveAssessmentLearningObjective",
"type": "object",
"properties": {
"objective": {
"description": "The designated title of the learning objective."
},
"objectiveGradeLevelDescriptor": {
"description": "The grade level for which the learning objective is targeted,"
},
"academicSubjectDescriptor": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment."
},
"description": {
"description": "A detailed description of the entity."
},
"learningObjectiveId": {
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A)."
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element."
},
"successCriteria": {
"description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a learning objective. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the LearningObjective."
},
"learningStandards": {
"description": "An unordered collection of learningObjectiveLearningStandards. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard"
}
}
},
"required": [
"objective",
"objectiveGradeLevelDescriptor",
"academicSubjectDescriptor",
"description",
"learningObjectiveId",
"nomenclature",
"successCriteria",
"learningStandards"
]
},
"assessment_objectiveAssessment_objectiveAssessmentLearningStandard": {
"title": "assessment_objectiveAssessment_objectiveAssessmentLearningStandard",
"type": "object",
"properties": {
"academicSubjectDescriptor": {
"description": "Subject area for the learning standard."
},
"description": {
"description": "A detailed description of the entity."
},
"learningStandardId": {
"description": "A unique number or alphanumeric code assigned to a Learning Standard."
},
"namespace": {
"description": "Namespace for the LearningStandard."
},
"courseTitle": {
"description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts)."
},
"learningStandardItemCode": {
"description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique)."
},
"successCriteria": {
"description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a learning standard. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the LearningStandard."
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator."
},
"learningStandardIdentificationCodes": {
"description": "An unordered collection of learningStandardIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentLearningStandard_learningStandardIdentificationCode"
}
}
},
"required": [
"academicSubjectDescriptor",
"description",
"learningStandardId",
"namespace",
"courseTitle",
"learningStandardItemCode",
"successCriteria",
"uri",
"learningStandardIdentificationCodes"
]
},
"assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard": {
"title": "assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard",
"type": "object",
"properties": {
"academicSubjectDescriptor": {
"description": "Subject area for the learning standard."
},
"description": {
"description": "A detailed description of the entity."
},
"learningStandardId": {
"description": "A unique number or alphanumeric code assigned to a Learning Standard."
},
"namespace": {
"description": "Namespace for the LearningStandard."
},
"courseTitle": {
"description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts)."
},
"learningStandardItemCode": {
"description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique)."
},
"successCriteria": {
"description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a learning standard. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the LearningStandard."
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator."
},
"learningStandardIdentificationCodes": {
"description": "An unordered collection of learningStandardIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard_learningStandardIdentificationCode"
}
}
},
"required": [
"academicSubjectDescriptor",
"description",
"learningStandardId",
"namespace",
"courseTitle",
"learningStandardItemCode",
"successCriteria",
"uri",
"learningStandardIdentificationCodes"
]
},
"assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard_learningStandardIdentificationCode": {
"title": "assessment_objectiveAssessment_objectiveAssessmentLearningObjective_learningObjectiveLearningStandard_learningStandardIdentificationCode",
"type": "object",
"properties": {
"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."
},
"contentStandardName": {
"description": "The name of the content standard, for example Common Core."
}
},
"required": [
"identificationCode",
"contentStandardName"
]
},
"assessment_objectiveAssessment_objectiveAssessmentLearningStandard_learningStandardIdentificationCode": {
"title": "assessment_objectiveAssessment_objectiveAssessmentLearningStandard_learningStandardIdentificationCode",
"type": "object",
"properties": {
"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."
},
"contentStandardName": {
"description": "The name of the content standard, for example Common Core."
}
},
"required": [
"identificationCode",
"contentStandardName"
]
},
"studentAssessment": {
"title": "studentAssessment",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier of the resource."
},
"studentUniqueId": {
"description": "A unique number or alphanumeric code assigned to a student by a state education agency."
},
"administrationDate": {
"description": "The month(s), day(s), and year on which an assessment is administered or first day of administration if over multiple days."
},
"administrationEndDate": {
"description": "Assessment Administration End Date, if administered over multiple days."
},
"administrationEnvironmentType": {
"description": "The environment in which the test was administered. For example: Electronic Classroom Testing Center ... ...."
},
"administrationLanguageDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"eventCircumstanceType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"eventDescription": {
"description": "Describes special events that occur before during or after the assessment session that may impact use of results."
},
"reasonNotTestedType": {
"description": "The primary reason student is not tested. For example: Absent Refusal by parent Refusal by student Medical waiver Illness Disruptive behavior LEP Exempt ..."
},
"retestIndicatorType": {
"description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ..."
},
"serialNumber": {
"description": "The unique number for the assessment form or answer document."
},
"whenAssessedGradeLevelDescriptor": {
"description": "The grade level of a student when assessed."
},
"student": {
"$ref": "#/definitions/studentAssessment_student"
},
"accommodations": {
"description": "An unordered collection of studentAssessmentAccommodations. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentAccommodation"
}
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentPerformanceLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentPerformanceLevel"
}
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentScoreResults. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentScoreResult"
}
},
"objectiveAssessments": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessments. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentStudentObjectiveAssessment"
}
}
},
"required": [
"id",
"studentUniqueId",
"administrationDate",
"administrationEndDate",
"administrationEnvironmentType",
"administrationLanguageDescriptor",
"eventCircumstanceType",
"eventDescription",
"reasonNotTestedType",
"retestIndicatorType",
"serialNumber",
"whenAssessedGradeLevelDescriptor",
"student",
"accommodations",
"performanceLevels",
"scoreResults",
"objectiveAssessments"
]
},
"studentAssessment_studentAssessmentAccommodation": {
"title": "studentAssessment_studentAssessmentAccommodation",
"type": "object",
"properties": {
"accommodationDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
}
},
"required": [
"accommodationDescriptor"
]
},
"studentAssessment_studentAssessmentPerformanceLevel": {
"title": "studentAssessment_studentAssessmentPerformanceLevel",
"type": "object",
"properties": {
"performanceLevelDescriptor": {
"description": "The ID of the Performance Level Descriptor"
},
"performanceLevelMet": {
"description": "Optional indicator of whether the performance level was met."
}
},
"required": [
"performanceLevelDescriptor",
"performanceLevelMet"
]
},
"studentAssessment_studentAssessmentScoreResult": {
"title": "studentAssessment_studentAssessmentScoreResult",
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "The name of the analytic score. For example: Percentile Quantile measure Lexile measure Vertical scale score TPM score ... ..."
},
"result": {
"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": {
"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"
]
},
"studentAssessment_studentAssessmentStudentObjectiveAssessment": {
"title": "studentAssessment_studentAssessmentStudentObjectiveAssessment",
"type": "object",
"properties": {
"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."
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentPerformanceLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentPerformanceLevel"
}
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentScoreResults. ",
"type": "array",
"items": {
"$ref": "#/definitions/studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentScoreResult"
}
}
},
"required": [
"identificationCode",
"performanceLevels",
"scoreResults"
]
},
"studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentPerformanceLevel": {
"title": "studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentPerformanceLevel",
"type": "object",
"properties": {
"performanceLevelDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table."
},
"performanceLevelMet": {
"description": "Indicator of whether the student met the designated performance level."
}
},
"required": [
"performanceLevelDescriptor",
"performanceLevelMet"
]
},
"studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentScoreResult": {
"title": "studentAssessment_studentAssessmentStudentObjectiveAssessment_studentAssessmentStudentObjectiveAssessmentScoreResult",
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod"
},
"result": {
"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": {
"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"
]
},
"studentAssessment_student": {
"title": "studentAssessment_student",
"type": "object",
"properties": {
"firstName": {
"description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change."
},
"lastSurname": {
"description": "The name borne in common by members of a family."
},
"birthDate": {
"description": "The month, day, and year on which an individual was born."
}
},
"required": [
"firstName",
"lastSurname",
"birthDate"
]
}
}
}
|