- Created by Ian Christopher, last modified on Apr 29, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
This page contains the full Open API spec listing for the proposed ED-FI RFC 19 - ASSESSMENT OUTCOMES API.
Change History
- May 15, 2019: Initial Draft
- Ed-Fi-Assessment-Outcomes-API-v.rfc19.json
API Specification
Open API Definition
{
"swagger": "2.0",
"info": {
"description": "The Assessment Outcomes API describes a REST API surface to enable exchange of assessment metadata and student assessment results between disparate and geographically-separated systems operated by different organizations. The API resource models are derived from and consistent with the underling Ed-Fi Unifying Data Model v2.2.",
"version": "rfc15",
"title": "Ed-Fi Assessment Outcomes API"
},
"basePath": "/",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"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": "objectiveAssessments",
"description": "This entity represents subtests that assess specific learning objectives."
},
{
"name": "assessmentItems",
"description": "This entity represents one of many single measures that make up an assessment."
},
{
"name": "learningObjectives",
"description": "This entity represents identified learning objectives for courses in specific grades."
},
{
"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."
}
],
"paths": {
"/ed-fi/assessments": {
"get": {
"tags": [
"assessments"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getAssessments",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "identifier",
"in": "query",
"description": "A unique number or alphanumeric code assigned to an assessment.",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"description": "Namespace for the Assessment.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"post": {
"tags": [
"assessments"
],
"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": "postAssessment",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "assessment",
"in": "body",
"description": "The JSON representation of the \"assessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/assessments/{id}": {
"get": {
"tags": [
"assessments"
],
"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.",
"operationId": "getAssessmentsById",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"put": {
"tags": [
"assessments"
],
"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.",
"operationId": "putAssessment",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type": "string"
},
{
"name": "assessment",
"in": "body",
"description": "The JSON representation of the \"assessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"delete": {
"tags": [
"assessments"
],
"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).",
"operationId": "deleteAssessmentById",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"type": "string"
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/assessmentItems": {
"get": {
"tags": [
"assessmentItems"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getAssessmentItems",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "identificationCode",
"in": "query",
"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,
"type": "string"
},
{
"name": "assessmentIdentifier",
"in": "query",
"description": "A unique number or alphanumeric code assigned to an assessment.",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"description": "Namespace for the Assessment.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"post": {
"tags": [
"assessmentItems"
],
"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": "postAssessmentItem",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "assessmentItem",
"in": "body",
"description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/assessmentItems/{id}": {
"get": {
"tags": [
"assessmentItems"
],
"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.",
"operationId": "getAssessmentItemsById",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"put": {
"tags": [
"assessmentItems"
],
"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.",
"operationId": "putAssessmentItem",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type": "string"
},
{
"name": "assessmentItem",
"in": "body",
"description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"delete": {
"tags": [
"assessmentItems"
],
"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).",
"operationId": "deleteAssessmentItemById",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"type": "string"
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/learningObjectives": {
"get": {
"tags": [
"learningObjectives"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getLearningObjectives",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "learningObjectiveId",
"in": "query",
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"description": "Namespace for the LearningObjective.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"post": {
"tags": [
"learningObjectives"
],
"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": "postLearningObjective",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "learningObjective",
"in": "body",
"description": "The JSON representation of the \"learningObjective\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/learningObjectives/{id}": {
"get": {
"tags": [
"learningObjectives"
],
"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.",
"operationId": "getLearningObjectivesById",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"put": {
"tags": [
"learningObjectives"
],
"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.",
"operationId": "putLearningObjective",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type": "string"
},
{
"name": "learningObjective",
"in": "body",
"description": "The JSON representation of the \"learningObjective\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"delete": {
"tags": [
"learningObjectives"
],
"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).",
"operationId": "deleteLearningObjectiveById",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"type": "string"
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/studentAssessments": {
"get": {
"tags": [
"studentAssessments"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudentAssessments",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "identifier",
"in": "query",
"description": "A unique number or alphanumeric code assigned to an assessment administered to a student.",
"required": false,
"type": "string"
},
{
"name": "assessmentIdentifier",
"in": "query",
"description": "A unique number or alphanumeric code assigned to an assessment.",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"description": "Namespace for the Assessment.",
"required": false,
"type": "string"
},
{
"name": "studentUniqueId",
"in": "query",
"description": "A unique alphanumeric code assigned to a student.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"post": {
"tags": [
"studentAssessments"
],
"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": "postStudentAssessment",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "studentAssessment",
"in": "body",
"description": "The JSON representation of the \"studentAssessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/studentAssessments/{id}": {
"get": {
"tags": [
"studentAssessments"
],
"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.",
"operationId": "getStudentAssessmentsById",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"put": {
"tags": [
"studentAssessments"
],
"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.",
"operationId": "putStudentAssessment",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type": "string"
},
{
"name": "studentAssessment",
"in": "body",
"description": "The JSON representation of the \"studentAssessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"delete": {
"tags": [
"studentAssessments"
],
"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).",
"operationId": "deleteStudentAssessmentById",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"type": "string"
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/objectiveAssessments": {
"get": {
"tags": [
"objectiveAssessments"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getObjectiveAssessments",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "assessmentIdentifier",
"in": "query",
"description": "A unique number or alphanumeric code assigned to an assessment.",
"required": false,
"type": "string"
},
{
"name": "identificationCode",
"in": "query",
"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,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"description": "ANamespace for the Assessment.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"post": {
"tags": [
"objectiveAssessments"
],
"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",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "objectiveAssessment",
"in": "body",
"description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/objectiveAssessments/{id}": {
"get": {
"tags": [
"objectiveAssessments"
],
"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.",
"operationId": "getObjectiveAssessmentsById",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"put": {
"tags": [
"objectiveAssessments"
],
"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.",
"operationId": "putObjectiveAssessment",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type": "string"
},
{
"name": "objectiveAssessment",
"in": "body",
"description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
],
"responses": {
"201": {
"$ref": "#/responses/Created"
},
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
},
"delete": {
"tags": [
"objectiveAssessments"
],
"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).",
"operationId": "deleteObjectiveAssessmentById",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/id"
},
{
"name": "If-Match",
"in": "header",
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"type": "string"
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
},
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
}
},
"definitions": {
"edFi_assessment": {
"required": [
"identifier",
"namespace",
"academicSubjects",
"title",
"id"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"identifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"type": "string"
},
"academicSubjects": {
"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",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentAcademicSubject"
}
},
"assessedGradeLevels": {
"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 ...",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentGradeLevel"
}
},
"identificationCodes": {
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentIdentificationCode"
}
},
"title": {
"description": "The title or name of the assessment. NEDM: Assessment Title",
"type": "string"
},
"educationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"version": {
"format": "int32",
"description": "The version identifier for the assessment.",
"type": "integer"
},
"categoryDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"contentStandard": {
"$ref": "#/definitions/edFi_assessmentContentStandard"
},
"form": {
"description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.",
"type": "string"
},
"languages": {
"description": "An unordered collection of assessmentLanguages. An indication of the languages in which the Assessment is designed.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentLanguage"
}
},
"maxRawScore": {
"format": "int32",
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"type": "integer"
},
"namespace": {
"description": "Namespace for the Assessment.",
"type": "string"
},
"adaptiveAssessment ": {
"description": "Indicates that the assessment is adaptive.",
"type": "boolean"
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element.",
"type": "string"
},
"performanceLevels": {
"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 .",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentPerformanceLevel"
}
},
"periodDescriptor": {
"description": "The ID of the Assessment Period Descriptor",
"type": "string"
},
"revisionDate": {
"format": "date-time",
"description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially.",
"type": "string"
},
"scores": {
"description": "An unordered collection of assessmentScores. Definition of the scores to be expected from this assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentScore"
}
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_assessmentContentStandard": {
"required": [
"title"
],
"type": "object",
"properties": {
"publicationStatusType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"type": "string"
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator.",
"type": "string"
},
"publicationDate": {
"format": "date-time",
"description": "The date on which this content was first published.",
"type": "string"
},
"publicationYear": {
"format": "int32",
"description": "The year at which this content was first published.",
"type": "integer"
},
"beginDate": {
"format": "date-time",
"description": "The beginning of the period during which this learning standard document is intended for use.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "The end of the period during which this learning standard document is intended for use.",
"type": "string"
},
"mandatingEducationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"authors": {
"description": "An unordered collection of assessmentContentStandardAuthors. The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentContentStandardAuthor"
}
}
}
},
"edFi_assessmentContentStandardAuthor": {
"required": [
"author"
],
"type": "object",
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "string"
}
}
},
"edFi_assessmentIdentificationCode": {
"required": [
"assessmentIdentificationSystemDescriptor",
"identificationCode"
],
"type": "object",
"properties": {
"assessmentIdentificationSystemDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"assigningOrganizationIdentificationCode": {
"description": "The organization code or name assigning the assessment identification code.",
"type": "string"
},
"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.",
"type": "string"
}
}
},
"edFi_assessmentItem": {
"required": [
"identificationCode",
"id",
"assessmentReference"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"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.",
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"categoryType": {
"description": "Category or type of the assessment item. For example: Multiple choice Analytic Prose ....",
"type": "string"
},
"correctResponse": {
"description": "The correct response for the assessment item.",
"type": "string"
},
"expectedTimeAssessed": {
"description": "The duration of time allotted for the AssessmentItem.",
"type": "string"
},
"learningStandards": {
"description": "An unordered collection of assessmentItemLearningStandards. Learning Standard tested by this item.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentItemLearningStandard"
}
},
"maxRawScore": {
"format": "int32",
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"type": "integer"
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element.",
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_assessmentItemLearningStandard": {
"required": [
"learningStandardReference"
],
"type": "object",
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
}
},
"edFi_assessmentItemReference": {
"required": [
"identifier",
"namespace",
"identificationCode"
],
"type": "object",
"properties": {
"identifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment. ",
"type": "string"
},
"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.",
"type": "string"
}
}
},
"edFi_assessmentLanguage": {
"required": [
"languageDescriptor"
],
"type": "object",
"properties": {
"languageDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
}
}
},
"edFi_assessmentGradeLevel": {
"required": [
"gradeLevelDescriptor"
],
"type": "object",
"properties": {
"languageDescriptor": {
"description": "The grade level(s) for which an assessment is designed. The semantics of null is assumed to mean that the assessment is not associated with any grade level.",
"type": "string"
}
}
},
"edFi_assessmentAcademicSubject": {
"required": [
"academicSubjectDescriptor"
],
"type": "object",
"properties": {
"academicSubjectDescriptor": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"type": "string"
}
}
},
"edFi_assessmentPerformanceLevel": {
"required": [
"assessmentReportingMethodType",
"performanceLevelDescriptor"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod",
"type": "string"
},
"performanceLevelDescriptor": {
"description": "The performance level(s) defined for the assessment.",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance.",
"type": "string"
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance.",
"type": "string"
}
}
},
"edFi_assessmentReference": {
"required": [
"identifier",
"namespace"
],
"type": "object",
"properties": {
"identifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"type": "string"
}
}
},
"edFi_assessmentScore": {
"required": [
"assessmentReportingMethodType"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"minimumScore": {
"description": "The minimum score possible on the assessment.",
"type": "string"
},
"maximumScore": {
"description": "The maximum score possible on the assessment.",
"type": "string"
}
}
},
"edFi_educationOrganizationReference": {
"required": [
"educationOrganizationId"
],
"type": "object",
"properties": {
"educationOrganizationId": {
"format": "int32",
"description": "EducationOrganization Identity Column",
"type": "integer"
}
}
},
"edFi_learningObjectiveReference": {
"required": [
"objective",
"namespace"
],
"type": "object",
"properties": {
"academicSubjectDescriptor": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"type": "string"
},
"objective": {
"description": "The designated title of the learning objective.",
"type": "string"
},
"objectiveGradeLevelDescriptor": {
"description": "The grade level for which the learning objective is targeted,",
"type": "string"
}
}
},
"edFi_learningObjective": {
"required": [
"academicSubjects",
"objective",
"namespace",
"id"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"academicSubjects": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentAcademicSubject"
}
},
"gradeLevels": {
"description": "The grade level for which the LearningObjective is targeted. The semantics of null is assumed to mean that the learning objective is not associated with any grade level.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_assessmentGradeLevel"
}
},
"objective": {
"description": "The designated title of the learning objective.",
"type": "string"
},
"parentLearningObjectiveReference": {
"$ref": "#/definitions/edFi_learningObjectiveReference"
},
"contentStandard": {
"$ref": "#/definitions/edFi_learningObjectiveContentStandard"
},
"description": {
"description": "A detailed description of the entity.",
"type": "string"
},
"learningObjectiveId": {
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).",
"type": "string"
},
"learningStandards": {
"description": "An unordered collection of learningObjectiveLearningStandards. ",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveLearningStandard"
}
},
"namespace": {
"description": "Namespace for the LearningObjective.",
"type": "string"
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element.",
"type": "string"
},
"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.",
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_learningObjectiveContentStandard": {
"required": [
"title"
],
"type": "object",
"properties": {
"publicationStatusType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"type": "string"
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator.",
"type": "string"
},
"publicationDate": {
"format": "date-time",
"description": "The date on which this content was first published.",
"type": "string"
},
"publicationYear": {
"format": "int32",
"description": "The year at which this content was first published.",
"type": "integer"
},
"beginDate": {
"format": "date-time",
"description": "The beginning of the period during which this learning standard document is intended for use.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "The end of the period during which this learning standard document is intended for use.",
"type": "string"
},
"mandatingEducationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"authors": {
"description": "An unordered collection of learningObjectiveContentStandardAuthors. The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveContentStandardAuthor"
}
}
}
},
"edFi_learningObjectiveContentStandardAuthor": {
"required": [
"author"
],
"type": "object",
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "string"
}
}
},
"edFi_learningObjectiveLearningStandard": {
"required": [
"learningStandardReference"
],
"type": "object",
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
}
},
"edFi_learningStandard": {
"required": [
"learningStandardId",
"academicSubjectDescriptor",
"description",
"id",
"namespace",
"gradeLevels"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"gradeLevels": {
"description": "An unordered collection of learningStandardGradeLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningStandardGradeLevel"
}
},
"learningStandardId": {
"description": "A unique number or alphanumeric code assigned to a Learning Standard.",
"type": "string"
},
"parentLearningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
},
"academicSubjectDescriptor": {
"description": "Subject area for the learning standard.",
"type": "string"
},
"contentStandard": {
"$ref": "#/definitions/edFi_learningStandardContentStandard"
},
"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).",
"type": "string"
},
"description": {
"description": "A detailed description of the entity.",
"type": "string"
},
"identificationCodes": {
"description": "An unordered collection of learningStandardIdentificationCodes. A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a learning Standard.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningStandardIdentificationCode"
}
},
"itemCode": {
"description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).",
"type": "string"
},
"namespace": {
"description": "Namespace for the LearningStandard.",
"type": "string"
},
"prerequisiteLearningStandards": {
"description": "An unordered collection of learningStandardPrerequisiteLearningStandards. ",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningStandardPrerequisiteLearningStandard"
}
},
"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.",
"type": "string"
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator.",
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_learningStandardContentStandard": {
"required": [
"title"
],
"type": "object",
"properties": {
"publicationStatusType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"type": "string"
},
"uri": {
"description": "The public web site address (URL), file, or ftp locator.",
"type": "string"
},
"publicationDate": {
"format": "date-time",
"description": "The date on which this content was first published.",
"type": "string"
},
"publicationYear": {
"format": "int32",
"description": "The year at which this content was first published.",
"type": "integer"
},
"beginDate": {
"format": "date-time",
"description": "The beginning of the period during which this learning standard document is intended for use.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "The end of the period during which this learning standard document is intended for use.",
"type": "string"
},
"mandatingEducationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"authors": {
"description": "An unordered collection of learningStandardContentStandardAuthors. The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_learningStandardContentStandardAuthor"
}
}
}
},
"edFi_learningStandardContentStandardAuthor": {
"required": [
"author"
],
"type": "object",
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"type": "string"
}
}
},
"edFi_learningStandardGradeLevel": {
"required": [
"gradeLevelDescriptor"
],
"type": "object",
"properties": {
"gradeLevelDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
}
}
},
"edFi_learningStandardIdentificationCode": {
"required": [
"identificationCode",
"contentStandardName"
],
"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.",
"type": "string"
},
"contentStandardName": {
"description": "The name of the content standard, for example Common Core.",
"type": "string"
}
}
},
"edFi_learningStandardPrerequisiteLearningStandard": {
"required": [
"prerequisiteLearningStandardReference"
],
"type": "object",
"properties": {
"prerequisiteLearningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
}
},
"edFi_learningStandardReference": {
"required": [
"learningStandardId"
],
"type": "object",
"properties": {
"learningStandardId": {
"description": "A unique number or alphanumeric code assigned to a Learning Standard.",
"type": "string"
}
}
},
"edFi_studentAssessment": {
"required": [
"identifier",
"administrationDate",
"id",
"assessmentReference",
"studentReference"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"identifier": {
"description": "",
"type": "string"
},
"administrationDate": {
"format": "date-time",
"description": "The date and time an assessment was completed by the student. The use of ISO-8601 formats with a timezone designator (UTC or time offset) is recommended in order to prevent ambiguity due to time zones.",
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"studentReference": {
"$ref": "#/definitions/edFi_studentReference",
"description": "A reference to the related Student resource for Student."
},
"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/edFi_studentAssessmentAccommodation"
}
},
"administrationEndDate": {
"format": "date-time",
"description": "The date and time an assessment administration ended. ",
"type": "string"
},
"administrationEnvironmentType": {
"description": "The environment in which the test was administered. For example: Electronic Classroom Testing Center ... ....",
"type": "string"
},
"administrationLanguageDescriptor": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"eventCircumstanceType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"eventDescription": {
"description": "Describes special events that occur before during or after the assessment session that may impact use of results.",
"type": "string"
},
"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/edFi_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/edFi_studentAssessmentPerformanceLevel"
}
},
"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 ...",
"type": "string"
},
"retestIndicatorType": {
"description": "Indicator if the test was retaken. For example: Primary administration First retest Second retest ...",
"type": "string"
},
"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/edFi_studentAssessmentScoreResult"
}
},
"serialNumber": {
"description": "The unique number for the assessment form or answer document.",
"type": "string"
},
"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/edFi_studentAssessmentStudentObjectiveAssessment"
}
},
"whenAssessedGradeLevelDescriptor": {
"description": "The grade level of a student when assessed.",
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_studentAssessmentAccommodation": {
"required": [
"accommodationDescriptor"
],
"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.",
"type": "string"
}
}
},
"edFi_studentAssessmentItem": {
"required": [
"assessmentItemResultType",
"assessmentItemReference"
],
"type": "object",
"properties": {
"assessmentItemResultType": {
"description": "The analyzed result of a student''s response to an assessment item.. For example: Correct Incorrect Met standard ...",
"type": "string"
},
"responseIndicatorType": {
"description": "Indicator of the response. For example: Nonscorable response Ineffective response Effective response Partial response ...",
"type": "string"
},
"assessmentResponse": {
"description": "A student's response to a stimulus on a test.",
"type": "string"
},
"rawScoreResult": {
"format": "int32",
"description": "A meaningful raw score of the performance of an individual on an assessment item.",
"type": "integer"
},
"timeAssessed": {
"description": "The overall time a student actually spent during the AssessmentItem.",
"type": "string"
},
"descriptiveFeedback": {
"description": "The formative descriptive feedback that was given to a learner in response to the results from a scored/evaluated assessment item.",
"type": "string"
},
"assessmentItemReference": {
"$ref": "#/definitions/edFi_assessmentItemReference"
}
}
},
"edFi_studentAssessmentPerformanceLevel": {
"required": [
"performanceLevelDescriptor",
"performanceLevelMet"
],
"type": "object",
"properties": {
"performanceLevelDescriptor": {
"description": "The ID of the Performance Level Descriptor",
"type": "string"
},
"performanceLevelMet": {
"description": "Optional indicator of whether the performance level was met.",
"type": "boolean"
}
}
},
"edFi_studentAssessmentScoreResult": {
"required": [
"assessmentReportingMethodType",
"resultDatatypeType",
"result"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "The name of the analytic score. For example: Percentile Quantile measure Lexile measure Vertical scale score TPM score ... ...",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"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.",
"type": "string"
}
}
},
"edFi_studentAssessmentStudentObjectiveAssessment": {
"required": [
"objectiveAssessmentReference",
"scoreResults"
],
"type": "object",
"properties": {
"objectiveAssessmentReference": {
"$ref": "#/definitions/edFi_objectiveAssessmentReference"
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentPerformanceLevels. The performance level(s) achieved for the objective assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_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/edFi_studentAssessmentStudentObjectiveAssessmentScoreResult"
}
}
}
},
"edFi_studentAssessmentStudentObjectiveAssessmentPerformanceLevel": {
"required": [
"performanceLevelDescriptor",
"performanceLevelMet"
],
"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.",
"type": "string"
},
"performanceLevelMet": {
"description": "Indicator of whether the student met the designated performance level.",
"type": "boolean"
}
}
},
"edFi_studentAssessmentStudentObjectiveAssessmentScoreResult": {
"required": [
"assessmentReportingMethodType",
"resultDatatypeType",
"result"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"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.",
"type": "string"
}
}
},
"edFi_studentReference": {
"required": [
"studentUniqueId"
],
"type": "object",
"properties": {
"studentUniqueId": {
"format": "int32",
"description": "A unique alphanumeric code assigned to a student.",
"type": "string"
}
}
},
"edFi_objectiveAssessmentReference": {
"required": [
"identifer",
"namespace",
"identificationCode"
],
"type": "object",
"properties": {
"identifer": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"type": "string"
},
"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.",
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"type": "integer"
}
}
},
"edFi_objectiveAssessment": {
"required": [
"identificationCode",
"id",
"assessmentReference"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"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.",
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"parentObjectiveAssessmentReference": {
"$ref": "#/definitions/edFi_objectiveAssessmentReference"
},
"assessmentItems": {
"description": "An unordered collection of objectiveAssessmentAssessmentItems. References individual test items, if appropriate.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentAssessmentItem"
}
},
"description": {
"description": "A detailed description of the entity.",
"type": "string"
},
"learningObjectives": {
"description": "An unordered collection of objectiveAssessmentLearningObjectives. References the Learning Objective(s) the Objective Assessment tests.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentLearningObjective"
}
},
"learningStandards": {
"description": "An unordered collection of objectiveAssessmentLearningStandards. Learning Standard tested by this objective assessment.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentLearningStandard"
}
},
"maxRawScore": {
"format": "int32",
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"type": "integer"
},
"nomenclature": {
"description": "Reflects the common nomenclature for an element.",
"type": "string"
},
"percentOfAssessment": {
"format": "double",
"description": "The percentage of the Assessment that tests this objective.",
"type": "number"
},
"performanceLevels": {
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentPerformanceLevel"
}
},
"scores": {
"description": "An unordered collection of objectiveAssessmentScores. Definition of the scores to be expected from this objectiveAssessment.",
"type": "array",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentScore"
}
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
}
},
"edFi_objectiveAssessmentAssessmentItem": {
"required": [
"assessmentItemReference"
],
"type": "object",
"properties": {
"assessmentItemReference": {
"$ref": "#/definitions/edFi_assessmentItemReference"
}
}
},
"edFi_objectiveAssessmentLearningObjective": {
"required": [
"learningObjectiveReference"
],
"type": "object",
"properties": {
"learningObjectiveReference": {
"$ref": "#/definitions/edFi_learningObjectiveReference"
}
}
},
"edFi_objectiveAssessmentLearningStandard": {
"required": [
"learningStandardReference"
],
"type": "object",
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
}
},
"edFi_objectiveAssessmentPerformanceLevel": {
"required": [
"assessmentReportingMethodType",
"performanceLevelDescriptor"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod",
"type": "string"
},
"performanceLevelDescriptor": {
"description": "The ID of the Performance Level Descriptor",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance.",
"type": "string"
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance.",
"type": "string"
}
}
},
"edFi_objectiveAssessmentScore": {
"required": [
"assessmentReportingMethodType"
],
"type": "object",
"properties": {
"assessmentReportingMethodType": {
"description": "Key for AssessmentReportingMethod",
"type": "string"
},
"resultDatatypeType": {
"description": "A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.",
"type": "string"
},
"minimumScore": {
"description": "The minimum score possible on the assessment.",
"type": "string"
},
"maximumScore": {
"description": "The maximum score possible on the assessment.",
"type": "string"
}
}
}
},
"parameters": {
"offset": {
"name": "offset",
"in": "query",
"description": "Indicates how many items should be skipped before returning results.",
"required": false,
"type": "integer",
"format": "int32"
},
"limit": {
"name": "limit",
"in": "query",
"description": "Indicates the maximum number of items that should be returned in the results.",
"required": false,
"type": "integer",
"format": "int32",
"maxItems": 100,
"minItems": 1
},
"If-None-Match": {
"name": "If-None-Match",
"in": "header",
"description": "The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.",
"required": false,
"type": "string"
},
"id": {
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"required": true,
"type": "string"
},
"fields": {
"name": "fields",
"in": "query",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\").",
"required": false,
"type": "string"
},
"queryExpression": {
"name": "q",
"in": "query",
"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]\").",
"required": false,
"type": "string"
}
},
"responses": {
"Created": {
"description": "The resource was created."
},
"Accepted": {
"description": "The resource has been validated and accepted by the service, but processing has not yet completed due to current system load. Processing may still fail due to violation of referential integrity requirements."
},
"Updated": {
"description": "The resource was updated."
},
"Deleted": {
"description": "The resource was successfully deleted."
},
"NotModified": {
"description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified."
},
"BadRequest": {
"description": "Bad Request. The request was invalid and cannot be completed. See the response body for specific validation errors. This will typically be an issue with the query parameters or their values."
},
"Unauthorized": {
"description": "Unauthorized. The request requires authentication. The OAuth bearer token was either not provided or is invalid. The operation may succeed once authentication has been successfully completed."
},
"Forbidden": {
"description": "Forbidden. The request cannot be completed in the current authorization context. Contact your administrator if you believe this operation should be allowed."
},
"NotFound": {
"description": "The resource could not be found."
},
"Conflict": {
"description": "Conflict. The request cannot be completed because it would result in an invalid state. See the response body for details."
},
"PreconditionFailed": {
"description": "The resource's current server-side ETag value does not match the supplied If-Match header value in the request. This indicates the resource has been modified by another consumer."
},
"Error": {
"description": "An unhandled error occurred on the server. See the response body for details."
}
}
}
- No labels