Ed-Fi RFC 22 - Open API Spec
- Eric Jansson
Owned by Eric Jansson
Oct 04, 2019
32 min read
Loading data...
This page contains the full Open API spec listing for the proposed ED-FI RFC 22 - ASSESSMENT OUTCOMES API
Open API JSON
{
"swagger": "2.0",
"info": {
"version": "rfc22",
"title": "Ed-Fi Assessment Outcomes API",
"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 v3.2."
},
"basePath": "/",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/ed-fi/assessments": {
"get": {
"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",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "assessmentIdentifier",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "Namespace for the Assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_assessment"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"assessments"
]
},
"post": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "The JSON representation of the \"assessment\" resource to be created or updated.",
"in": "body",
"name": "assessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessment"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"assessments"
]
}
},
"/ed-fi/assessments/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getAssessmentsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$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"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"assessments"
]
},
"put": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"assessment\" resource to be created or updated.",
"in": "body",
"name": "assessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessment"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"assessments"
]
},
"delete": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"assessments"
]
}
},
"/ed-fi/assessmentItems": {
"get": {
"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",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "identificationCode",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "assessmentIdentifier",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "Namespace for the Assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_assessmentItem"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"assessmentItems"
]
},
"post": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.",
"in": "body",
"name": "assessmentItem",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"assessmentItems"
]
}
},
"/ed-fi/assessmentItems/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getAssessmentItemsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$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"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"assessmentItems"
]
},
"put": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.",
"in": "body",
"name": "assessmentItem",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_assessmentItem"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"assessmentItems"
]
},
"delete": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"assessmentItems"
]
}
},
"/ed-fi/learningObjectives": {
"get": {
"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",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "learningObjectiveId",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "Namespace for the LearningObjective.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_learningObjective"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"learningObjectives"
]
},
"post": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "The JSON representation of the \"learningObjective\" resource to be created or updated.",
"in": "body",
"name": "learningObjective",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"learningObjectives"
]
}
},
"/ed-fi/learningObjectives/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getLearningObjectivesById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$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"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"learningObjectives"
]
},
"put": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"learningObjective\" resource to be created or updated.",
"in": "body",
"name": "learningObjective",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningObjective"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"learningObjectives"
]
},
"delete": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"learningObjectives"
]
}
},
"/ed-fi/learningStandards": {
"get": {
"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": "getLearningStandards",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "learningStandardId",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_learningStandard"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"learningStandards"
]
},
"post": {
"consumes": [
"application/json"
],
"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": "postLearningStandard",
"parameters": [
{
"description": "The JSON representation of the \"learningStandard\" resource to be created or updated.",
"in": "body",
"name": "learningStandard",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningStandard"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"learningStandards"
]
}
},
"/ed-fi/learningStandards/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getLearningStandardsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_learningStandard"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"learningStandards"
]
},
"put": {
"consumes": [
"application/json"
],
"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": "putLearningStandard",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"learningStandard\" resource to be created or updated.",
"in": "body",
"name": "learningStandard",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_learningStandard"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"learningStandards"
]
},
"delete": {
"consumes": [
"application/json"
],
"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": "deleteLearningStandardById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"learningStandards"
]
}
},
"/ed-fi/objectiveAssessments": {
"get": {
"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",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"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.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "identificationCode",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "assessmentIdentifier",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "Namespace for the Assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_objectiveAssessment"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"objectiveAssessments"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postObjectiveAssessment",
"parameters": [
{
"description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.",
"in": "body",
"name": "objectiveAssessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"objectiveAssessments"
]
}
},
"/ed-fi/objectiveAssessments/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getObjectiveAssessmentsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$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"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"objectiveAssessments"
]
},
"put": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.",
"in": "body",
"name": "objectiveAssessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_objectiveAssessment"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"objectiveAssessments"
]
},
"delete": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"objectiveAssessments"
]
}
},
"/ed-fi/studentAssessments": {
"get": {
"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",
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"description": "A unique number or alphanumeric code assigned to an assessment administered to a student.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "studentAssessmentIdentifier",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "assessmentIdentifier",
"required": false,
"maxLength": 60,
"type": "string"
}, {
"description": "Namespace for the Assessment.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
}, {
"description": "A unique alphanumeric code assigned to a student.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "studentUniqueId",
"required": false,
"maxLength": 32,
"type": "string"
}, {
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_studentAssessment"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"studentAssessments"
]
},
"post": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "The JSON representation of the \"studentAssessment\" resource to be created or updated.",
"in": "body",
"name": "studentAssessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"studentAssessments"
]
}
},
"/ed-fi/studentAssessments/{id}": {
"get": {
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getStudentAssessmentsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$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"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"studentAssessments"
]
},
"put": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}, {
"description": "The JSON representation of the \"studentAssessment\" resource to be created or updated.",
"in": "body",
"name": "studentAssessment",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_studentAssessment"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"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"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"studentAssessments"
]
},
"delete": {
"consumes": [
"application/json"
],
"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",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}, {
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"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"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"studentAssessments"
]
}
}
},
"definitions": {
"edFi_assessment": {
"properties": {
"id": {
"description": "",
"type": "string"
},
"academicSubjects": {
"description": "An unordered collection of assessmentAcademicSubjects. The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"items": {
"$ref": "#/definitions/edFi_assessmentAcademicSubject"
},
"type": "array"
},
"assessmentIdentifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"educationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"adaptiveAssessment": {
"description": "Indicates that the assessment is adaptive.",
"type": "boolean"
},
"assessedGradeLevels": {
"description": "An unordered collection of assessmentAssessedGradeLevels. 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.",
"items": {
"$ref": "#/definitions/edFi_assessmentAssessedGradeLevel"
},
"type": "array"
},
"assessmentCategoryDescriptor": {
"description": "The category of an assessment based on format and content. For example: Achievement test, Advanced placement test, Alternate assessment/grade-level standards, Attitudinal test, Cognitive and perceptual skills test...",
"maxLength": 306,
"type": "string"
},
"assessmentFamily": {
"description": "The AssessmentFamily this Assessment is a member of.",
"maxLength": 60,
"type": "string"
},
"assessmentForm": {
"description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.",
"maxLength": 60,
"type": "string"
},
"assessmentTitle": {
"description": "The title or name of the Assessment.",
"maxLength": 100,
"type": "string"
},
"assessmentVersion": {
"description": "The version identifier for the assessment.",
"format": "int32",
"type": "integer"
},
"contentStandard": {
"$ref": "#/definitions/edFi_assessmentContentStandard"
},
"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.",
"items": {
"$ref": "#/definitions/edFi_assessmentIdentificationCode"
},
"type": "array"
},
"languages": {
"description": "An unordered collection of assessmentLanguages. An indication of the languages in which the assessment is designed.",
"items": {
"$ref": "#/definitions/edFi_assessmentLanguage"
},
"type": "array"
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"format": "double",
"type": "number"
},
"nomenclature": {
"description": "Reflects the specific nomenclature used for Assessment.",
"maxLength": 35,
"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.",
"items": {
"$ref": "#/definitions/edFi_assessmentPerformanceLevel"
},
"type": "array"
},
"period": {
"$ref": "#/definitions/edFi_assessmentPeriod"
},
"platformTypes": {
"description": "An unordered collection of assessmentPlatformTypes. The platforms with which the assessment may be delivered.",
"items": {
"$ref": "#/definitions/edFi_assessmentPlatformType"
},
"type": "array"
},
"programs": {
"description": "An unordered collection of assessmentPrograms. The programs associated with the Assessment.",
"items": {
"$ref": "#/definitions/edFi_assessmentProgram"
},
"type": "array"
},
"revisionDate": {
"description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially.",
"format": "date",
"type": "string"
},
"scores": {
"description": "An unordered collection of assessmentScores. Definition of the scores to be expected from this assessment.",
"items": {
"$ref": "#/definitions/edFi_assessmentScore"
},
"type": "array"
},
"sections": {
"description": "An unordered collection of assessmentSections. The Section(s) to which the Assessment is associated.",
"items": {
"$ref": "#/definitions/edFi_assessmentSection"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"assessmentIdentifier", "namespace", "assessmentTitle", "id", "academicSubjects"
],
"type": "object"
},
"edFi_assessmentAcademicSubject": {
"properties": {
"academicSubjectDescriptor": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"academicSubjectDescriptor"
],
"type": "object"
},
"edFi_assessmentAssessedGradeLevel": {
"properties": {
"gradeLevelDescriptor": {
"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.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"gradeLevelDescriptor"
],
"type": "object"
},
"edFi_assessmentContentStandard": {
"properties": {
"publicationStatusDescriptor": {
"description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown).",
"maxLength": 306,
"type": "string"
},
"beginDate": {
"description": "The beginning of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"endDate": {
"description": "The end of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"publicationDate": {
"description": "The date on which this content was first published.",
"format": "date",
"type": "string"
},
"publicationYear": {
"description": "The year at which this content was first published.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"maxLength": 75,
"type": "string"
},
"uri": {
"description": "An unambiguous reference to the standards using a network-resolvable URI.",
"maxLength": 255,
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"maxLength": 50,
"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.",
"items": {
"$ref": "#/definitions/edFi_assessmentContentStandardAuthor"
},
"type": "array"
}
},
"required": [
"title"
],
"type": "object"
},
"edFi_assessmentContentStandardAuthor": {
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 100,
"type": "string"
}
},
"required": [
"author"
],
"type": "object"
},
"edFi_assessmentIdentificationCode": {
"properties": {
"assessmentIdentificationSystemDescriptor": {
"description": "A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to an assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"assigningOrganizationIdentificationCode": {
"description": "The organization code or name assigning the assessment identification code.",
"maxLength": 60,
"type": "string"
},
"identificationCode": {
"description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.",
"maxLength": 60,
"type": "string"
}
},
"required": [
"assessmentIdentificationSystemDescriptor", "identificationCode"
],
"type": "object"
},
"edFi_assessmentItem": {
"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, state, or other agency or entity.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"assessmentItemCategoryDescriptor": {
"description": "Category or type of the AssessmentItem. For example: Multiple choice, Analytic, Prose...",
"maxLength": 306,
"type": "string"
},
"assessmentItemURI": {
"description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.",
"maxLength": 255,
"type": "string"
},
"correctResponse": {
"description": "The correct response for the AssessmentItem.",
"maxLength": 20,
"type": "string"
},
"expectedTimeAssessed": {
"description": "The duration of time allotted for the AssessmentItem.",
"maxLength": 30,
"type": "string"
},
"itemText": {
"description": "The text of the item.",
"maxLength": 1024,
"type": "string"
},
"learningStandards": {
"description": "An unordered collection of assessmentItemLearningStandards. LearningStandard tested by this item.",
"items": {
"$ref": "#/definitions/edFi_assessmentItemLearningStandard"
},
"type": "array"
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"format": "double",
"type": "number"
},
"nomenclature": {
"description": "Reflects the specific nomenclature used for AssessmentItem.",
"maxLength": 35,
"type": "string"
},
"possibleResponses": {
"description": "An unordered collection of assessmentItemPossibleResponses. A possible response to an assessment item.",
"items": {
"$ref": "#/definitions/edFi_assessmentItemPossibleResponse"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"identificationCode", "id", "assessmentReference"
],
"type": "object"
},
"edFi_assessmentItemLearningStandard": {
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
},
"required": [
"learningStandardReference"
],
"type": "object"
},
"edFi_assessmentItemPossibleResponse": {
"properties": {
"responseValue": {
"description": "The response value, often an option number or code value (e.g., 1, 2, A, B, true, false).",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"correctResponse": {
"description": "Indicates the response is correct.",
"type": "boolean"
},
"responseDescription": {
"description": "Additional text provided to define the response value.",
"maxLength": 1024,
"type": "string"
}
},
"required": [
"responseValue"
],
"type": "object"
},
"edFi_assessmentItemReference": {
"properties": {
"assessmentIdentifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"maxLength": 60,
"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, state, or other agency or entity.",
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"assessmentIdentifier", "identificationCode", "namespace"
],
"type": "object"
},
"edFi_assessmentLanguage": {
"properties": {
"languageDescriptor": {
"description": "An indication of the languages in which the assessment is designed.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"languageDescriptor"
],
"type": "object"
},
"edFi_assessmentPerformanceLevel": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the instructor of the class uses to report the performance and achievement of all students. It may be a qualitative method such as individualized teacher comments or a quantitative method such as a letter or numerical grade. In some cases, more than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelDescriptor": {
"description": "The performance level(s) defined for the assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"type": "string"
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance.",
"maxLength": 35,
"type": "string"
},
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor", "performanceLevelDescriptor"
],
"type": "object"
},
"edFi_assessmentPeriod": {
"properties": {
"assessmentPeriodDescriptor": {
"description": "The period of time in which an assessment is supposed to be administered (e.g., Beginning of Year, Middle of Year, End of Year).",
"maxLength": 306,
"type": "string"
},
"beginDate": {
"description": "The first date the assessment is to be administered.",
"format": "date",
"type": "string"
},
"endDate": {
"description": "The last date the assessment is to be administered.",
"format": "date",
"type": "string"
}
},
"required": [
"assessmentPeriodDescriptor"
],
"type": "object"
},
"edFi_assessmentPlatformType": {
"properties": {
"platformTypeDescriptor": {
"description": "The platforms with which the assessment may be delivered.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"platformTypeDescriptor"
],
"type": "object"
},
"edFi_assessmentProgram": {
"properties": {
"programReference": {
"$ref": "#/definitions/edFi_programReference"
}
},
"required": [
"programReference"
],
"type": "object"
},
"edFi_assessmentReference": {
"properties": {
"assessmentIdentifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"assessmentIdentifier", "namespace"
],
"type": "object"
},
"edFi_assessmentScore": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the administrator of the assessment uses to report the performance and achievement of all students. It may be a qualitative method such as performance level descriptors or a quantitative method such as a numerical grade or cut score. More than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"type": "string"
},
"maximumScore": {
"description": "The maximum score possible on the assessment.",
"maxLength": 35,
"type": "string"
},
"minimumScore": {
"description": "The minimum score possible on the assessment.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor"
],
"type": "object"
},
"edFi_assessmentSection": {
"properties": {
"sectionReference": {
"$ref": "#/definitions/edFi_sectionReference"
}
},
"required": [
"sectionReference"
],
"type": "object"
},
"edFi_educationOrganizationReference": {
"properties": {
"educationOrganizationId": {
"description": "The identifier assigned to an education organization.",
"format": "int32",
"type": "integer"
}
},
"required": [
"educationOrganizationId"
],
"type": "object"
},
"edFi_learningObjective": {
"properties": {
"id": {
"description": "",
"type": "string"
},
"academicSubjects": {
"description": "An unordered collection of learningObjectiveAcademicSubjects. The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveAcademicSubject"
},
"type": "array"
},
"learningObjectiveId": {
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the LearningObjective.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"parentLearningObjectiveReference": {
"$ref": "#/definitions/edFi_learningObjectiveReference"
},
"contentStandard": {
"$ref": "#/definitions/edFi_learningObjectiveContentStandard"
},
"description": {
"description": "The description of the LearningObjective.",
"maxLength": 1024,
"type": "string"
},
"gradeLevels": {
"description": "An unordered collection of learningObjectiveGradeLevels. 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.",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveGradeLevel"
},
"type": "array"
},
"learningStandards": {
"description": "An unordered collection of learningObjectiveLearningStandards. LearningStandard(s) included in this objective.",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveLearningStandard"
},
"type": "array"
},
"nomenclature": {
"description": "Reflects the specific nomenclature used for the LearningObjective.",
"maxLength": 35,
"type": "string"
},
"objective": {
"description": "The designated title of the LearningObjective.",
"maxLength": 60,
"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.",
"maxLength": 150,
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"learningObjectiveId", "namespace", "id", "objective", "academicSubjects"
],
"type": "object"
},
"edFi_learningObjectiveAcademicSubject": {
"properties": {
"academicSubjectDescriptor": {
"description": "The description of the content or subject area (e.g., arts, mathematics, reading, stenography, or a foreign language) of an assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"academicSubjectDescriptor"
],
"type": "object"
},
"edFi_learningObjectiveContentStandard": {
"properties": {
"publicationStatusDescriptor": {
"description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown).",
"maxLength": 306,
"type": "string"
},
"beginDate": {
"description": "The beginning of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"endDate": {
"description": "The end of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"publicationDate": {
"description": "The date on which this content was first published.",
"format": "date",
"type": "string"
},
"publicationYear": {
"description": "The year at which this content was first published.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"maxLength": 75,
"type": "string"
},
"uri": {
"description": "An unambiguous reference to the standards using a network-resolvable URI.",
"maxLength": 255,
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"maxLength": 50,
"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.",
"items": {
"$ref": "#/definitions/edFi_learningObjectiveContentStandardAuthor"
},
"type": "array"
}
},
"required": [
"title"
],
"type": "object"
},
"edFi_learningObjectiveContentStandardAuthor": {
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 100,
"type": "string"
}
},
"required": [
"author"
],
"type": "object"
},
"edFi_learningObjectiveGradeLevel": {
"properties": {
"gradeLevelDescriptor": {
"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.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"gradeLevelDescriptor"
],
"type": "object"
},
"edFi_learningObjectiveLearningStandard": {
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
},
"required": [
"learningStandardReference"
],
"type": "object"
},
"edFi_learningObjectiveReference": {
"properties": {
"learningObjectiveId": {
"description": "The identifier for the specific learning objective in the context of a standard (e.g., 111.15.3.1.A).",
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the LearningObjective.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"learningObjectiveId", "namespace"
],
"type": "object"
},
"edFi_learningStandard": {
"properties": {
"id": {
"description": "",
"type": "string"
},
"academicSubjects": {
"description": "An unordered collection of learningStandardAcademicSubjects. Subject area for the LearningStandard.",
"items": {
"$ref": "#/definitions/edFi_learningStandardAcademicSubject"
},
"type": "array"
},
"gradeLevels": {
"description": "An unordered collection of learningStandardGradeLevels. The grade levels for the specific learning standard.",
"items": {
"$ref": "#/definitions/edFi_learningStandardGradeLevel"
},
"type": "array"
},
"learningStandardId": {
"description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"parentLearningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
},
"contentStandard": {
"$ref": "#/definitions/edFi_learningStandardContentStandard"
},
"courseTitle": {
"description": "The official Course Title with which this learning standard is associated.",
"maxLength": 60,
"type": "string"
},
"description": {
"description": "The text of the statement. The textual content that either describes a specific competency such as \"Apply the Pythagorean Theorem to determine unknown side lengths in right triangles in real-world and mathematical problems in two and three dimensions.\" or describes a less granular group of competencies within the taxonomy of the standards document, e.g. \"Understand and apply the Pythagorean Theorem,\" or \"Geometry\".",
"maxLength": 1024,
"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.",
"items": {
"$ref": "#/definitions/edFi_learningStandardIdentificationCode"
},
"type": "array"
},
"learningStandardCategoryDescriptor": {
"description": "An additional classification of the type of a specific learning standard.",
"maxLength": 306,
"type": "string"
},
"learningStandardItemCode": {
"description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).",
"maxLength": 60,
"type": "string"
},
"learningStandardScopeDescriptor": {
"description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body.",
"maxLength": 306,
"type": "string"
},
"namespace": {
"description": "The namespace of the organization or entity who governs the standard. It is recommended the namespaces observe a URI format and begin with a domain name under the governing organization or entity control.",
"maxLength": 255,
"type": "string"
},
"prerequisiteLearningStandards": {
"description": "An unordered collection of learningStandardPrerequisiteLearningStandards. The unique identifier of a prerequisite learning standard item, a competency needed prior to learning this one. (Some items may have no prerequisites others may have one or more prerequisites. This should only be used to represent the immediate predecessors in a competency-based pathway, i.e. not prerequisites of prerequisites).",
"items": {
"$ref": "#/definitions/edFi_learningStandardPrerequisiteLearningStandard"
},
"type": "array"
},
"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.",
"maxLength": 150,
"type": "string"
},
"uri": {
"description": "An unambiguous reference to the statement using a network-resolvable URI.",
"maxLength": 255,
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"learningStandardId", "description", "id", "namespace", "academicSubjects", "gradeLevels"
],
"type": "object"
},
"edFi_learningStandardAcademicSubject": {
"properties": {
"academicSubjectDescriptor": {
"description": "Subject area for the LearningStandard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"academicSubjectDescriptor"
],
"type": "object"
},
"edFi_learningStandardContentStandard": {
"properties": {
"publicationStatusDescriptor": {
"description": "The publication status of the document (i.e., Adopted, Draft, Published, Deprecated, Unknown).",
"maxLength": 306,
"type": "string"
},
"beginDate": {
"description": "The beginning of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"endDate": {
"description": "The end of the period during which this learning standard document is intended for use.",
"format": "date",
"type": "string"
},
"publicationDate": {
"description": "The date on which this content was first published.",
"format": "date",
"type": "string"
},
"publicationYear": {
"description": "The year at which this content was first published.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "The name of the content standard, for example Common Core.",
"maxLength": 75,
"type": "string"
},
"uri": {
"description": "An unambiguous reference to the standards using a network-resolvable URI.",
"maxLength": 255,
"type": "string"
},
"version": {
"description": "The version identifier for the content.",
"maxLength": 50,
"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.",
"items": {
"$ref": "#/definitions/edFi_learningStandardContentStandardAuthor"
},
"type": "array"
}
},
"required": [
"title"
],
"type": "object"
},
"edFi_learningStandardContentStandardAuthor": {
"properties": {
"author": {
"description": "The person or organization chiefly responsible for the intellectual content of the standard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 100,
"type": "string"
}
},
"required": [
"author"
],
"type": "object"
},
"edFi_learningStandardGradeLevel": {
"properties": {
"gradeLevelDescriptor": {
"description": "The grade levels for the specific learning standard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"gradeLevelDescriptor"
],
"type": "object"
},
"edFi_learningStandardIdentificationCode": {
"properties": {
"contentStandardName": {
"description": "The name of the content standard, for example Common Core.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 65,
"type": "string"
},
"identificationCode": {
"description": "A unique number or alphanumeric code assigned to a Learning Standard.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
}
},
"required": [
"contentStandardName", "identificationCode"
],
"type": "object"
},
"edFi_learningStandardPrerequisiteLearningStandard": {
"properties": {
"prerequisiteLearningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
},
"required": [
"prerequisiteLearningStandardReference"
],
"type": "object"
},
"edFi_learningStandardReference": {
"properties": {
"learningStandardId": {
"description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).",
"maxLength": 60,
"type": "string"
}
},
"required": [
"learningStandardId"
],
"type": "object"
},
"edFi_objectiveAssessment": {
"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.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"parentObjectiveAssessmentReference": {
"$ref": "#/definitions/edFi_objectiveAssessmentReference"
},
"academicSubjectDescriptor": {
"description": "The subject area of the objective assessment.",
"maxLength": 306,
"type": "string"
},
"assessmentItems": {
"description": "An unordered collection of objectiveAssessmentAssessmentItems. References individual test items, if appropriate.",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentAssessmentItem"
},
"type": "array"
},
"description": {
"description": "The description of the ObjectiveAssessment (e.g., vocabulary, measurement, or geometry).",
"maxLength": 1024,
"type": "string"
},
"learningObjectives": {
"description": "An unordered collection of objectiveAssessmentLearningObjectives. References the LearningObjective(s) the ObjectiveAssessment tests.",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentLearningObjective"
},
"type": "array"
},
"learningStandards": {
"description": "An unordered collection of objectiveAssessmentLearningStandards. LearningStandard tested by this ObjectiveAssessment.",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentLearningStandard"
},
"type": "array"
},
"maxRawScore": {
"description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.",
"format": "double",
"type": "number"
},
"nomenclature": {
"description": "Reflects the specific nomenclature used for this level of ObjectiveAssessment.",
"maxLength": 35,
"type": "string"
},
"percentOfAssessment": {
"description": "The percentage of the Assessment that tests this objective.",
"format": "double",
"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",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentPerformanceLevel"
},
"type": "array"
},
"scores": {
"description": "An unordered collection of objectiveAssessmentScores. Definition of the scores to be expected from this objective assessment.",
"items": {
"$ref": "#/definitions/edFi_objectiveAssessmentScore"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"identificationCode", "id", "assessmentReference"
],
"type": "object"
},
"edFi_objectiveAssessmentAssessmentItem": {
"properties": {
"assessmentItemReference": {
"$ref": "#/definitions/edFi_assessmentItemReference"
}
},
"required": [
"assessmentItemReference"
],
"type": "object"
},
"edFi_objectiveAssessmentLearningObjective": {
"properties": {
"learningObjectiveReference": {
"$ref": "#/definitions/edFi_learningObjectiveReference"
}
},
"required": [
"learningObjectiveReference"
],
"type": "object"
},
"edFi_objectiveAssessmentLearningStandard": {
"properties": {
"learningStandardReference": {
"$ref": "#/definitions/edFi_learningStandardReference"
}
},
"required": [
"learningStandardReference"
],
"type": "object"
},
"edFi_objectiveAssessmentPerformanceLevel": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the instructor of the class uses to report the performance and achievement of all students. It may be a qualitative method such as individualized teacher comments or a quantitative method such as a letter or numerical grade. In some cases, more than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelDescriptor": {
"description": "The performance level(s) defined for the assessment.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"type": "string"
},
"maximumScore": {
"description": "The maximum score to make the indicated level of performance.",
"maxLength": 35,
"type": "string"
},
"minimumScore": {
"description": "The minimum score required to make the indicated level of performance.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor", "performanceLevelDescriptor"
],
"type": "object"
},
"edFi_objectiveAssessmentReference": {
"properties": {
"assessmentIdentifier": {
"description": "A unique number or alphanumeric code assigned to an assessment.",
"maxLength": 60,
"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.",
"maxLength": 60,
"type": "string"
},
"namespace": {
"description": "Namespace for the Assessment.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"assessmentIdentifier", "identificationCode", "namespace"
],
"type": "object"
},
"edFi_objectiveAssessmentScore": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the administrator of the assessment uses to report the performance and achievement of all students. It may be a qualitative method such as performance level descriptors or a quantitative method such as a numerical grade or cut score. More than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"type": "string"
},
"maximumScore": {
"description": "The maximum score possible on the assessment.",
"maxLength": 35,
"type": "string"
},
"minimumScore": {
"description": "The minimum score possible on the assessment.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor"
],
"type": "object"
},
"edFi_programReference": {
"properties": {
"educationOrganizationId": {
"description": "The identifier assigned to an education organization.",
"format": "int32",
"type": "integer"
},
"programName": {
"description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.",
"maxLength": 60,
"type": "string"
},
"programTypeDescriptor": {
"description": "The type of program.",
"maxLength": 306,
"type": "string"
}
},
"required": [
"educationOrganizationId", "programName", "programTypeDescriptor"
],
"type": "object"
},
"edFi_schoolYearTypeReference": {
"properties": {
"schoolYear": {
"description": "Key for School Year",
"format": "int32",
"type": "integer"
}
},
"required": [
"schoolYear"
],
"type": "object"
},
"edFi_sectionReference": {
"properties": {
"localCourseCode": {
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"maxLength": 60,
"type": "string"
},
"schoolId": {
"description": "The identifier assigned to a school.",
"format": "int32",
"type": "integer"
},
"schoolYear": {
"description": "The identifier for the school year.",
"format": "int32",
"type": "integer"
},
"sectionIdentifier": {
"description": "The local identifier assigned to a section.",
"maxLength": 255,
"type": "string"
},
"sessionName": {
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"maxLength": 60,
"type": "string"
}
},
"required": [
"localCourseCode", "schoolId", "schoolYear", "sectionIdentifier", "sessionName"
],
"type": "object"
},
"edFi_studentAssessment": {
"properties": {
"id": {
"description": "",
"type": "string"
},
"studentAssessmentIdentifier": {
"description": "A unique number or alphanumeric code assigned to an assessment administered to a student.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60,
"type": "string"
},
"assessmentReference": {
"$ref": "#/definitions/edFi_assessmentReference"
},
"schoolYearTypeReference": {
"$ref": "#/definitions/edFi_schoolYearTypeReference"
},
"studentReference": {
"$ref": "#/definitions/edFi_studentReference"
},
"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. For example: Braille, Enlarged monitor view, Extra time, Large Print, Setting, Oral Administration...",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentAccommodation"
},
"type": "array"
},
"administrationDate": {
"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.",
"format": "date-time",
"type": "string"
},
"administrationEndDate": {
"description": "The date and time an assessment administration ended.",
"format": "date-time",
"type": "string"
},
"administrationEnvironmentDescriptor": {
"description": "The environment in which the test was administered.",
"maxLength": 306,
"type": "string"
},
"administrationLanguageDescriptor": {
"description": "The language in which an assessment is written and/or administered.",
"maxLength": 306,
"type": "string"
},
"eventCircumstanceDescriptor": {
"description": "An unusual event occurred during the administration of the assessment. This could include fire alarm, student became ill, etc.",
"maxLength": 306,
"type": "string"
},
"eventDescription": {
"description": "Describes special events that occur before during or after the assessment session that may impact use of results.",
"maxLength": 1024,
"type": "string"
},
"items": {
"description": "An unordered collection of studentAssessmentItems. The student's response to an assessment item and the item-level scores such as correct, incorrect, or met standard.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentItem"
},
"type": "array"
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentPerformanceLevels. The performance level(s) achieved for the StudentAssessment.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentPerformanceLevel"
},
"type": "array"
},
"platformTypeDescriptor": {
"description": "The platform with which the assessment was delivered to the student during the assessment session.",
"maxLength": 306,
"type": "string"
},
"reasonNotTestedDescriptor": {
"description": "The primary reason student is not tested. For example: Absent, Refusal by parent, Refusal by student, Medical waiver, Illness, Disruptive behavior, LEP Exempt...",
"maxLength": 306,
"type": "string"
},
"retestIndicatorDescriptor": {
"description": "Indicator if the test was retaken. For example: Primary administration, First retest ,Second retest...",
"maxLength": 306,
"type": "string"
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentScoreResults. A meaningful score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentScoreResult"
},
"type": "array"
},
"serialNumber": {
"description": "The unique number for the assessment form or answer document.",
"maxLength": 60,
"type": "string"
},
"studentObjectiveAssessments": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessments. The student's score and/or performance levels earned for an ObjectiveAssessment.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentStudentObjectiveAssessment"
},
"type": "array"
},
"whenAssessedGradeLevelDescriptor": {
"description": "The grade level of a student when assessed.",
"maxLength": 306,
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"studentAssessmentIdentifier", "administrationDate", "id", "assessmentReference", "studentReference"
],
"type": "object"
},
"edFi_studentAssessmentAccommodation": {
"properties": {
"accommodationDescriptor": {
"description": "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. For example: Braille, Enlarged monitor view, Extra time, Large Print, Setting, Oral Administration...",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"accommodationDescriptor"
],
"type": "object"
},
"edFi_studentAssessmentItem": {
"properties": {
"assessmentItemResultDescriptor": {
"description": "The analyzed result of a student's response to an assessment item. For example: Correct, Incorrect, Met standard...",
"maxLength": 306,
"type": "string"
},
"responseIndicatorDescriptor": {
"description": "Indicator of the response. For example: Nonscorable response, Ineffective response, Effective response, Partial response...",
"maxLength": 306,
"type": "string"
},
"assessmentResponse": {
"description": "A student's response to a stimulus on a test.",
"maxLength": 60,
"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.",
"maxLength": 1024,
"type": "string"
},
"rawScoreResult": {
"description": "A meaningful raw score of the performance of an individual on an assessment item.",
"format": "double",
"type": "number"
},
"timeAssessed": {
"description": "The overall time a student actually spent during the AssessmentItem.",
"maxLength": 30,
"type": "string"
},
"assessmentItemReference": {
"$ref": "#/definitions/edFi_assessmentItemReference"
}
},
"required": [
"assessmentItemResultDescriptor", "assessmentItemReference"
],
"type": "object"
},
"edFi_studentAssessmentPerformanceLevel": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the instructor of the class uses to report the performance and achievement. It may be a qualitative method such as individualized teacher comments or a quantitative method such as a letter or numerical grade. In some cases, more than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelDescriptor": {
"description": "A specification of which performance level value describes the student proficiency.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelMet": {
"description": "Optional indicator of whether the performance level was met.",
"type": "boolean"
}
},
"required": [
"assessmentReportingMethodDescriptor", "performanceLevelDescriptor", "performanceLevelMet"
],
"type": "object"
},
"edFi_studentAssessmentScoreResult": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the administrator of the assessment uses to report the performance and achievement of all students. It may be a qualitative method such as performance level descriptors or a quantitative method such as a numerical grade or cut score. More than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"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.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor", "resultDatatypeTypeDescriptor", "result"
],
"type": "object"
},
"edFi_studentAssessmentStudentObjectiveAssessment": {
"properties": {
"objectiveAssessmentReference": {
"$ref": "#/definitions/edFi_objectiveAssessmentReference"
},
"performanceLevels": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentPerformanceLevels. The PerformanceLevel(s) achieved for the ObjectiveAssessment.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentStudentObjectiveAssessmentPerformanceLevel"
},
"type": "array"
},
"scoreResults": {
"description": "An unordered collection of studentAssessmentStudentObjectiveAssessmentScoreResults. A meaningful score or statistical expression of the performance of an individual. The results can be expressed as a number, percentile, range, level, etc.",
"items": {
"$ref": "#/definitions/edFi_studentAssessmentStudentObjectiveAssessmentScoreResult"
},
"type": "array"
}
},
"required": [
"objectiveAssessmentReference", "scoreResults"
],
"type": "object"
},
"edFi_studentAssessmentStudentObjectiveAssessmentPerformanceLevel": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the instructor of the class uses to report the performance and achievement. It may be a qualitative method such as individualized teacher comments or a quantitative method such as a letter or numerical grade. In some cases, more than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelDescriptor": {
"description": "A specification of which performance level value describes the student proficiency.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"performanceLevelMet": {
"description": "Optional indicator of whether the performance level was met.",
"type": "boolean"
}
},
"required": [
"assessmentReportingMethodDescriptor", "performanceLevelDescriptor", "performanceLevelMet"
],
"type": "object"
},
"edFi_studentAssessmentStudentObjectiveAssessmentScoreResult": {
"properties": {
"assessmentReportingMethodDescriptor": {
"description": "The method that the administrator of the assessment uses to report the performance and achievement of all students. It may be a qualitative method such as performance level descriptors or a quantitative method such as a numerical grade or cut score. More than one type of reporting method may be used.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
},
"resultDatatypeTypeDescriptor": {
"description": "The datatype of the result. The results can be expressed as a number, percentile, range, level, etc.",
"maxLength": 306,
"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.",
"maxLength": 35,
"type": "string"
}
},
"required": [
"assessmentReportingMethodDescriptor", "resultDatatypeTypeDescriptor", "result"
],
"type": "object"
},
"edFi_studentReference": {
"properties": {
"studentUniqueId": {
"description": "A unique alphanumeric code assigned to a student.",
"maxLength": 32,
"type": "string"
}
},
"required": [
"studentUniqueId"
],
"type": "object"
}
},
"parameters": {
"offset": {
"description": "Indicates how many items should be skipped before returning results.",
"in": "query",
"name": "offset",
"required": false,
"default": 0,
"format": "int32",
"type": "integer"
},
"limit": {
"description": "Indicates the maximum number of items that should be returned in the results.",
"in": "query",
"name": "limit",
"required": false,
"default": 25,
"format": "int32",
"maxItems": 100,
"minItems": 1,
"type": "integer"
},
"MinChangeVersion": {
"description": "Used in synchronization to set sequence minimum ChangeVersion",
"in": "query",
"name": "minChangeVersion",
"required": false,
"format": "int32",
"type": "integer"
},
"MaxChangeVersion": {
"description": "Used in synchronization to set sequence maximum ChangeVersion",
"in": "query",
"name": "maxChangeVersion",
"required": false,
"format": "int32",
"type": "integer"
},
"If-None-Match": {
"description": "The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.",
"in": "header",
"name": "If-None-Match",
"required": false,
"type": "string"
},
"fields": {
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\").",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
"queryExpression": {
"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]\").",
"in": "query",
"name": "q",
"required": false,
"type": "string"
},
"totalCount": {
"description": "Indicates if the total number of items available should be returned in the 'Total-Count' header of the response. If set to false, 'Total-Count' header will not be provided.",
"in": "query",
"name": "totalCount",
"required": false,
"default": false,
"type": "boolean"
}
},
"responses": {
"Created": {
"description": "The resource was created. An ETag value is available in the ETag header, and the location of the resource is available in the Location header of the response."
},
"Updated": {
"description": "The resource was updated. An updated ETag value is available in the ETag header of the response."
},
"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."
}
},
"securityDefinitions": {
"oauth2_client_credentials": {
"description": "Ed-Fi ODS/API OAuth 2.0 Client Credentials Grant Type authorization",
"flow": "application",
"scopes": {},
"tokenUrl": "http://localhost:54746/oauth/token",
"type": "oauth2"
}
},
"security": [
{
"oauth2_client_credentials": []
}
],
"tags": [
{
"description": "This entity represents one of many single measures that make up an assessment.",
"name": "assessmentItems"
}, {
"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": "assessments"
}, {
"description": "This entity represents identified learning objectives for courses in specific grades.",
"name": "learningObjectives"
}, {
"description": "A statement that describes a specific competency or academic standard.",
"name": "learningStandards"
}, {
"description": "This entity represents subtests that assess specific learning objectives.",
"name": "objectiveAssessments"
}, {
"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": "studentAssessments"
}
]
}