Ed-Fi RFC 19 - Open API Spec
This page contains the full Open API specification.
Change History
- June 12, 2019: Initial Draft
- Ed-Fi-EnrollmentAPIForSuite3-RFC19.json
{
"swagger": "2.0",
"info": {
"version": "rfc19",
"title": "Ed-Fi Enrollment API",
"description": "The RFC describes a set of read-only REST API endpoints for transfer of basic demographic and enrollment data for K–12 students and teachers. The API allows client systems to access the basic data required to provision a broad range of online teaching and learning applications, and to do so using resource models that align with the Ed-Fi Data Standard v3.1."
},
"produces": [
"application/json"
],
"paths": {
"/ed-fi/enrollment/LocalEducationAgencies": {
"get": {
"tags": [
"localEducationAgencies"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getLocalEducationAgencies",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "localEducationAgencyId",
"in": "query",
"description": "The identifier assigned to a local education agency.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/localEducationAgency"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/LocalEducationAgencies/{id}": {
"get": {
"tags": [
"localEducationAgencies"
],
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getLocalEducationAgenciesById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string",
"required": true
}, {
"$ref": "#/parameters/If-None-Match"
}, {
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/localEducationAgency"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Schools": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSchools",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/school"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Schools/{id}": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSchoolsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}, {
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/school"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/localEducationAgencies/{localEducationAgency_id}/schools": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSchoolsByLocalEducationAgency",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/school"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/sections/{section_id}/schools": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSchoolsBySection",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "section_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/school"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/staffs/{staff_id}/schools": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSchoolsByStaff",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "staff_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/school"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/students/{student_id}/schools": {
"get": {
"tags": [
"schools"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSchoolsByStudent",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "student_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/school"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Sections": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSections",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "sectionIdentifier",
"in": "query",
"description": "The local identifier assigned to a section.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 255
}, {
"name": "localCourseCode",
"in": "query",
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "schoolYear",
"in": "query",
"description": "The identifier for the school year.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "sessionName",
"in": "query",
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/section"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Sections/{id}": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSectionsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string",
"required": true
}, {
"$ref": "#/parameters/If-None-Match"
}, {
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/section"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/localEducationAgencies/{localEducationAgency_id}/sections": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSectionsByLocalEducationAgency",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "sectionIdentifier",
"in": "query",
"description": "The local identifier assigned to a section.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 255
}, {
"name": "localCourseCode",
"in": "query",
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "schoolYear",
"in": "query",
"description": "The identifier for the school year.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "sessionName",
"in": "query",
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/section"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/schools/{school_id}/sections": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSectionsBySchool",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "sectionIdentifier",
"in": "query",
"description": "The local identifier assigned to a section.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 255
}, {
"name": "localCourseCode",
"in": "query",
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "schoolYear",
"in": "query",
"description": "The identifier for the school year.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "sessionName",
"in": "query",
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "school_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/section"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/staffs/{staff_id}/sections": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSectionsByStaff",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "sectionIdentifier",
"in": "query",
"description": "The local identifier assigned to a section.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 255
}, {
"name": "localCourseCode",
"in": "query",
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "schoolYear",
"in": "query",
"description": "The identifier for the school year.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "sessionName",
"in": "query",
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "staff_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/section"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/students/{student_id}/sections": {
"get": {
"tags": [
"sections"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getSectionsByStudent",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "sectionIdentifier",
"in": "query",
"description": "The local identifier assigned to a section.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 255
}, {
"name": "localCourseCode",
"in": "query",
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "schoolId",
"in": "query",
"description": "The identifier assigned to a school.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "schoolYear",
"in": "query",
"description": "The identifier for the school year.",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "integer",
"format": "int32"
}, {
"name": "sessionName",
"in": "query",
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"required": false,
"x-Ed-Fi-isIdentity": true,
"type": "string",
"maxLength": 60
}, {
"name": "student_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/section"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Staffs": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStaffs",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staff"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Staffs/{id}": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getStaffsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}, {
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/staff"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/localEducationAgencies/{localEducationAgency_id}/staffs": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStaffsByLocalEducationAgency",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staff"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/schools/{school_id}/staffs": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStaffsBySchool",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "school_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staff"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/sections/{section_id}/staffs": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStaffsBySection",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "section_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staff"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/students/{student_id}/staffs": {
"get": {
"tags": [
"staffs"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStaffsByStudent",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "student_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staff"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Students": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudents",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/student"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/Students/{id}": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getStudentsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "A resource identifier that uniquely identifies the resource.",
"required": true,
"type": "string"
}, {
"$ref": "#/parameters/If-None-Match"
}, {
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/student"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/localEducationAgencies/{localEducationAgency_id}/students": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudentsByLocalEducationAgency",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "localEducationAgency_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/student"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/schools/{school_id}/students": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudentsBySchool",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "school_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/student"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/sections/{section_id}/students": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudentsBySection",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "section_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/student"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
},
"/ed-fi/enrollment/staffs/{staff_id}/students": {
"get": {
"tags": [
"students"
],
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId": "getStudentsByStaff",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/offset"
}, {
"$ref": "#/parameters/limit"
}, {
"$ref": "#/parameters/fields"
}, {
"$ref": "#/parameters/queryExpression"
}, {
"name": "staff_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/student"
}
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
}
}
}
},
"definitions": {
"localEducationAgency": {
"required": [
"localEducationAgencyId", "id", "nameOfInstitution", "localEducationAgencyCategoryDescriptor", "addresses"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"addresses": {
"description": "An unordered collection of educationOrganizationAddresses. ",
"type": "array",
"items": {
"$ref": "#/definitions/localEducationAgency_educationOrganizationAddress"
}
},
"localEducationAgencyId": {
"description": "The identifier assigned to a local education agency.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"charterStatusDescriptor": {
"description": "A school or agency providing free public elementary or secondary education to eligible students under a specific charter granted by the state legislature or other appropriate authority and designated by such authority to be a charter school.",
"type": "string",
"maxLength": 306
},
"identificationCodes": {
"description": "An unordered collection of educationOrganizationIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/localEducationAgency_educationOrganizationIdentificationCode"
}
},
"institutionTelephones": {
"description": "An unordered collection of educationOrganizationInstitutionTelephones. ",
"type": "array",
"items": {
"$ref": "#/definitions/localEducationAgency_educationOrganizationInstitutionTelephone"
}
},
"localEducationAgencyCategoryDescriptor": {
"description": "The category of local education agency/district. For example: Independent or Charter.",
"type": "string",
"maxLength": 306
},
"nameOfInstitution": {
"description": "The full, legally accepted name of the institution.",
"type": "string",
"maxLength": 75
},
"shortNameOfInstitution": {
"description": "A short name for the institution.",
"type": "string",
"maxLength": 75
},
"stateEducationAgencyId": {
"description": "The identifier assigned to a state education agency.",
"type": "integer",
"format": "int32"
},
"webSite": {
"description": "The public web site address (URL) for the EducationOrganization.",
"type": "string",
"maxLength": 255
}
}
},
"localEducationAgency_educationOrganizationAddress": {
"required": [
"addressTypeDescriptor", "streetNumberName", "city", "stateAbbreviationDescriptor", "postalCode"
],
"type": "object",
"properties": {
"addressTypeDescriptor": {
"description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"streetNumberName": {
"description": "The street number and street name or post office box number of an address.",
"type": "string",
"maxLength": 150
},
"city": {
"description": "The name of the city in which an address is located.",
"type": "string",
"maxLength": 30
},
"stateAbbreviationDescriptor": {
"description": "The abbreviation for the state (within the United States) or outlying area in which an address is located.",
"type": "string",
"maxLength": 306
},
"postalCode": {
"description": "The five or nine digit zip code or overseas postal code portion of an address.",
"type": "string",
"maxLength": 17
},
"nameOfCounty": {
"description": "The name of the county, parish, borough, or comparable unit (within a state) in which an address is located.",
"type": "string",
"maxLength": 30
}
}
},
"localEducationAgency_educationOrganizationIdentificationCode": {
"required": [
"educationOrganizationIdentificationSystemDescriptor", "identificationCode"
],
"type": "object",
"properties": {
"educationOrganizationIdentificationSystemDescriptor": {
"description": "The school system, state, or agency assigning the identification code.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"identificationCode": {
"description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.",
"type": "string",
"maxLength": 60
}
}
},
"localEducationAgency_educationOrganizationInstitutionTelephone": {
"required": [
"institutionTelephoneNumberTypeDescriptor", "telephoneNumber"
],
"type": "object",
"properties": {
"institutionTelephoneNumberTypeDescriptor": {
"description": "The type of communication number listed for an individual or organization.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"telephoneNumber": {
"description": "The telephone number including the area code, and extension, if applicable.",
"type": "string",
"maxLength": 24
}
}
},
"school": {
"required": [
"schoolId", "id", "nameOfInstitution", "addresses", "educationOrganizationCategories", "gradeLevels"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"addresses": {
"description": "An unordered collection of educationOrganizationAddresses. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_educationOrganizationAddress"
}
},
"educationOrganizationCategories": {
"description": "An unordered collection of educationOrganizationCategories. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_educationOrganizationCategory"
}
},
"gradeLevels": {
"description": "An unordered collection of schoolGradeLevels. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_schoolGradeLevel"
}
},
"schoolId": {
"description": "The identifier assigned to a school.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"identificationCodes": {
"description": "An unordered collection of educationOrganizationIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_educationOrganizationIdentificationCode"
}
},
"institutionTelephones": {
"description": "An unordered collection of educationOrganizationInstitutionTelephones. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_educationOrganizationInstitutionTelephone"
}
},
"localEducationAgency": {
"$ref": "#/definitions/school_localEducationAgency"
},
"nameOfInstitution": {
"description": "The full, legally accepted name of the institution.",
"type": "string",
"maxLength": 75
},
"schoolCategories": {
"description": "An unordered collection of schoolCategories. ",
"type": "array",
"items": {
"$ref": "#/definitions/school_schoolCategory"
}
},
"schoolTypeDescriptor": {
"description": "The type of education institution as classified by its primary focus.",
"type": "string",
"maxLength": 306
},
"shortNameOfInstitution": {
"description": "A short name for the institution.",
"type": "string",
"maxLength": 75
},
"webSite": {
"description": "The public web site address (URL) for the EducationOrganization.",
"type": "string",
"maxLength": 255
}
}
},
"school_educationOrganizationAddress": {
"required": [
"addressTypeDescriptor", "streetNumberName", "city", "stateAbbreviationDescriptor", "postalCode"
],
"type": "object",
"properties": {
"addressTypeDescriptor": {
"description": "The type of address listed for an individual or organization. For example: Physical Address, Mailing Address, Home Address, etc.)",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"streetNumberName": {
"description": "The street number and street name or post office box number of an address.",
"type": "string",
"maxLength": 150
},
"city": {
"description": "The name of the city in which an address is located.",
"type": "string",
"maxLength": 30
},
"stateAbbreviationDescriptor": {
"description": "The abbreviation for the state (within the United States) or outlying area in which an address is located.",
"type": "string",
"maxLength": 306
},
"postalCode": {
"description": "The five or nine digit zip code or overseas postal code portion of an address.",
"type": "string",
"maxLength": 17
},
"nameOfCounty": {
"description": "The name of the county, parish, borough, or comparable unit (within a state) in which an address is located.",
"type": "string",
"maxLength": 30
}
}
},
"school_educationOrganizationCategory": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"description": "The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control granted by the state.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"school_educationOrganizationIdentificationCode": {
"required": [
"educationOrganizationIdentificationSystemDescriptor", "identificationCode"
],
"type": "object",
"properties": {
"educationOrganizationIdentificationSystemDescriptor": {
"description": "The school system, state, or agency assigning the identification code.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"identificationCode": {
"description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.",
"type": "string",
"maxLength": 60
}
}
},
"school_educationOrganizationInstitutionTelephone": {
"required": [
"institutionTelephoneNumberTypeDescriptor", "telephoneNumber"
],
"type": "object",
"properties": {
"institutionTelephoneNumberTypeDescriptor": {
"description": "The type of communication number listed for an individual or organization.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"telephoneNumber": {
"description": "The telephone number including the area code, and extension, if applicable.",
"type": "string",
"maxLength": 24
}
}
},
"school_localEducationAgency": {
"required": [
"id", "localEducationAgencyId"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"localEducationAgencyId": {
"description": "The identifier assigned to a local education agency.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
}
}
},
"school_schoolCategory": {
"required": [
"category"
],
"type": "object",
"properties": {
"category": {
"description": "The one or more categories of school. For example: High School, Middle School, and/or Elementary School.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"school_schoolGradeLevel": {
"required": [
"gradeLevelDescriptor"
],
"type": "object",
"properties": {
"gradeLevelDescriptor": {
"description": "The grade levels served at the school.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"section": {
"required": [
"sectionIdentifier", "localCourseCode", "id"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"localCourseCode": {
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60
},
"sectionIdentifier": {
"description": "The local identifier assigned to a section.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255
},
"academicSubjectDescriptor": {
"description": "The intended major subject area of the course.",
"type": "string",
"maxLength": 306
},
"availableCredits": {
"description": "The value of credits or units of value awarded for the completion of a course.",
"type": "number",
"format": "double"
},
"classPeriods": {
"description": "An unordered collection of sectionClassPeriods. ",
"type": "array",
"items": {
"$ref": "#/definitions/section_sectionClassPeriod"
}
},
"educationalEnvironmentDescriptor": {
"description": "The setting in which a child receives education and related services; for example: Center-based instruction, Home-based instruction, Hospital class, Mainstream, Residential care and treatment facility...",
"type": "string",
"maxLength": 306
},
"localCourseTitle": {
"description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.",
"type": "string",
"maxLength": 60
},
"location": {
"$ref": "#/definitions/section_location"
},
"sequenceOfCourse": {
"description": "When a section is part of a sequence of parts for a course, the number of the sequence. If the course has only one part, the value of this section attribute should be 1.",
"type": "integer",
"format": "int32"
},
"session": {
"$ref": "#/definitions/section_session"
},
"staff": {
"description": "An unordered collection of staffSectionAssociations. ",
"type": "array",
"items": {
"$ref": "#/definitions/section_staffSectionAssociation"
}
},
"students": {
"description": "An unordered collection of studentSectionAssociations. ",
"type": "array",
"items": {
"$ref": "#/definitions/section_studentSectionAssociation"
}
}
}
},
"section_location": {
"required": [
"id", "schoolId", "classroomIdentificationCode"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"schoolId": {
"description": "The identifier assigned to a school.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"classroomIdentificationCode": {
"description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60
}
}
},
"section_sectionClassPeriod": {
"required": [
"classPeriodName"
],
"type": "object",
"properties": {
"classPeriodName": {
"description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60
}
}
},
"section_session": {
"required": [
"id", "schoolId", "schoolYear", "termDescriptor", "sessionName", "beginDate", "endDate", "totalInstructionalDays"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"schoolId": {
"description": "The identifier assigned to a school.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"schoolYear": {
"description": "The identifier for the school year.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"termDescriptor": {
"description": "An descriptor value indicating the term (e.g. 'Fall Semester', 'Second Quarter', 'Summer Semester', etc.).",
"type": "string",
"maxLength": 306
},
"sessionName": {
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 60
},
"beginDate": {
"description": "Month, day, and year of the first day of the Session.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "Month, day and year of the last day of the Session.",
"type": "string",
"format": "date"
},
"totalInstructionalDays": {
"description": "The total number of instructional days in the school calendar.",
"type": "integer",
"format": "int32"
}
}
},
"section_staffSectionAssociation": {
"required": [
"id", "staffUniqueId"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"staffUniqueId": {
"description": "A unique alphanumeric code assigned to a staff.",
"type": "string",
"maxLength": 32
}
}
},
"section_studentSectionAssociation": {
"required": [
"enrollmentBeginDate", "id", "studentUniqueId"
],
"type": "object",
"properties": {
"enrollmentBeginDate": {
"description": "Month, day, and year of the Student's entry or assignment to the Section.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"format": "date"
},
"enrollmentEndDate": {
"description": "Month, day, and year of the withdrawal or exit of the Student from the Section.",
"type": "string",
"format": "date"
},
"id": {
"description": "",
"type": "string"
},
"studentUniqueId": {
"description": "A unique alphanumeric code assigned to a student.",
"type": "string",
"maxLength": 32
}
}
},
"staff": {
"required": [
"id", "staffUniqueId", "firstName", "lastSurname"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"educationOrganizationAssignments": {
"description": "An unordered collection of staffEducationOrganizationAssignmentAssociations. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffEducationOrganizationAssignmentAssociation"
}
},
"electronicMails": {
"description": "An unordered collection of staffElectronicMails. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffElectronicMail"
}
},
"firstName": {
"description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.",
"type": "string",
"maxLength": 75
},
"hispanicLatinoEthnicity": {
"description": "An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, \"Spanish origin,\" can be used in addition to \"Hispanic or Latino.\"",
"type": "boolean"
},
"identificationCodes": {
"description": "An unordered collection of staffIdentificationCodes. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffIdentificationCode"
}
},
"languages": {
"description": "An unordered collection of staffLanguages. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffLanguage"
}
},
"lastSurname": {
"description": "The name borne in common by members of a family.",
"type": "string",
"maxLength": 75
},
"loginId": {
"description": "The login ID for the user; used for security access control interface.",
"type": "string",
"maxLength": 60
},
"personalTitlePrefix": {
"description": "A prefix used to denote the title, degree, position, or seniority of the person.",
"type": "string",
"maxLength": 30
},
"races": {
"description": "An unordered collection of staffRaces. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffRace"
}
},
"sexDescriptor": {
"description": "A person's gender.",
"type": "string",
"maxLength": 306
},
"staffUniqueId": {
"description": "A unique alphanumeric code assigned to a staff.",
"type": "string",
"maxLength": 32
},
"telephones": {
"description": "An unordered collection of staffTelephones. ",
"type": "array",
"items": {
"$ref": "#/definitions/staff_staffTelephone"
}
}
}
},
"staff_staffEducationOrganizationAssignmentAssociation": {
"required": [
"staffClassificationDescriptor", "educationOrganizationId"
],
"type": "object",
"properties": {
"staffClassificationDescriptor": {
"description": "The titles of employment, official status, or rank of education staff.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"educationOrganizationType": {
"type": "string",
"maxLength": 128
},
"educationOrganizationId": {
"description": "The identifier assigned to an education organization.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
}
}
},
"staff_staffElectronicMail": {
"required": [
"electronicMailTypeDescriptor", "electronicMailAddress"
],
"type": "object",
"properties": {
"electronicMailTypeDescriptor": {
"description": "The type of email listed for an individual or organization. For example: Home/Personal, Work, etc.)",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"electronicMailAddress": {
"description": "The electronic mail (e-mail) address listed for an individual or organization.",
"type": "string",
"maxLength": 128
}
}
},
"staff_staffIdentificationCode": {
"required": [
"staffIdentificationSystemDescriptor", "identificationCode"
],
"type": "object",
"properties": {
"staffIdentificationSystemDescriptor": {
"description": "A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a staff member.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"identificationCode": {
"description": "A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity.",
"type": "string",
"maxLength": 60
}
}
},
"staff_staffLanguage": {
"required": [
"languageDescriptor"
],
"type": "object",
"properties": {
"languageDescriptor": {
"description": "A specification of which written or spoken communication is being used.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"staff_staffRace": {
"required": [
"raceDescriptor"
],
"type": "object",
"properties": {
"raceDescriptor": {
"description": "The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The way this data element is listed, it must allow for multiple entries so that each individual can specify all appropriate races.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"staff_staffTelephone": {
"required": [
"telephoneNumberTypeDescriptor", "telephoneNumber"
],
"type": "object",
"properties": {
"telephoneNumberTypeDescriptor": {
"description": "The type of communication number listed for an individual or organization.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
},
"orderOfPriority": {
"description": "The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.",
"type": "integer",
"format": "int32"
},
"telephoneNumber": {
"description": "The telephone number including the area code, and extension, if applicable.",
"type": "string",
"maxLength": 24
}
}
},
"student": {
"required": [
"id", "studentUniqueId", "firstName", "lastSurname", "birthDate"
],
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"birthDate": {
"description": "The month, day, and year on which an individual was born.",
"type": "string",
"format": "date"
},
"firstName": {
"description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.",
"type": "string",
"maxLength": 75
},
"lastSurname": {
"description": "The name borne in common by members of a family.",
"type": "string",
"maxLength": 75
},
"middleName": {
"description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.",
"type": "string",
"maxLength": 75
},
"personalTitlePrefix": {
"description": "A prefix used to denote the title, degree, position, or seniority of the person.",
"type": "string",
"maxLength": 30
},
"studentDemographics": {
"description": "An unordered collection of studentEducationOrganizationAssociations. ",
"type": "array",
"items": {
"$ref": "#/definitions/student_studentEducationOrganizationAssociation"
}
},
"studentSchoolEnrollments": {
"description": "An unordered collection of studentSchoolAssociations. ",
"type": "array",
"items": {
"$ref": "#/definitions/student_studentSchoolAssociation"
}
},
"studentUniqueId": {
"description": "A unique alphanumeric code assigned to a student.",
"type": "string",
"maxLength": 32
}
}
},
"student_studentEducationOrganizationAssociation": {
"required": [
"sexDescriptor", "educationOrganizationId"
],
"type": "object",
"properties": {
"loginId": {
"description": "The login ID for the user; used for security access control interface.",
"type": "string",
"maxLength": 60
},
"sexDescriptor": {
"description": "A person's gender.",
"type": "string",
"maxLength": 306
},
"hispanicLatinoEthnicity": {
"description": "An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, \"Spanish origin,\" can be used in addition to \"Hispanic or Latino.\"",
"type": "boolean"
},
"educationOrganizationType": {
"maxLength": 128,
"type": "string"
},
"educationOrganizationId": {
"description": "The identifier assigned to an education organization.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"languages": {
"description": "An unordered collection of studentEducationOrganizationAssociationLanguages. ",
"type": "array",
"items": {
"$ref": "#/definitions/student_studentEducationOrganizationAssociation_studentEducationOrganizationAssociationLanguage"
}
},
"races": {
"description": "An unordered collection of studentEducationOrganizationAssociationRaces. ",
"type": "array",
"items": {
"$ref": "#/definitions/student_studentEducationOrganizationAssociation_studentEducationOrganizationAssociationRace"
}
}
}
},
"student_studentEducationOrganizationAssociation_studentEducationOrganizationAssociationLanguage": {
"required": [
"languageDescriptor"
],
"type": "object",
"properties": {
"languageDescriptor": {
"description": "A specification of which written or spoken communication is being used.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"student_studentEducationOrganizationAssociation_studentEducationOrganizationAssociationRace": {
"required": [
"raceDescriptor"
],
"type": "object",
"properties": {
"raceDescriptor": {
"description": "The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The data model allows for multiple entries so that each individual can specify all appropriate races.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306
}
}
},
"student_studentSchoolAssociation": {
"required": [
"entryGradeLevelDescriptor", "enrollmentBeginDate", "id", "schoolId", "nameOfInstitution"
],
"type": "object",
"properties": {
"entryGradeLevelDescriptor": {
"description": "The grade level or primary instructional level at which a student enters and receives services in a school or an educational institution during a given academic session.",
"type": "string",
"maxLength": 306
},
"enrollmentBeginDate": {
"description": "The month, day, and year on which an individual enters and begins to receive instructional services in a school.",
"type": "string",
"x-Ed-Fi-isIdentity": true,
"format": "date"
},
"enrollmentEndDate": {
"description": "The month, day, and year of the first day after the date of an individual's last attendance at a school (if known), the day on which an individual graduated, or the date on which it becomes known officially that an individual left school.",
"type": "string",
"format": "date"
},
"id": {
"description": "",
"type": "string"
},
"schoolId": {
"description": "The identifier assigned to a school.",
"type": "integer",
"x-Ed-Fi-isIdentity": true,
"format": "int32"
},
"nameOfInstitution": {
"description": "The full, legally accepted name of the institution.",
"type": "string",
"maxLength": 75
}
}
}
},
"parameters": {
"offset": {
"name": "offset",
"in": "query",
"description": "Indicates how many items should be skipped before returning results.",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
"limit": {
"name": "limit",
"in": "query",
"description": "Indicates the maximum number of items that should be returned in the results.",
"required": false,
"type": "integer",
"default": 25,
"format": "int32",
"minItems": 1,
"maxItems": 100
},
"MinChangeVersion": {
"name": "minChangeVersion",
"description": "Used in synchronization to set sequence minimum ChangeVersion",
"in": "query",
"required": false,
"format": "int32",
"type": "integer"
},
"MaxChangeVersion": {
"name": "maxChangeVersion",
"in": "query",
"description": "Used in synchronization to set sequence maximum ChangeVersion",
"required": false,
"type": "integer",
"format": "int32"
},
"If-None-Match": {
"name": "If-None-Match",
"in": "header",
"description": "The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.",
"type": "string",
"required": false
},
"fields": {
"name": "fields",
"in": "query",
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\").",
"required": false,
"type": "string"
},
"queryExpression": {
"name": "q",
"in": "query",
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"[2016-03-07..2016-03-10]\").",
"required": false,
"type": "string"
}
},
"responses": {
"Created": {
"description": "The resource was created. 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."
}
},
"security": [
{
"oauth2_client_credentials": []
}
],
"securityDefinitions": {
"oauth2_client_credentials": {
"type": "oauth2",
"description": "Ed-Fi ODS/API OAuth 2.0 Client Credentials Grant Type authorization",
"flow": "application",
"tokenUrl": "https://api-stage.ed-fi.org/v3.2.0/api/oauth/token",
"scopes": {}
}
},
"tags": [
{
"name": "localEducationAgencies"
}, {
"name": "schools"
}, {
"name": "sections"
}, {
"name": "staffs"
}, {
"name": "students"
}
]
}